Runtime APIs - Hyland Automate Modeling - Current - Current - Ready - Content Innovation Cloud - external

Hyland Automate Modeling

Platform
Content Innovation Cloud
Product
Hyland Automate Modeling
Release
Current
License

The following APIs are supported:

  • ProcessInstanceAdminControllerImplApi
  • ProcessInstanceControllerImplApi
  • ProcessInstanceTasksControllerImplApi
  • ProcessInstanceVariableAdminControllerImplApi
  • ProcessInstanceVariableControllerImpl
  • TaskAdminControllerImplApi
  • TaskControllerImplApi
  • TaskVariableAdminControllerImplApi
  • TaskVariableControllerImplApi

Using the following names you can perform all the actions related to the APIs mentioned above:

Name Action
RuntimeProcessInstanceAdminService Hyland Automate Modeling Runtime Process Instance Admin REST API, which includes:
  • ProcessInstanceAdminControllerImplApi
  • ProcessInstanceVariableAdminControllerImplApi
RuntimeProcessInstanceService Hyland Automate Modeling Runtime Process Instance REST API, which includes:
  • ProcessInstanceControllerImplApi
  • ProcessInstanceTasksControllerImplApi
  • ProcessInstanceVariableControllerImpl
RuntimeTaskAdminService Hyland Automate Modeling Runtime Task Admin API, which includes:
  • TaskControllerImplApi
  • TaskVariableAdminControllerImplApi
RuntimeTaskService Hyland Automate Modeling Runtime Task API, which includes:
  • TaskControllerImplApi
  • TaskVariableControllerImplApi

For example:

const startProcessPayload = { businessKey: variables.businessKey, payloadType: 'StartProcessPayload', processDefinitionKey: variables.processKey, variables: { fileArray: variables.fileArray } };
const runtimeProcessInstanceService = new RuntimeProcessInstanceService();
runtimeProcessInstanceService.startProcess(startProcessPayload);