Sign in
process-instance

Get state of a process instance selected by processInstanceKey

Changed on
get/process-instances/{processInstanceKey}

Request

  • Base URL: http://localhost:8080/v1
  • URL: http://localhost:8080/v1/process-instances/{processInstanceKey}
  • Auth: none declared

Path parameters

processInstanceKeyinteger required

Response

State of a process instance

keyinteger required
processDefinitionKeyinteger required
bpmnProcessIdstring
versioninteger required
versionTagstring
businessKeystring
createdAtstring date-time required
state'active' | 'completed' | 'terminated' | 'failed' required
parentProcessInstanceKeyinteger
processType'default' | 'multiInstance' | 'subprocess' | 'callActivity' required
variablesobject required
incidentCountinteger

Number of currently unresolved incidents directly associated with this process instance. Present on process-instance list responses and omitted from responses where the count is not calculated. Zero when the listed instance has no open incidents.

Changes

  • b70e3ba65405Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the required property //// to the response with the status

  • 3e2e07de34aaRevision changes
    • info

      added the non-success response with the status