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 |
|---|---|
| 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. |
| captureActivate | Invoke this operation to activate/deactivate a progressive capture. |
| captureAdd | Invoke this operation to add a new 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. |
| captureGet | Invoke this operation to get the details about a progressive capture. |
| 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. |
| captureUpdate | Invoke this operation to update 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 |
| 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. |
| 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. |
| processSpawn | 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 |
| 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. |