Get process instance by key

GET 
/v1/process-instances/:key

Get process instance by key

Request

Path Parameters

key int64required

Key of process instance

Responses

200

Success

application/json

Schema

Schema

key int64
processVersion int32
bpmnProcessId string
parentKey int64
parentFlowNodeInstanceKey int64
startDate string
endDate string
state string

Possible values: [ACTIVE, COMPLETED, CANCELED]

processDefinitionKey int64
tenantId string
parentProcessInstanceKey

Example (from schema)

{
  "key": 0,
  "processVersion": 0,
  "bpmnProcessId": "string",
  "parentKey": 0,
  "parentFlowNodeInstanceKey": 0,
  "startDate": "string",
  "endDate": "string",
  "state": "ACTIVE",
  "processDefinitionKey": 0,
  "tenantId": "string"
}

400

Invalid request

application/problem+json

Schema

Schema

status int32
message string
instance string
type string

Example (from schema)

{
  "status": 0,
  "message": "string",
  "instance": "string",
  "type": "string"
}

403

Forbidden

*/*

Schema

Schema

status int32
message string
instance string
type string

Example (from schema)

{
  "status": 0,
  "message": "string",
  "instance": "string",
  "type": "string"
}

404

Requested resource not found

application/problem+json

Schema

Schema

status int32
message string
instance string
type string

Example (from schema)

{
  "status": 0,
  "message": "string",
  "instance": "string",
  "type": "string"
}

500

API application error

application/problem+json

Schema

Schema

status int32
message string
instance string
type string

Example (from schema)

{
  "status": 0,
  "message": "string",
  "instance": "string",
  "type": "string"
}

Loading...