Get process instance
GET/process-instances/:processInstanceKey
Get the process instance by the process instance key.
Request
Path Parameters
The process instance key.
Responses
- 200
- 400
- 401
- 403
- 404
- 500
The process instance is successfully returned.
- application/json
- application/vnd.camunda.api.keys.number+json
- application/vnd.camunda.api.keys.string+json
- Schema
- Example (from schema)
Schema
The process definition ID.
The process definition name.
The process definition version.
The process definition version tag.
The start date.
The end date.
Possible values: [ACTIVE
, COMPLETED
, CANCELED
]
The state, one of ACTIVE, COMPLETED, CANCELED.
Whether this process instance has a related incident or not.
The tenant ID.
The key of this process instance.
The process definition key.
The parent process instance key.
The parent flow node instance key.
{
"processInstanceKey": "string",
"processDefinitionKey": "string",
"parentProcessInstanceKey": "string",
"parentFlowNodeInstanceKey": "string",
"processDefinitionId": "string",
"processDefinitionName": "string",
"processDefinitionVersion": 0,
"processDefinitionVersionTag": "string",
"startDate": "2024-12-19T15:07:40.116Z",
"endDate": "2024-12-19T15:07:40.116Z",
"hasIncident": true,
"tenantId": "string"
}
- Schema
- Example (from schema)
Schema
The process definition ID.
The process definition name.
The process definition version.
The process definition version tag.
The start date.
The end date.
Possible values: [ACTIVE
, COMPLETED
, CANCELED
]
The state, one of ACTIVE, COMPLETED, CANCELED.
Whether this process instance has a related incident or not.
The tenant ID.
The key of this process instance.
The process definition key.
The parent process instance key.
The parent flow node instance key.
{
"processInstanceKey": 0,
"processDefinitionKey": 0,
"parentProcessInstanceKey": 0,
"parentFlowNodeInstanceKey": 0,
"processDefinitionId": "string",
"processDefinitionName": "string",
"processDefinitionVersion": 0,
"processDefinitionVersionTag": "string",
"startDate": "2024-12-19T15:07:40.116Z",
"endDate": "2024-12-19T15:07:40.116Z",
"hasIncident": true,
"tenantId": "string"
}
- Schema
- Example (from schema)
Schema
The process definition ID.
The process definition name.
The process definition version.
The process definition version tag.
The start date.
The end date.
Possible values: [ACTIVE
, COMPLETED
, CANCELED
]
The state, one of ACTIVE, COMPLETED, CANCELED.
Whether this process instance has a related incident or not.
The tenant ID.
The key of this process instance.
The process definition key.
The parent process instance key.
The parent flow node instance key.
{
"processInstanceKey": "string",
"processDefinitionKey": "string",
"parentProcessInstanceKey": "string",
"parentFlowNodeInstanceKey": "string",
"processDefinitionId": "string",
"processDefinitionName": "string",
"processDefinitionVersion": 0,
"processDefinitionVersionTag": "string",
"startDate": "2024-12-19T15:07:40.117Z",
"endDate": "2024-12-19T15:07:40.117Z",
"hasIncident": true,
"tenantId": "string"
}
The provided data is not valid.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
The request lacks valid authentication credentials.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
Forbidden. The request is not allowed.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
The process instance with the given key was not found.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
An internal error occurred while processing the request.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}