class %Api.InteropEditors.v1.impl
extends %REST.Impl
Interoperability Editor API for InterSystems IRIS
Business logic class defined by OpenAPI in %Api.InteropEditors.v1.spec
Updated Oct 3, 2024 14:57:32
• parameter ExposeServerExceptions = 0;
If ExposeServerExceptions is true, then details of internal errors will be exposed.
• classmethod %ReportRESTError(statusCode As %String, sc As %Status = 1, exposeServerExceptions As %Boolean = 0, externalError As %Status)
as %DynamicObject
Overwrite %ReportRESTError for customized external error messages
• 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 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 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 GetDocTypes(namespace As %String)
as %DynamicObject
Get a list of doctype names and categories for HL7 rule testing
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
• classmethod GetExpiry()
as %DynamicObject
Get the expiry of the current session
• 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()
as %DynamicObject
Get a list of permissions for the current user and namespaces they can access.
• 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 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 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 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)
as %DynamicObject
Get a list of data transforms.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
• classmethod Logout()
as %Stream.Object
Terminate CSP Session.
• 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 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 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 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
