Search Process Instances

Search process instances.

This API can be used to search process instances of a client.

Path Parameters

  • tenant_idstringrequired

    clientId of the tentant

Query Parameters

  • statestring

    Query based on process instances states

    Enum:
    ACTIVECOMPLETEDINTERNALLY_TERMINATEDEXTERNALLY_TERMIANTEDSUSPENDED
  • startedAfterstring

    Query for process instances that are started after

  • startedBeforestring

    Query for process instances that are started before

  • finishedBeforestring

    Query for process instances that are finished before

  • finishedAfterstring

    Query for process instances that are finishes after

  • processDefinitionIdstring

    Query for process instances against process definition id

  • processDefinitionNamestring

    Query for process instances against process definition name

Responses

  • totalResultsnumberrequired

  • orderBystringrequired

  • pageNonumberrequired

  • pageSizenumberrequired

  • totalPagesnumberrequired

  • nextPagebooleanrequired

  • nextPageNonumberrequired

  • previousPageNonumberrequired

  • descendingOrderbooleanrequired

  • resultsarray

Loading Examples...