Sign in
process-instance

Get list of running process instances

Changed on
get/process-instances

Request

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

Query parameters

processDefinitionKeyinteger

Key of the process definition

parentProcessInstanceKeyinteger

Key of the parent process instance

businessKeystring

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

pageinteger

Page number (1-based indexing)

sizeinteger

Number of items per page

bpmnProcessIdstring

Filter by BPMN process ID (returns instances across all versions)

sortBy'createdAt' | 'key' | 'state' | 'businessKey' | 'bpmnProcessId'

Sort field (applies globally across partitions)

sortOrder'asc' | 'desc'

Sort direction

createdFromstring date-time

Filter - created after this date

createdTostring date-time

Filter - created before this date

state'active' | 'completed' | 'terminated' | 'failed'

Filter by state

activityIdstring

Filter by current activity element ID

includeChildProcessesboolean

Response

List of running process instances

pageinteger required

Current page number (1-based indexing)

sizeinteger required

Number of items per page

countinteger required

Number of items returned in the current page

totalCountinteger required

Total number of items available

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

  • 8fc9ec992e1cRevision changes
    • info

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