Process Instances REST Endpoints
Process/Process Instances
Create and retrieve information about process instances.
- Add Attachments to a Process
- Method: postPath:
/ic/api/process/v1/processes/{processId}/attachments
- Add Comments to a Process
- Method: postPath:
/ic/api/process/v1/processes/{processId}/comments
- Create a Process Instance
- Method: postPath:
/ic/api/process/v1/processes
- Delete Process Attachments
- Method: deletePath:
/ic/api/process/v1/processes/{processId}/attachments/{attachmentId}
- Get Faults for a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/faults
- Perform Actions on a List of Instances
- Method: putPath:
/ic/api/process/v1/processes
- Retrieve a Conversation for a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/conversations/{conversationId}
- Retrieve a Process Attachment as a Stream
- Method: getPath:
/ic/api/process/v1/processes/{processId}/attachments/{attachmentName}/stream
- Retrieve a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}
- Retrieve a Process Instance by case ID
- Method: getPath:
/ic/api/process/v1/processes/dynamic-process/{executionId}
- Retrieve Activities Flow for a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/activityflows
- Retrieve Conversations for a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/conversations
- Retrieve Data Objects by Open Activity ID
- Method: getPath:
/ic/api/process/v1/processes/{processId}/activities/{activityId}/dataobjects
- Retrieve Data Objects for a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/dataobjects
- Retrieve Instance Metrics for the User
- Method: getPath:
/ic/api/process/v1/processes/instance-metrics
- Retrieve Open activities for a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/activities
- Retrieve the Approval Outcome
- Method: getPath:
/ic/api/process/v1/processes/{processId}/approval
- Retrieve the Attachment List for a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/attachments
- Retrieve the Audit Diagram of a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/audit
- Retrieve the Audit Instance Payload document for given audit query ID
- Method: getPath:
/ic/api/process/v1/processes/{processId}/audit/{queryId}/payload
- Retrieve the Comment List for a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/comments
- Retrieve the DOCs folder Details for a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/folders/{folderId}
- Retrieve the List of DOCs Folders for a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/folders
- Retrieve the Process Instance List
- Method: getPath:
/ic/api/process/v1/processes
- Update the Process State
- Method: putPath:
/ic/api/process/v1/processes/{processId}