Service Info: bpm
Service Description
This service provides the operations needed to work with Business Process Management (BPM).
Available Operations
The following operations are available for the bpm service. You can click on each operation to see detailed information about that operation.
| Operation | Description |
|---|---|
| autoTaskGetState | Invoke this operation get information about the specified running AutoTask instance. |
| autoTaskRun | Invoke this operation to execute an autoTask process. |
| captureAccessGrant | Operation to grant access on a progressive capture. |
| captureAccessList | Operation to get the list of users, roles and groups who have access to this progressive capture |
| captureAccessRevoke | Operation to revoke access on a progressive capture. |
| captureAdd | Invoke this operation to add a new progressive capture. |
| captureBaseline | Invoke this operation to baseline and activate the specified progressive capture. |
| captureCopy | Invoke this operation to create a copy of an existing progressive capture. |
| captureDelete | Invoke this operation to delete one or more progressive captures. |
| captureDeleteVersion | Invoke this operation to delete a sepecific progressive capture version. If the version specified is active this operation will fail |
| captureGet | Invoke this operation to get the progressive capture details, use this instead of captureGet when you have a progressive capture name instead of an ID. |
| captureGetByName | Invoke this operation to get the progressive capture details, use this instead of captureGet when you have a progressive capture name instead of an ID. |
| captureGetIdFromName | Invoke this operation to get the progressive capture ID, given the application/name. |
| captureGetList | Invoke this operation to get a list of Progressive Captures for a given application. This operation should not be invoked for non-administrative user of the system, instead use captureUserGetList. |
| captureGetVersions | Invoke this operation to get a list of versions for specified progressive capture. |
| captureRename | Invoke this operation to rename a progressive capture. |
| captureSave | Invoke this operation to update a progressive capture. |
| captureSetActive | Invoke this operation to activate/deactivate a progressive capture. |
| captureUserGetList | Invoke this operation for non-administrative user of the system to get an active/validated progressive captures id and name for a given application. This API does not enforce this system setting security.bpm_access_controls.enabled |
| externalApprovalComplete | This operation completes and existing approval. |
| externalApprovalForceComplete | This operation allows the completion of a pending external approval by BPM owenr/manager. |
| externalApprovalGetInfo | This operation gets the specific approal information. |
| externalApprovalSetState | This operation is used internally to update the approval status if errors occur during delivery to external person. |
| getFlowcodeOutcomes | Invoke this operation to return a list of possible outcomes for the specified BPM FlowCode operation. |
| iBridgeCatalogQuery | Used to query the iBridge catalog |
| iBridgeGetData | Used to query data from the iBridge source |
| iBridgeInvoke | Used to invoke an iBridge integration |
| iBridgeListServices | Used to query the list of available integration services |
| isWorkflowActive | Invoke this operation to get the BPM workflow status. |
| lifecycleAccessGrant | EXPERIMENTAL: Operation to grant access on a lifecycle definition. |
| lifecycleAccessList | EXPERIMENTAL: Operation to get the list of users, roles and groups who have access to a lifecycle definition |
| lifecycleAccessRevoke | EXPERIMENTAL: Operation to revoke access on a BPM definition. |
| lifecycleActivate | EXPERIMENTAL: Invoke this operation to activate a specific baseline revision. |
| lifecycleBaseline | EXPERIMENTAL: Invoke this operation to baseline the current draft to a new revision. |
| lifecycleCopy | EXPERIMENTAL: Invoke this operation to create a copy of the specified lifecycle. The newly created lifecycle process is inactive by default. |
| lifecycleCreate | EXPERIMENTAL: Invoke this operation to create a new lifecycle draft. |
| lifecycleDelete | EXPERIMENTAL: Invoke this operation to delete an existing lifecycle. |
| lifecycleGet | EXPERIMENTAL: Invoke this operation to get the lifecycle definition. |
| lifecycleGetList | EXPERIMENTAL: Invoke this operation to get the list lifecycle definitions for a given application. |
| lifecycleGetVersions | EXPERIMENTAL: Invoke this operation to get a list of revisions for the specified lifecycle |
| lifecycleRename | EXPERIMENTAL: Invoke this operation to rename a lifecycle. |
| lifecycleSave | EXPERIMENTAL: Invoke this operation to update an existing lifecycle draft. |
| lifecycleUserGetList | EXPERIMENTAL: Invoke this operation for non-administrative user of the system to get an active/validated lifecycles for a given application. This API does not enforce this system setting security.bpm_access_controls.enabled |
| lifecycleValidate | EXPERIMENTAL: Invoke this operation to activate a specific baseline revision. |
| processCancel | Cancels a running BPM process instance. The flow shall not proceed any further and the state of process instance shall be set to cancelled. |
| processDelete | Invoke this operation to delete the specified BPM instance. |
| processGetApprovalResult | Invoke this operation to get the result object of an approval. |
| processGetState | Invoke this operation get information about the specified BPM instance. |
| processIntegrationResume | Invoke this operation to resume the specified Integration node, if it is in the suspended state. |
| processRestart | Restarts a failed BPM process instance. The flow will continue from where it previously failed. |
| processResume | Invoke this operation to resume the specified BPM instance, if it suspended by a FlowCode invocation. |
| processRunbookResume | Invoke this operation to resume the specified Runbook node, if it is in the suspended state. |
| processSiteIntegrationResume | Invoke this operation to resume the specified Site Integration node, if it is in the suspended state. |
| processSpawn | DEPRECIATED: see processSpawn2 Invoke this operation for spawning a business process. The process can be completed asynchronously or it can initiate tasks. The latter case the process will be suspended. Any task completion will resume the process and the depending on the process it can complete or wait for other tasks to be completed. |
| processSpawn2 | Invoke this operation for spawning a business process. The process can be completed asynchronously or it can initiate tasks. The latter case the process will be suspended. Any task completion will resume the process and the depending on the process it can complete or wait for other tasks to be completed. |
| timePlanResume | Resumes suspended time plan |
| timePlanSuspend | Suspends running time plan |
| workflowAccessGrant | Operation to grant access on a BPM definition. |
| workflowAccessList | Operation to get the list of users, roles and groups who have access to a BPM definition |
| workflowAccessRevoke | Operation to revoke access on a BPM definition. |
| workflowAdd | Invoke this operation to add a new BPM definition. The BPM definition is inactive by default. Use bpm::workflowBaseline operation to validate and activate before spawning a process. |
| workflowBaseline | Invoke this operation to baseline and activate the specified workflow. |
| workflowCopy | Invoke this operation to create a copy of the specified BPM definition. The newly created BPM process is inactive by default. |
| workflowDelete | Invoke this operation to delete the specified BPM definition. |
| workflowGet | Invoke this operation to get the BPM definition. |
| workflowGetVersions | Invoke this operation to get a list of revisions for the specified workflow |
| workflowInstanceBeginEdit | Invoke this operation to create an editable copy of the workflow for the specified workflow instance. |
| workflowInstanceGet | Invoke this operation to get the BPM definition for the specified instance. |
| workflowInstanceRevert | Invoke this operation to revert the instance back to its original defintion and rake out of edit mode. |
| workflowInstanceSave | Invoke this operation to save changes to the instance workflow. |
| workflowList | Invoke this operation to get the list BPM definitions for a given application. |
| workflowRename | Invoke this operation to rename the specified BPM definition. |
| workflowSave | Invoke this operation to save changes to the draft BPM workflow. |
| workflowSetActive | Invoke this operation to activate or deactivate the specified version of BPM definition. |
| workflowUserGetList | Invoke this operation for non-administrative user of the system to get an active/validated workflow id and name for a given application. This API does not enforce this system setting security.bpm_access_controls.enabled |
| workflowValidate | Invoke this operation to validate the specified BPM definition. |