Skip to main content

%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.spec

This class was generated by : %Api.InteropEditors.v8.spec.cls

Method Inventory

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

classmethod AddSchema(pnamespace As %String, pschema As %String, pnewName As %String) as %Status
Add a schema category.
classmethod AssignWorkflowTask(pnamespace As %String, ptaskId As %String) as %Status
(%Ens_WorkflowConfig:WRITE) Assign or reassign a workflow task to a user
classmethod CancelSearch(pnamespace As %String) as %Status
Modify existing search
classmethod CancelWorkflowTask(pnamespace As %String, ptaskId As %String) as %Status
(%Ens_WorkflowConfig:WRITE) Cancel a workflow task
classmethod CompileBPL(pnamespace As %String, pbplClass As %String) as %Status
Compile this BPL class.
classmethod CompileDTL(pnamespace As %String, pdtlClass As %String) as %Status
Compile this DTL class.
classmethod CompileRule(pnamespace As %String, pruleClass As %String) as %Status
Compile this rule class.
classmethod DeleteBusinessPartner(pnamespace As %String) as %Status
(%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
classmethod DeleteDefaultSetting(pnamespace As %String, pid As %String) as %Status
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
classmethod DeleteEnterpriseSystem(pnamespace As %String) as %Status
(%Ens_MsgBank:W) Delete an enterprise system client connection
classmethod DeleteLookupTable(pnamespace As %String, plookupTableName As %String) as %Status
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
classmethod DeleteSavedMessageSearch(pnamespace As %String, psearchName As %String) as %Status
Delete Saved Message Search
classmethod DeleteSchedule(pnamespace As %String) as %Status
(%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
classmethod DeleteWorkflowRole(pnamespace As %String) as %Status
(%Ens_WorkflowConfig:W) Delete a workflow role
classmethod DeleteWorkflowRoleUser(pnamespace As %String) as %Status
(%Ens_WorkflowConfig:W) Remove a user's membership in this role
classmethod DeleteWorkflowUser(pnamespace As %String) as %Status
(%Ens_WorkflowConfig:W) Delete a workflow user
classmethod DispatchPlugin(pnamespace As %String, ppluginPath As %String) as %Status
Dispatch to plugin endpoint.
classmethod ExportLookupTable(pnamespace As %String) as %Status
Export lookup table on the server
classmethod GenerateDTLExplanation(pnamespace As %String, pdtlClass As %String) as %Status
Generate an explanation for a given DTL class
classmethod GetAllConnections(pnamespace As %String, pproductionClass As %String) as %Status
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.
classmethod GetAutoStart(pnamespace As %String) as %Status
(%Ens_ProductionConfig:R) View the auto start settings in this namespace
classmethod GetAutoStartList(pnamespace As %String) as %Status
(%Ens_ProductionConfig:R) View the productions set to auto-start across namespaces
classmethod GetBPL(pnamespace As %String, pbplClass As %String) as %Status
Get this BPL class.
classmethod GetBPLContextDataTypes(pnamespace As %String) as %Status
Get all the BPL context property data types grouped into local, persistent, system and dataType groups
classmethod GetBPLContextMetadata(pnamespace As %String) as %Status
Get additional metadata on a specific context data type
classmethod GetBPLContextSuperclasses(pnamespace As %String) as %Status
Get a list of all the BPL context superclasses available in a given namespace
classmethod GetBPLHosts(pnamespace As %String, pproductionClass As %String) as %Status
Get all the operations, processes and components of a given production
classmethod GetBPLMessageClasses(pnamespace As %String) as %Status
Get a list of all the message classes available in a given namespace or for a particular host in a production
classmethod GetBPLPreferences(pnamespace As %String) as %Status
Get the current user's BPL preferences
classmethod GetBPLSegments(pnamespace As %String) as %Status
Get all the segments and fields for a list of field names
classmethod GetBusinessClassList(pnamespace As %String, pclassNameType As %String) as %Status
Get a list of business classes by type
classmethod GetBusinessPartner(pnamespace As %String) as %Status
(%Ens_ProductionConfig:R) Get a business partner
classmethod GetBusinessPartners(pnamespace As %String) as %Status
Get a list of business partners.
classmethod GetCategories(pnamespace As %String, pproductionClass As %String) as %Status
Get a list of user-defined categories for this production.
classmethod GetClassPackages(pnamespace As %String) as %Status
Get a list of all class packages in the hierarchy
classmethod GetClassSummaries(pnamespace As %String) as %Status
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
classmethod GetConstraintOptions(pnamespace As %String, passistClass As %String) as %Status
Get a list of constraint options for this rule type.
classmethod GetContextInputs(pnamespace As %String, pcontextClass As %String) as %Status
Get information on this context class.
classmethod GetContextSearchOptions(pnamespace As %String, poption As %String) as %Status
Get a list of all options by context search function
classmethod GetContextTypes(pnamespace As %String, pcontextClass As %String) as %Status
Get list of context types
classmethod GetDTL(pnamespace As %String, pdtlClass As %String) as %Status
Get this DTL class.
classmethod GetDTLFunctions(pnamespace As %String) as %Status
Get the DTL functions
classmethod GetDTLSegments(pnamespace As %String) as %Status
Get all the segments and fields for source and target classes
classmethod GetDTLSourceTargetClasses(pnamespace As %String) as %Status
Get a list of all classes that could be used as DTL source/target in the groups Message, Virtual Documents, Persistent, Non-System
classmethod GetDTLTestInfo(pnamespace As %String, pdtlClass As %String) as %Status
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
classmethod GetDefaultDir(pnamespace As %String) as %Status
Get the user's default directory
classmethod GetDefaultSetting(pnamespace As %String, pid As %String) as %Status
Get a specific system default setting by ID.
classmethod GetDefaultSettings(pnamespace As %String) as %Status
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
classmethod GetDocTypes(pnamespace As %String, passistClassName As %String) as %Status
Get a list of doctype names and categories for specified assist class
classmethod GetDocTypesForClass(pnamespace As %String, pmessageClass As %String) as %Status
Get a list of all the document types that are available for a given message class grouped by version/type
classmethod GetEnterpriseSystem(pnamespace As %String) as %Status
(%Ens_MsgBank:R) Get an enterprise system client connection
classmethod GetExpiry() as %Status
Get the expiry of the current session
classmethod GetFoldersInPath(pnamespace As %String) as %Status
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.
classmethod GetHostSettingsOptions(pnamespace As %String, phostName As %String) as %Status
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.
classmethod GetInputPluginsList(pnamespace As %String) as %Status
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
classmethod GetLookupTable(pnamespace As %String, plookupTableName As %String) as %Status
Get this lookup table.
classmethod GetLookupTables(pnamespace As %String) as %Status
Get a list of lookup tables in this namespace.
classmethod GetMessage(pnamespace As %String, pheaderID As %String) as %Status
Get Message
(%Ens_MsgBankConfig:R) View the Message Bank Link
classmethod GetMessageSourceTargets(pnamespace As %String) as %Status
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
classmethod GetMgmtUrl(pnamespace As %String) as %Status
Get the 'path' portion of the Interoperability management URL for a given namespace.
classmethod GetPackages(pnamespace As %String) as %Status
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
classmethod GetProcesses(pnamespace As %String) as %Status
Get a list of business processes in the namespace
classmethod GetProduction(pnamespace As %String, pproductionClass As %String) as %Status
Get this production class.
classmethod GetProductionConfigItems(pnamespace As %String) as %Status
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.
classmethod GetProductionItems(pnamespace As %String) as %Status
Get a list of production items in rule.
classmethod GetProductionStatus(pnamespace As %String) as %Status
Get production status.
classmethod GetProductions(pnamespace As %String) as %Status
Get a list of productions.
classmethod GetPropertyList(pnamespace As %String, passistClassName As %String) as %Status
Get the property list for this rule type.
classmethod GetPurgeDataSettings(pnamespace As %String) as %Status
(%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
classmethod GetRecommendedAutoStartPriority(pnamespace As %String) as %Status
(%Ens_ProductionConfig:R) Get the recommended auto-start priority for a production in this namespace
classmethod GetRule(pnamespace As %String, pruleClass As %String) as %Status
Get this rule class.
classmethod GetRuleTypeSchema(pnamespace As %String, passistClassName As %String) as %Status
Get the schema for this rule type.
classmethod GetRuleTypes(pnamespace As %String) as %Status
Get a list of rule types available on the server.
classmethod GetRules(pnamespace As %String) as %Status
Get a list of rule classes available on the server.
classmethod GetSchedule(pnamespace As %String) as %Status
(%Ens_ProductionConfig:R) Get a schedule
classmethod GetSchemaCategories(pnamespace As %String, pschema As %String) as %Status
Get a list of categories and their structure names and descriptions for schema.
classmethod GetSearchResults(pnamespace As %String) as %Status
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
classmethod GetSegmentTypes(pnamespace As %String, pclassName As %String) as %Status
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
classmethod GetSettingsOptions(pnamespace As %String, pproductionClass As %String) as %Status
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.
classmethod GetTestingInputs(pnamespace As %String, pruleClass As %String) as %Status
Get information on this class.
classmethod GetTrace(pnamespace As %String, psessionid As %String) as %Status
Get trace information for session
classmethod GetTransforms(pnamespace As %String) as %Status
Get a list of data transforms.
classmethod GetWorkflowRole(pnamespace As %String) as %Status
(%Ens_WorkflowConfig:READ) Get a workflow role
classmethod GetWorkflowRoleUser(pnamespace As %String) as %Status
(%Ens_WorkflowConfig:READ) Get a user's membership in this role
classmethod GetWorkflowTask(pnamespace As %String, ptaskId As %String) as %Status
(%Ens_MessageContent:U) View the details of a specific workflow task
classmethod GetWorkflowUser(pnamespace As %String) as %Status
(%Ens_WorkflowConfig:READ) Get a workflow user
classmethod ImportLookupTables(pnamespace As %String) as %Status
Import lookup tables
classmethod ListEnterpriseSystems(pnamespace As %String) as %Status
(%Ens_MsgBank:READ) View a list of enterprise system client connections
classmethod ListSchedules(pnamespace As %String) as %Status
(%Ens_ProductionConfig:READ) View a list of available schedules
classmethod ListWorkflowRoleTasks(pnamespace As %String) as %Status
(%Ens_WorkflowConfig:READ) View a list of tasks assigned to this role
classmethod ListWorkflowRoleUsers(pnamespace As %String) as %Status
(%Ens_WorkflowConfig:READ) View a list of users holding this role
classmethod ListWorkflowRoles(pnamespace As %String) as %Status
(%Ens_WorkflowConfig:READ) View a list of workflow roles
classmethod ListWorkflowTasks(pnamespace As %String) as %Status
(%Ens_Portal:U) View a list of workflow tasks
classmethod ListWorkflowUserRoles(pnamespace As %String) as %Status
(%Ens_WorkflowConfig:READ) View a list of roles held by this user
classmethod ListWorkflowUserTasks(pnamespace As %String) as %Status
(%Ens_WorkflowConfig:READ) View a list of tasks assigned to this user
classmethod ListWorkflowUsers(pnamespace As %String) as %Status
(%Ens_WorkflowConfig:READ) View a list of workflow roles
classmethod ListWorkflowWorklist(pnamespace As %String) as %Status
(%Ens_Portal:U) View the current workflow worklist
classmethod Logout() as %Status
Terminate CSP Session.
classmethod PostBPL(pnamespace As %String, pbplClass As %String) as %Status
Create a new BPL class.
classmethod PostBPLPreferences(pnamespace As %String) as %Status
Create/update the current user's BPL preferences
classmethod PostDTL(pnamespace As %String, pdtlClass As %String) as %Status
Create a new DTL class.
classmethod PostDefaultSetting(pnamespace As %String) as %Status
Create a new system default setting.
classmethod PostLookupTable(pnamespace As %String, plookupTableName As %String) as %Status
Create a new lookup table document.
classmethod PostProduction(pnamespace As %String, pproductionClass As %String) as %Status
Create new production class.
classmethod PostRule(pnamespace As %String, pruleClass As %String) as %Status
Create a new rule class.
classmethod PutAutoStart(pnamespace As %String) as %Status
(%Ens_ProductionConfig:W) Set the auto start settings in this namespace
classmethod PutBPL(pnamespace As %String, pbplClass As %String) as %Status
Overwrite this BPL class.
classmethod PutBusinessPartner(pnamespace As %String) as %Status
(%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
classmethod PutDTL(pnamespace As %String, pdtlClass As %String) as %Status
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
classmethod PutDefaultSetting(pnamespace As %String, pid As %String) as %Status
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
classmethod PutEnterpriseSystem(pnamespace As %String) as %Status
(%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
classmethod PutLookupTable(pnamespace As %String, plookupTableName As %String) as %Status
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
classmethod PutPurgeDataSettings(pnamespace As %String) as %Status
(%Ens_PurgeSettings:W) Update the purge data settings
classmethod PutRule(pnamespace As %String, pruleClass As %String) as %Status
Overwrite this rule class.
classmethod PutSchedule(pnamespace As %String) as %Status
(%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
classmethod PutWorkflowRole(pnamespace As %String) as %Status
(%Ens_WorkflowConfig:WRITE) Update/save a workflow role
classmethod PutWorkflowRoleUser(pnamespace As %String) as %Status
(%Ens_WorkflowConfig:W) Update/save a user's membership in this role
classmethod PutWorkflowUser(pnamespace As %String) as %Status
(%Ens_WorkflowConfig:W) Update/save a workflow user
classmethod ResendMessages(pnamespace As %String) as %Status
Resend one or more messages
classmethod ResetProductionItemSettings(pnamespace As %String, pproductionClass As %String, phostID As %String) as %Status
Reset default settings
classmethod SaveMessageSearch(pnamespace As %String, psearchName As %String) as %Status
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.
classmethod SavedSearches(pnamespace As %String) as %Status
Get saved searches for user
classmethod SearchHistory(pnamespace As %String) as %Status
Get search history for user
classmethod SetLanguage(planguage As %String) as %Status
Set the language for this session
classmethod SourceControlAfterUserAction(pnamespace As %String) as %Status
Requests Source Control After User Action for the given parameters
classmethod SourceControlEnabled(pnamespace As %String) as %Status
Returns enabled true or false if Source Control Enabled for the namespace
classmethod SourceControlGetMenus(pnamespace As %String) as %Status
Returns Source Control Menu for the given parameters
classmethod SourceControlGetStatus(pnamespace As %String) as %Status
Requests Source Control GetStatus for the given parameters
classmethod SourceControlUserAction(pnamespace As %String) as %Status
Requests Source Control User Action for the given parameters
classmethod StartMessageSearch(pnamespace As %String) as %Status
Initiate message search.
classmethod TestDTL(pnamespace As %String, pdtlClass As %String) as %Status
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
classmethod TestRule(pnamespace As %String, pruleClass As %String) as %Status
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.
classmethod UpdateSavedMessageSearch(pnamespace As %String, psearchName As %String) as %Status
Update Saved Message Search
classmethod ValidateExpression(pnamespace As %String, pprogLanguage As %String) as %Status
Validate the code block for supported languages (ObjectScript, Python)

Inherited Members

Inherited Methods

FeedbackOpens in a new tab