Get related objects of a process instance
Header Parameters
Keycloak access token (OAuth2). Replace [HOST] and [YOUR_REALM] with the values of your installation. OAuth2 flows: Implicit (authorization URL: https://[HOST]/realms/[YOUR_REALM]/protocol/openid-connect/auth)
Query Parameters
Only for history:
ui: prepares the list for a timeline - the start entry of a gateway is merged into its completed entry (withdurationMs); automatic and repeated task steps are hidden; every entry gets anicon; entries of user task nodes get atasksummary.- not set: raw entries.
Only for history and tasks. Comma-separated, e.g. data,gateway:
data: include business data (variables,custom.dataand the business data insideworkItem.inputanduserTask.inputs). Without it,workItem.inputis reduced to the task keysComment,Content,GroupId,NodeName,TaskName,Description,UNIQUE_TASK_ID, anduserTask.inputs/inputsare removed.gateway: also include gateways (historyonly).subprocess: also include sub-processes ...
Only for history:
desc(default): newest first.asc: oldest first.
timestamp and seq are always sorted in the same direction.
ascdescPath Parameters
processInstanceId of a root process instance.
history: history of the casetaskinstance: user tasks, live from the BPM enginetasks: user tasks, from the history and the BPM enginediagram: diagrams of the root instance and all sub-processes
historytaskinstancetasksdiagramResponse
history: EccProcessHistory[]; taskinstance/tasks: EccTask[]; diagram: EccProcess[].
Response Attributes
Technical MongoDB document id. Not a business identifier - do not use it to address objects.
Object type, e.g. process, task, history, process_history, process_node, event.
Java class name of the object.
Unique id of the event (also the MongoDB _id).
Event type: PROCESS_STARTED, PROCESS_COMPLETED, PROCESS_ABORTED, PROCESS_ERROR, ACTIVITY_STARTED, ACTIVITY_COMPLETED, USER_TASK_STATE, USER_TASK_ASSIGNMENT, USER_TASK_VARIABLE, USER_TASK_COMMENT, USER_TASK_ATTACHMENT, USER_TASK_DEADLINE, CUSTOM.
History level used for this event: FULL (with variable snapshot) or MINIMAL.
Engine that produced the event.
processId of the instance the event belongs to.
processInstanceId of the instance the event belongs to.
processInstanceId of the root process.
processInstanceId of the calling process.
processId of the root process.
Process name.
Version of the process definition.
State of the instance after the event.
Business key of the instance.
Version of the history document structure.
Sequence number of the transfer outbox, ascending over all processes of the service. Tie-breaker for events with the same timestamp; not contiguous within one case.
Time the step happened in the engine (start of the instance, entry or exit of the node, task change). Primary sort key.
Name of the node or user task.
BPMN type of the node, e.g. userTask, scriptTask, exclusiveGateway, callActivity.
Reference to a user.
Show child attributes
Process Instance Description of the process model, evaluated for this instance at the time of the event.
Time between entering and leaving the node in milliseconds; set when node.enteredAt and node.leftAt are both present (ACTIVITY_COMPLETED).
Suggested icon key (format=ui only), e.g. process_started, custom, userTask-started, userTask-claim, userTask-ready, userTask-user_task_state, exclusiveGateway-split, callActivity-completed.
User task summary of a history entry (format=ui only).
Show child attributes
Snapshot of all process variables (level FULL). Without include=data removed for user task entries and entries without workItem.
Custom entry written from the process model: { type, message, data }. data only with include=data.
What changed, e.g. { action: claim, from: Ready, to: Reserved }.
Show child attributes
Full user task state after the change for USER_TASK_* events. Once the task has an owner, actualOwnerUserId (subject) and actualOwnerDisplayName are added. inputs only with include=data.
Show child attributes
Node details: id, name, bpmnType, engineType, nodeInstanceId, enteredAt, leftAt.
Work item details: id, name, input, output. Business data in input only with include=data.
Show child attributes
Show child attributes
Missing, invalid or expired access token.
Response Attributes
true for 2xx responses, false for errors.
HTTP status code, same as the response status.
HTTP reason phrase.
Message code for application errors with a defined code (EccException), e.g. EAP0001.
Message text. Localized for coded application errors, otherwise the technical exception message.
Simple class name of the error or its data (errors only).
Payload. Type depends on the endpoint. For coded application errors the EccException.
Not Allowed
history/tasks/diagram: no root process instance with this id.
Response Attributes
true for 2xx responses, false for errors.
HTTP status code, same as the response status.
HTTP reason phrase.
Message code for application errors with a defined code (EccException), e.g. EAP0001.
Message text. Localized for coded application errors, otherwise the technical exception message.
Simple class name of the error or its data (errors only).
Payload. Type depends on the endpoint. For coded application errors the EccException.
Unknown processObject or backend error.
Response Attributes
true for 2xx responses, false for errors.
HTTP status code, same as the response status.
HTTP reason phrase.
Message code for application errors with a defined code (EccException), e.g. EAP0001.
Message text. Localized for coded application errors, otherwise the technical exception message.
Simple class name of the error or its data (errors only).
Payload. Type depends on the endpoint. For coded application errors the EccException.
Response