Skip to main content

%Api.InteropEditors.v3.impl

class %Api.InteropEditors.v3.impl extends %Api.InteropEditors.v2.impl

Interoperability Editor API for InterSystems IRIS
Business logic class defined by OpenAPI in %Api.InteropEditors.v3.spec
Updated Mar 11, 2025 18:37:47

Method Inventory

Parameters

parameter ExposeServerExceptions = 0;
If ExposeServerExceptions is true, then details of internal errors will be exposed.

Methods

classmethod CompileDTL(namespace As %String, dtlClass As %String) as %DynamicObject
Compile this DTL class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
dtlClass, Name of the ObjectScript class in which this DTL is defined.
classmethod CompileRule(namespace As %String, ruleClass As %String) as %DynamicObject
Compile this rule class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
ruleClass, Name of the ObjectScript class in which this rule definition is defined.
classmethod DispatchPlugin(namespace As %String, pluginPath As %String) as %Stream.Object
Dispatch to plugin endpoint.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
pluginPath, Path of the plugin endpoint to hit.
classmethod GetAllConnections(namespace As %String, productionClass As %String) as %DynamicObject
Get a list of all connections for this production
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
classmethod GetAllConnectionsById(namespace As %String, productionClass As %String, hostID As %String, hostName As %String) as %DynamicObject
Get a list of connections for this production and host id.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
hostID, Id of the host of production
hostName, Host name to get connections for.
classmethod GetBusinessClassList(namespace As %String, classNameType As %String) as %DynamicObject
Get a list of business classes by type
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classNameType, Business classname type.
classmethod GetBusinessPartners(namespace As %String) as %DynamicObject
Get a list of business partners.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetBusinessServices(namespace As %String) as %DynamicObject
Get a list of business services
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetCategories(namespace As %String, productionClass As %String) as %DynamicObject
Get a list of user-defined categories for this production.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
classmethod GetClassPackages(namespace As %String) as %DynamicObject
Get a list of all class packages in the hierarchy
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetClassSummaries(namespace As %String) as %DynamicObject
Get summaries of non-hidden classes in this namespace.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetConnectionsById(namespace As %String, productionClass As %String, ByRef hostID As %String) as %DynamicObject
Get a list of connections for this production and host id.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
hostID, Id of the host of production
classmethod GetConstraintOptions(namespace As %String, assistClass As %String, constraints As %DynamicArray) as %DynamicObject
Get a list of constraint options for this rule type.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
assistClass, Rule type, in the form of an assist class.
constraints, Constraints to get options for.
classmethod GetContextInputs(namespace As %String, contextClass As %String) as %DynamicObject
Get information on this context class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
contextClass, Name of the ObjectScript class used as a context class for a rule.
classmethod GetContextTypes(namespace As %String, contextClass As %String) as %DynamicObject
Get list of context types
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
contextClass, Name of the ObjectScript class used as a context class for a rule.
classmethod GetDTL(namespace As %String, dtlClass As %String) as %DynamicObject
Get this DTL class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
dtlClass, Name of the ObjectScript class in which this DTL is defined.
classmethod GetDTLFunctions(namespace As %String) as %DynamicObject
Get the DTL functions
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetDTLSegments(namespace As %String) as %DynamicObject
Get all the segments and fields for source and target classes
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetDTLSourceTargetClasses(namespace As %String) as %DynamicObject
Get a list of all classes that could be used as DTL source/target in the groups Message, Virtual Documents, Persistent, Non-System
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetDTLSubSegments(namespace As %String) as %DynamicObject
Get the sub segments
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetDTLTestInfo(namespace As %String, dtlClass As %String) as %DynamicObject
Get test-related information for this user on this DTL class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
dtlClass, Name of the ObjectScript class in which this DTL is defined.
classmethod GetDocTypes(namespace As %String, assistClassName As %String) as %DynamicObject
Get a list of doctype names and categories for specified assist class
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
assistClassName, Rule type in the form of an assist class name.
classmethod GetDocTypesForClass(namespace As %String, messageClass As %String) as %DynamicObject
Get a list of all the document types that are available for a given message class grouped by version/type
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
messageClass, Name of a message class
classmethod GetExpiry() as %DynamicObject
Get the expiry of the current session
classmethod GetHostSettings(namespace As %String, productionClass As %String, hostType As %String, className As %String, hostName As %String) as %DynamicObject
Get a list of settings for this host includng defaults.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
hostType, Type of host, Service Process Operation
className, Classname of host
hostName, Optional host name.
classmethod GetHostSettingsOptions(namespace As %String, hostName As %String) as %DynamicObject
Get a list of host settings for specific host.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
hostName, Host name.
classmethod GetInputPluginsList(namespace As %String) as %DynamicObject
Get list of input plugins.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetLanguage() as %DynamicObject
Get the language for this session
classmethod GetLookupTables(namespace As %String) as %DynamicObject
Get a list of lookup tables in this namespace.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetMgmtUrl(namespace As %String) as %DynamicObject
Get the 'path' portion of the Interoperability management URL for a given namespace.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetPackages(namespace As %String) as %DynamicObject
Get a list of defined packages.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetPermissions(type As %ListOfDataTypes(ELEMENTTYPE="%String")) as %DynamicObject
Get a list of permissions for the current user and namespaces they can access eg /%SYS/permissions?type=dtl&type=rule
The method arguments hold values for:
type, The kind of permissions (optional) eg dtl, rule
classmethod GetProduction(namespace As %String, productionClass As %String) as %DynamicObject
Get this production class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
classmethod GetProductionConfigItems(namespace As %String, production As %String, targets As %Boolean) as %DynamicObject
Get a list of production configuration items.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
production, Get the configuration items for only this production.
targets, Only get the configuration items of type 'target'.
classmethod GetProductionItems(namespace As %String) as %DynamicObject
Get a list of production items in rule.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetProductionStatus(namespace As %String) as %DynamicObject
Get production status.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetProductions(namespace As %String) as %DynamicObject
Get a list of productions.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetPropertyList(namespace As %String, assistClassName As %String, searchProperties As %DynamicArray) as %DynamicObject
Get the property list for this rule type.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
assistClassName, Rule type in the form of an assist class name.
searchProperties, Search context and key for property list
classmethod GetRule(namespace As %String, ruleClass As %String) as %DynamicObject
Get this rule class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
ruleClass, Name of the ObjectScript class in which this rule definition is defined.
classmethod GetRuleTypeSchema(namespace As %String, assistClassName As %String) as %DynamicObject
Get the schema for this rule type.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
assistClassName, Rule type in the form of an assist class name.
classmethod GetRuleTypes(namespace As %String) as %DynamicObject
Get a list of rule types available on the server.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetRules(namespace As %String) as %DynamicObject
Get a list of rule classes available on the server.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetSettingsOptions(namespace As %String, productionClass As %String) as %DynamicObject
Get a list of settings options.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
classmethod GetSystemMode() as %DynamicObject
Get the system mode of this instance.
classmethod GetTestingInputs(namespace As %String, ruleClass As %String) as %DynamicObject
Get information on this class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
ruleClass, Name of the ObjectScript class in which this rule definition is defined.
classmethod GetTransforms(namespace As %String, mode As %String) as %DynamicObject
Get a list of data transforms.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
mode, The mode of transforms to fetch (optional).Supported value is dtl
classmethod Logout() as %Stream.Object
Terminate CSP Session.
classmethod PostDTL(namespace As %String, dtlClass As %String, DTL As %DynamicObject) as %DynamicObject
Create a new DTL class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
dtlClass, Name of the ObjectScript class in which this DTL is defined.
DTL, JSON object representation of the DTL class.
classmethod PostProduction(namespace As %String, productionClass As %String, productionDefinition As %DynamicObject) as %DynamicObject
Create a new production.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
productionDefinition, Definition which defines the contents of a production class.
classmethod PostRule(namespace As %String, ruleClass As %String, ruleDefinition As %DynamicObject) as %DynamicObject
Create a new rule class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
ruleClass, Name of the ObjectScript class in which this rule definition is defined.
ruleDefinition, Definition which defines the contents of a rule class.
classmethod PutDTL(namespace As %String, dtlClass As %String, DTL As %DynamicObject, ignoreConflict As %Boolean) as %DynamicObject
Overwrite this DTL class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
dtlClass, Name of the ObjectScript class in which this DTL is defined.
DTL, JSON object representation of the DTL class.
ignoreConflict, Overwrite this class if it exists, ignoring conflicts.
classmethod PutProduction(namespace As %String, productionClass As %String, productionDefinition As %DynamicObject, ignoreConflict As %Boolean) as %DynamicObject
Overwrite this production class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
productionDefinition, Definition which defines the contents of a production class.
ignoreConflict, Overwrite this class if it exists, ignoring conflicts.
classmethod PutRule(namespace As %String, ruleClass As %String, ruleDefinition As %DynamicObject, ignoreConflict As %Boolean) as %DynamicObject
Overwrite this rule class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
ruleClass, Name of the ObjectScript class in which this rule definition is defined.
ruleDefinition, Definition which defines the contents of a rule class.
ignoreConflict, Overwrite this class if it exists, ignoring conflicts.
classmethod SaveProductionHost(namespace As %String, productionClass As %String, hostName As %String, itemSettings As %DynamicObject) as %DynamicObject
Create new host for production.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
hostName, New host name
itemSettings, Settings for host or production
classmethod SaveProductionHostSettings(namespace As %String, productionClass As %String, hostID As %String, itemSettings As %DynamicObject) as %DynamicObject
Update settings for host or production.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
hostID, Current Host ID
itemSettings, Setting updates for host or production
classmethod SetLanguage(language As %String) as %DynamicObject
Set the language for this session
The method arguments hold values for:
language, Language code to set for this session.
classmethod SourceControlAfterUserAction(namespace As %String, sourceControlRequestBody As %DynamicObject) as %DynamicObject
Requests Source Control After User Action for the given parameters
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
sourceControlRequestBody, The parameters for the requested Source Control function
classmethod SourceControlEnabled(namespace As %String) as %DynamicObject
Returns enabled true or false if Source Control Enabled for the namespace
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod SourceControlGetMenus(namespace As %String, sourceControlRequestBody As %DynamicObject) as %DynamicObject
Returns Source Control Menu for the given parameters
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
sourceControlRequestBody, The parameters for the requested Source Control function
classmethod SourceControlGetStatus(namespace As %String, sourceControlRequestBody As %DynamicObject) as %DynamicObject
Requests Source Control GetStatus for the given parameters
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
sourceControlRequestBody, The parameters for the requested Source Control function
classmethod SourceControlUserAction(namespace As %String, sourceControlRequestBody As %DynamicObject) as %DynamicObject
Requests Source Control User Action for the given parameters
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
sourceControlRequestBody, The parameters for the requested Source Control function
classmethod TestDTL(namespace As %String, dtlClass As %String) as %DynamicObject
Run DTL and return logs
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
dtlClass, Name of the ObjectScript class in which this DTL is defined.
classmethod TestRule(namespace As %String, ruleClass As %String, ruleTestMessage As %DynamicObject) as %DynamicObject
Run rule and return logs
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
ruleClass, Name of the ObjectScript class in which this rule definition is defined.
ruleTestMessage, Defines test parameters for rule class
classmethod UpdateProduction(namespace As %String, productionClass As %String, hostName As %String, action As %String, newHostName As %String) as %DynamicObject
Copy or delete host in production.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
hostName, Host name to copy or delete
action, Copy or delete
newHostName, New host name if copy
classmethod UpdateProductionHostStatus(namespace As %String, productionClass As %String, state As %String, hostID As %String) as %DynamicObject
Update state for production or host.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
state, Start or Stop item
hostID, Host ID

Inherited Members

Inherited Methods

FeedbackOpens in a new tab