Skip to main content
Version: 8.6

Query process instances (alpha)

POST 

/process-instances/search

Search for process instances based on given criteria.

note

This endpoint is an alpha feature and not enabled on Camunda clusters out of the box. See the Camunda 8 REST API overview for further details.

Request

Body

    sort object[]
  • Array [
  • field stringrequired
    order string

    Default value: asc

  • ]
  • page object
    from int32
    limit int32
    searchAfter object[]
    searchBefore object[]
    filter object
    running boolean
    active boolean
    incidents boolean
    finished boolean
    completed boolean
    canceled boolean
    retriesLeft boolean
    errorMessage string
    activityId string
    startDate date-time
    endDate date-time
    bpmnProcessId string

    The bpmn process ID.

    processDefinitionVersion int32
    variable object
    name string
    values string[]
    batchOperationId string
    parentProcessInstanceKey int64
    tenantId string

Responses

The Process Instance Search successful response.

Schema
    page object
    totalItems int64
    firstSortValues object[]
    lastSortValues object[]
    items object[]
  • Array [
  • key int64
    processDefinitionName string

    The process name.

    processDefinitionVersion int32
    bpmnProcessId string
    parentKey int64
    parentFlowNodeInstanceKey int64
    startDate date-time
    endDate date-time
    state string

    Possible values: [ACTIVE, INCIDENT, COMPLETED, CANCELED, UNKNOWN, UNSPECIFIED]

    incident boolean
    hasActiveOperation boolean
    processDefinitionKey int64
    tenantId string
    rootInstanceId string
    operations object[]
  • Array [
  • id string
    batchOperationId string
    type string

    Possible values: [RESOLVE_INCIDENT, CANCEL_PROCESS_INSTANCE, DELETE_PROCESS_INSTANCE, ADD_VARIABLE, UPDATE_VARIABLE, MODIFY_PROCESS_INSTANCE, DELETE_DECISION_DEFINITION, DELETE_PROCESS_DEFINITION, MIGRATE_PROCESS_INSTANCE]

    state string

    Possible values: [SCHEDULED, LOCKED, SENT, FAILED, COMPLETED]

    errorMessage string
    completedDate date-time
  • ]
  • callHierarchy object[]
  • Array [
  • instanceId string
    processDefinitionId string
    processDefinitionName string
  • ]
  • ]
Loading...