Sign in
process-instance

Get message event subscriptions for a process instance

Changed on
get/process-instances/{processInstanceKey}/event-subscriptions/messages

Request

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

Path parameters

processInstanceKeyinteger required

Query parameters

pageinteger
sizeinteger
state'active' | 'compensated' | 'compensating' | 'completed' | 'completing' | 'failed' | 'failing' | 'ready' | 'terminated' | 'terminating' | 'withdrawn'

Filter by state (omit to list subscriptions in every state)

Response

List of message subscriptions

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

  • 3e2e07de34aaRevision changes
    • breaking

      for the query request parameter page, default value 1 was added

    • breaking

      for the query request parameter size, default value 10 was added

    • warning

      for the query request parameter size, the max was set to 100.00

    • warning

      for the query request parameter page, the min was set to 1.00

    • warning

      for the query request parameter size, the min was set to 1.00

    • info

      added the non-success response with the status

  • 986c88e12ffaRevision changes
    • info

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