%Api.InteropEditors.v8.disp
class %Api.InteropEditors.v8.disp extends %Api.InteropEditors.base.dispParent
Interoperability Editor API for InterSystems IRIS Dispatch class defined by RESTSpec in %Api.InteropEditors.v8.specThis class was generated by : %Api.InteropEditors.v8.spec.cls
Method Inventory
- AddSchema()
- AssignWorkflowTask()
- CancelSearch()
- CancelWorkflowTask()
- CompileBPL()
- CompileDTL()
- CompileRule()
- DeleteBusinessPartner()
- DeleteCodeTableElements()
- DeleteDataStructureElements()
- DeleteDefaultSetting()
- DeleteDocTypeStructureTree()
- DeleteEnterpriseSystem()
- DeleteLookupTable()
- DeleteMessageTypeStructure()
- DeleteSavedMessageSearch()
- DeleteSchedule()
- DeleteSchema()
- DeleteSegmentElements()
- DeleteWorkflowRole()
- DeleteWorkflowRoleUser()
- DeleteWorkflowUser()
- DispatchPlugin()
- ExportLookupTable()
- GenerateDTLExplanation()
- GetAllConnections()
- GetAllConnectionsById()
- GetAutoStart()
- GetAutoStartList()
- GetBPL()
- GetBPLContextDataTypes()
- GetBPLContextMetadata()
- GetBPLContextSuperclasses()
- GetBPLHosts()
- GetBPLMessageClasses()
- GetBPLPreferences()
- GetBPLSegments()
- GetBusinessClassList()
- GetBusinessPartner()
- GetBusinessPartners()
- GetCategories()
- GetClassPackages()
- GetClassSummaries()
- GetCodeTableElements()
- GetComplexTypeStructure()
- GetCompositeStructureElements()
- GetConstraintOptions()
- GetContextInputs()
- GetContextSearchOptions()
- GetContextTypes()
- GetDTL()
- GetDTLFunctions()
- GetDTLSegments()
- GetDTLSourceTargetClasses()
- GetDTLTestInfo()
- GetDataStructureElements()
- GetDefaultDir()
- GetDefaultSetting()
- GetDefaultSettings()
- GetDocTypeStructureTree()
- GetDocTypeValidationStructure()
- GetDocTypes()
- GetDocTypesForClass()
- GetEnterpriseSystem()
- GetExpiry()
- GetFoldersInPath()
- GetGroupStructure()
- GetHostSettings()
- GetHostSettingsOptions()
- GetHostsWithDefaultSetting()
- GetInputPluginsList()
- GetJobs()
- GetLanguage()
- GetLog()
- GetLookupTable()
- GetLookupTables()
- GetMessage()
- GetMessageBankLink()
- GetMessageSourceTargets()
- GetMessageTypeStructure()
- GetMessages()
- GetMgmtUrl()
- GetPackages()
- GetPermissions()
- GetProcesses()
- GetProduction()
- GetProductionConfigItems()
- GetProductionHost()
- GetProductionItems()
- GetProductionStatus()
- GetProductions()
- GetPropertyList()
- GetPurgeDataSettings()
- GetQueue()
- GetRecommendedAutoStartPriority()
- GetRule()
- GetRuleTypeSchema()
- GetRuleTypes()
- GetRules()
- GetSchedule()
- GetSchemaCategories()
- GetSearchResults()
- GetSegmentElements()
- GetSegmentTypes()
- GetSegmentValidationStructure()
- GetSettingsOptions()
- GetSimpleTypeStructure()
- GetSubSegOrdInfo()
- GetSystemMode()
- GetTargetRequestTypes()
- GetTestingInputs()
- GetTrace()
- GetTransforms()
- GetWorkflowRole()
- GetWorkflowRoleUser()
- GetWorkflowTask()
- GetWorkflowUser()
- ImportLookupTables()
- ListEnterpriseSystems()
- ListSchedules()
- ListWorkflowRoleTasks()
- ListWorkflowRoleUsers()
- ListWorkflowRoles()
- ListWorkflowTasks()
- ListWorkflowUserRoles()
- ListWorkflowUserTasks()
- ListWorkflowUsers()
- ListWorkflowWorklist()
- Logout()
- PostBPL()
- PostBPLPreferences()
- PostDTL()
- PostDefaultSetting()
- PostLookupTable()
- PostProduction()
- PostRule()
- PutAutoStart()
- PutBPL()
- PutBusinessPartner()
- PutCodeTableElements()
- PutDTL()
- PutDataStructureElements()
- PutDefaultSetting()
- PutDocTypeStructureTree()
- PutEnterpriseSystem()
- PutHostClass()
- PutLookupTable()
- PutMessageBankLink()
- PutMessageTypeStructure()
- PutPurgeDataSettings()
- PutRule()
- PutSchedule()
- PutSegmentElements()
- PutWorkflowRole()
- PutWorkflowRoleUser()
- PutWorkflowUser()
- ResendMessages()
- ResetProductionItemSettings()
- SaveMessageSearch()
- SaveProductionHost()
- SaveProductionHostSettings()
- SavedSearches()
- SearchHistory()
- SetLanguage()
- SourceControlAfterUserAction()
- SourceControlEnabled()
- SourceControlGetMenus()
- SourceControlGetStatus()
- SourceControlUserAction()
- StartMessageSearch()
- TestDTL()
- TestProductionTarget()
- TestRule()
- UpdateProduction()
- UpdateProductionHostStatus()
- UpdateSavedMessageSearch()
- ValidateExpression()
Parameters
parameter CONVERTINPUTSTREAM = 1;
By default convert the input stream to Unicode
parameter IgnoreWrites = 1;
Ignore any writes done directly by the REST method.
parameter SpecificationClass = %Api.InteropEditors.v8.spec;
The class containing the RESTSpec which generated this class
Methods
Add a schema category.
(%Ens_WorkflowConfig:WRITE) Assign or reassign a workflow task to a user
Modify existing search
(%Ens_WorkflowConfig:WRITE) Cancel a workflow task
Compile this BPL class.
Compile this DTL class.
Compile this rule class.
(%Ens_ProductionConfig:W) Delete a business partner
classmethod DeleteCodeTableElements(pnamespace As %String, pschema As %String, pcategory As %String, ptable As %String) as %Status
(%Ens_EDISchema:WRITE) Delete a code table
classmethod DeleteDataStructureElements(pnamespace As %String, pschema As %String, pcategory As %String, pdata As %String) as %Status
(%Ens_EDISchema:WRITE) Delete a data structure
Delete a system default setting.
classmethod DeleteDocTypeStructureTree(pnamespace As %String, pschema As %String, pcategory As %String, pdocType As %String) as %Status
(%Ens_EDISchema:WRITE) Delete a document structure
(%Ens_MsgBank:W) Delete an enterprise system client connection
Delete this lookup table.
classmethod DeleteMessageTypeStructure(pnamespace As %String, pschema As %String, pcategory As %String, pdocType As %String) as %Status
(%Ens_EDISchema:WRITE) Delete a message type
Delete Saved Message Search
(%Ens_ProductionConfig:W) Delete a schedule
classmethod DeleteSchema(pnamespace As %String, pschema As %String, pcategory As %String) as %Status
Delete a schema category.
classmethod DeleteSegmentElements(pnamespace As %String, pschema As %String, pcategory As %String, psegment As %String) as %Status
(%Ens_EDISchema:WRITE) Delete a segment
(%Ens_WorkflowConfig:W) Delete a workflow role
(%Ens_WorkflowConfig:W) Remove a user's membership in this role
(%Ens_WorkflowConfig:W) Delete a workflow user
Dispatch to plugin endpoint.
Export lookup table on the server
Generate an explanation for a given DTL class
Get a list of all connections for this production
classmethod GetAllConnectionsById(pnamespace As %String, pproductionClass As %String, phostID As %String) as %Status
Get a list of connections for this production and host id.
(%Ens_ProductionConfig:R) View the auto start settings in this namespace
(%Ens_ProductionConfig:R) View the productions set to auto-start across namespaces
Get this BPL class.
Get all the BPL context property data types grouped into local, persistent, system and dataType groups
Get additional metadata on a specific context data type
Get a list of all the BPL context superclasses available in a given namespace
Get all the operations, processes and components of a given production
Get a list of all the message classes available in a given namespace or for a particular host in a production
Get the current user's BPL preferences
Get all the segments and fields for a list of field names
Get a list of business classes by type
(%Ens_ProductionConfig:R) Get a business partner
Get a list of business partners.
Get a list of user-defined categories for this production.
Get a list of all class packages in the hierarchy
Get summaries of non-hidden classes in this namespace.
classmethod GetCodeTableElements(pnamespace As %String, pschema As %String, pcategory As %String, ptable As %String) as %Status
Get elements of given code table in given schema category
classmethod GetComplexTypeStructure(pnamespace As %String, pschema As %String, pcategory As %String, pstructure As %String) as %Status
Get complex types of a structure in given schema category
classmethod GetCompositeStructureElements(pnamespace As %String, pschema As %String, pcategory As %String, pstructure As %String) as %Status
Get elements of given composite data structure in given schema category
Get a list of constraint options for this rule type.
Get information on this context class.
Get a list of all options by context search function
Get list of context types
Get this DTL class.
Get the DTL functions
Get all the segments and fields for source and target classes
Get a list of all classes that could be used as DTL source/target in the groups Message, Virtual Documents, Persistent, Non-System
Get test-related information for this user on this DTL class.
classmethod GetDataStructureElements(pnamespace As %String, pschema As %String, pcategory As %String, pdata As %String) as %Status
Get elements of given data structure in given schema category
Get the user's default directory
Get a specific system default setting by ID.
Get a list of system default settings.
classmethod GetDocTypeStructureTree(pnamespace As %String, pschema As %String, pcategory As %String, pdocType As %String) as %Status
Get structure of a given doc type in given schema category
classmethod GetDocTypeValidationStructure(pnamespace As %String, pschema As %String, pcategory As %String, pdocType As %String) as %Status
Get validation structure of a given doc type in given schema category
Get a list of doctype names and categories for specified assist class
Get a list of all the document types that are available for a given message class grouped by version/type
(%Ens_MsgBank:R) Get an enterprise system client connection
classmethod GetExpiry() as %Status
Get the expiry of the current session
Get files within a given path
classmethod GetGroupStructure(pnamespace As %String, pschema As %String, pcategory As %String, pstructure As %String) as %Status
Get group structures of a structure in given schema category
classmethod GetHostSettings(pnamespace As %String, pproductionClass As %String, phostType As %String, pclassName As %String) as %Status
Get a list of settings for this host includng defaults.
Get a list of host settings for specific host.
classmethod GetHostsWithDefaultSetting(pnamespace As %String, psettingName As %String, pproductionClass As %String) as %Status
Get list of hosts with defaultSetting.
Get list of input plugins.
classmethod GetJobs(pnamespace As %String, pproductionClass As %String, phostName As %String) as %Status
Get jobs for host or production
classmethod GetLanguage() as %Status
Get the language for this session
classmethod GetLog(pnamespace As %String, pproductionClass As %String, phostName As %String) as %Status
Get log for host or production
Get this lookup table.
Get a list of lookup tables in this namespace.
Get Message
(%Ens_MsgBankConfig:R) View the Message Bank Link
Get targets and sources for messages
classmethod GetMessageTypeStructure(pnamespace As %String, pschema As %String, pcategory As %String, pdocType As %String) as %Status
Get message type of a given doc type in given schema category
classmethod GetMessages(pnamespace As %String, pproductionClass As %String, phostName As %String) as %Status
Get messages for host or production
Get the 'path' portion of the Interoperability management URL for a given namespace.
Get a list of defined packages.
classmethod GetPermissions() as %Status
Get a list of permissions for the current user and namespaces they can access eg /%SYS/permissions?type=dtl&type=rule
Get a list of business processes in the namespace
Get this production class.
Get a list of production configuration items.
classmethod GetProductionHost(pnamespace As %String, pproductionClass As %String, phostName As %String) as %Status
Get existing host for production by host name.
Get a list of production items in rule.
Get production status.
Get a list of productions.
Get the property list for this rule type.
(%Ens_PurgeSettings:R) View the current purge data settings
classmethod GetQueue(pnamespace As %String, pproductionClass As %String, phostName As %String) as %Status
Get queue for host or production
(%Ens_ProductionConfig:R) Get the recommended auto-start priority for a production in this namespace
Get this rule class.
Get the schema for this rule type.
Get a list of rule types available on the server.
Get a list of rule classes available on the server.
(%Ens_ProductionConfig:R) Get a schedule
Get a list of categories and their structure names and descriptions for schema.
Get messages for in progress message search.
classmethod GetSegmentElements(pnamespace As %String, pschema As %String, pcategory As %String, psegment As %String) as %Status
Get elements of given segment in given schema category
Get a list of segment names for specified class
classmethod GetSegmentValidationStructure(pnamespace As %String, pschema As %String, pcategory As %String, pdocType As %String, pordinal As %String) as %Status
Get validation structure of a segment at a given ordinal in given doc type in given schema category
Get a list of settings options.
classmethod GetSimpleTypeStructure(pnamespace As %String, pschema As %String, pcategory As %String, pstructure As %String) as %Status
Get simple types of a structure in given schema category
classmethod GetSubSegOrdInfo(pnamespace As %String, pschema As %String, pcategory As %String, pdocType As %String, psubSeg As %String) as %Status
Get the list of ordinals and their respective info of a segment at a given path in doctype tree
classmethod GetSystemMode() as %Status
Get the system mode of this instance.
classmethod GetTargetRequestTypes(pnamespace As %String, pproductionClass As %String, ptarget As %String) as %Status
Get list of request types for production and target.
Get information on this class.
Get trace information for session
Get a list of data transforms.
(%Ens_WorkflowConfig:READ) Get a workflow role
(%Ens_WorkflowConfig:READ) Get a user's membership in this role
(%Ens_MessageContent:U) View the details of a specific workflow task
(%Ens_WorkflowConfig:READ) Get a workflow user
Import lookup tables
(%Ens_MsgBank:READ) View a list of enterprise system client connections
(%Ens_ProductionConfig:READ) View a list of available schedules
(%Ens_WorkflowConfig:READ) View a list of tasks assigned to this role
(%Ens_WorkflowConfig:READ) View a list of users holding this role
(%Ens_WorkflowConfig:READ) View a list of workflow roles
(%Ens_Portal:U) View a list of workflow tasks
(%Ens_WorkflowConfig:READ) View a list of roles held by this user
(%Ens_WorkflowConfig:READ) View a list of tasks assigned to this user
(%Ens_WorkflowConfig:READ) View a list of workflow roles
(%Ens_Portal:U) View the current workflow worklist
classmethod Logout() as %Status
Terminate CSP Session.
Create a new BPL class.
Create/update the current user's BPL preferences
Create a new DTL class.
Create a new system default setting.
Create a new lookup table document.
Create new production class.
Create a new rule class.
(%Ens_ProductionConfig:W) Set the auto start settings in this namespace
Overwrite this BPL class.
(%Ens_ProductionConfig:W) Update/save a business partner
classmethod PutCodeTableElements(pnamespace As %String, pschema As %String, pcategory As %String, ptable As %String) as %Status
(%Ens_EDISchema:WRITE) Create or update the elements of a code table
Overwrite this DTL class.
classmethod PutDataStructureElements(pnamespace As %String, pschema As %String, pcategory As %String, pdata As %String) as %Status
(%Ens_EDISchema:WRITE) Create or update the elements of a data structure
Update a system default setting.
classmethod PutDocTypeStructureTree(pnamespace As %String, pschema As %String, pcategory As %String, pdocType As %String) as %Status
(%Ens_EDISchema:WRITE) Create or update a document structure
(%Ens_MsgBank:W) Update/save an enterprise system client connection
classmethod PutHostClass(pnamespace As %String, pproductionClass As %String, phostName As %String) as %Status
Update class for host in production
Overwrite this lookup table.
(%Ens_MsgBankConfig:W) Set the Message Bank Link
classmethod PutMessageTypeStructure(pnamespace As %String, pschema As %String, pcategory As %String, pdocType As %String) as %Status
(%Ens_EDISchema:WRITE) Create or update a message type
(%Ens_PurgeSettings:W) Update the purge data settings
Overwrite this rule class.
(%Ens_ProductionConfig:W) Update/save a schedule
classmethod PutSegmentElements(pnamespace As %String, pschema As %String, pcategory As %String, psegment As %String) as %Status
(%Ens_EDISchema:WRITE) Create or update the elements of a segment
(%Ens_WorkflowConfig:WRITE) Update/save a workflow role
(%Ens_WorkflowConfig:W) Update/save a user's membership in this role
(%Ens_WorkflowConfig:W) Update/save a workflow user
Resend one or more messages
classmethod ResetProductionItemSettings(pnamespace As %String, pproductionClass As %String, phostID As %String) as %Status
Reset default settings
Save Message Search
classmethod SaveProductionHost(pnamespace As %String, pproductionClass As %String, phostName As %String) as %Status
Create new host for production.
classmethod SaveProductionHostSettings(pnamespace As %String, pproductionClass As %String, phostID As %String) as %Status
Update settings for host or production.
Get saved searches for user
Get search history for user
Set the language for this session
Requests Source Control After User Action for the given parameters
Returns enabled true or false if Source Control Enabled for the namespace
Returns Source Control Menu for the given parameters
Requests Source Control GetStatus for the given parameters
Requests Source Control User Action for the given parameters
Initiate message search.
Run DTL and return logs
classmethod TestProductionTarget(pnamespace As %String, pproductionClass As %String, ptarget As %String) as %Status
Run test for production target and return logs
Run rule and return logs
classmethod UpdateProduction(pnamespace As %String, pproductionClass As %String, phostName As %String, paction As %String) as %Status
Copy or delete host in production.
classmethod UpdateProductionHostStatus(pnamespace As %String, pproductionClass As %String) as %Status
Update state for production or host.
Update Saved Message Search
Validate the code block for supported languages (ObjectScript, Python)
Inherited Members
Inherited Methods
- %ClassIsLatestVersion()
- %ClassName()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %New()
- %OriginalNamespace()
- %PackageName()
- %SetModified()
- AcceptsContentType()
- ConvertParameter()
- Decrypt()
- DrawCSS3STYLE()
- DrawHEAD()
- DrawSTHEAD()
- DrawSTTitle()
- DrawSTYLE()
- DrawTitle()
- DrawTitleSection()
- Encrypt()
- Error()
- EscapeHTML()
- EscapeURL()
- GetAuthChallenge()
- Http403()
- Http404()
- Http405()
- Http500()
- HyperEventCall()
- HyperEventHead()
- Include()
- InsertHiddenField()
- InsertHiddenFields()
- IsPrivate()
- Link()
- Login()
- OnErrorSetup()
- OnHTTPHeader()
- OnHandleCorsRequest()
- OnHandleOptionsRequest()
- OnLoginPage()
- OnPage()
- OnPageError()
- OnPostDispatch()
- OnPostHTTP()
- OnPostHyperEvent()
- OnPreHTTP()
- OnPreHyperEvent()
- OnSecurityTokenPage()
- QuoteJS()
- ReportHttpStatusCode()
- RewriteURL()
- SetResponseHeaderIfEmpty()
- ShowError()
- StartTimer()
- StatusToJSON()
- StatusToProxyObject()
- StopTimer()
- SupportedVerbs()
- ThrowError()
- UnescapeHTML()
- UnescapeURL()