List process definitions
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)
Response
Process definitions.
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 process instance. The only identifier used for instances in the API. Saved drafts use the prefix 'tmp.'.
Id of the process definition (name of the BPMN process), used to start new instances.
processId of the root process. Null for root processes.
processInstanceId of the root process. Null for root processes.
processInstanceId of the calling process. Null for root processes.
A process instance, a saved process draft or a process definition. Which fields are filled depends on the source: process lists are read from the MongoDB projection 'ecc_process_instances', single instances are additionally enriched with live data from the BPM engine, drafts come from 'ecc_saved' (state SAVED, processInstanceId prefixed 'tmp.') and process definitions only carry processId, processName and version.
A process instance, a saved process draft or a process definition. Which fields are filled depends on the source: process lists are read from the MongoDB projection 'ecc_process_instances', single instances are additionally enriched with live data from the BPM engine, drafts come from 'ecc_saved' (state SAVED, processInstanceId prefixed 'tmp.') and process definitions only carry processId, processName and version.
Nodes the instance has passed or is currently in (live data from the BPM engine).
Show child attributes
Error information of a process instance.
Show child attributes
Name of the process as defined in the BPMN model.
Human-readable business key generated at process start from the configured pattern (eccatm.keyindex).
Version of the process definition.
Due date of the process, if an SLA is defined in the model.
Reference to a user.
Show child attributes
Last user who changed the instance (live data from the BPM engine).
Time of the last change.
Start time of the instance.
End time of the instance, if completed or aborted.
Service URL reported by the BPM engine.
REST endpoint of the process in the BPM engine.
State of the instance: PENDING, ACTIVE, COMPLETED, ABORTED, SUSPENDED, ERROR. Saved drafts have the state SAVED.
Business data of the process. Structure depends on the process model, e.g. { "purchase": { ... } }.
BPMN source of the process definition (schema endpoints only).
Free-text note stored with a saved draft.
Process Instance Description from the BPM engine's process definition (as shown in its admin console).
Result of the consistency check between the MongoDB projection and the live data of the BPM engine (only set by GET /api/v1/process/{processInstanceId}):
true: in syncfalse: diverged- not set: not checked
SVG diagram of the process instance (only when requested explicitly).
Name of the process instance page in the frontend: src/apps/{eccUiDirectory}/{eccUiPage}.tsx
App folder of the process in the frontend: src/apps/{eccUiDirectory}/
true if state is ACTIVE.
true if state is PENDING.
true if state is COMPLETED.
true if state is ABORTED.
true if state is SUSPENDED.
true if state is FAILED.
true if slaDueDate is in the past.
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
Unexpected error, e.g. the BPM engine or MongoDB is not reachable. The message contains the cause.
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