process-instance

Create a new process instance

Changed on
post/process-instances

Request

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

Request body

processDefinitionKeyinteger

Start the process instance using bpmn process definition identified by processDefinitionKey. ( Takes priority )

bpmnProcessIdstring

Start the process instance using latest bpmn process definition identified by bpmnProcessId.

variablesobject nullable
historyTimeToLivestring

Duration for which process instance data are kept in storage after the process instance ends. If omitted the default will be picked up from engine configuration. (1d8h, 1M5d8h)

businessKeystring

Business key of the process instance used mainly for correlating process instance to the business entity.

Example request

{
  "processDefinitionKey": 4503599627370498,
  "variables": {
    "customerId": "customer-456",
    "amount": 1000,
    "applicationDate": "2025-08-22"
  }
}

Response

Process instance created

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

      the request property became nullable

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status