Get flow node instance by key (alpha)

GET 
/flownode-instances/:flownodeInstanceKey

Returns flow node instance as JSON.

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

Path Parameters

flownodeInstanceKey int64required

The assigned key of the flow node instance, which acts as a unique identifier for this flow node instance.

Responses

200

The flow node instance is successfully returned.

application/json

Schema

Schema

flowNodeInstanceKey int64

The assigned key, which acts as a unique identifier for this flow node instance.

processInstanceKey int64

The process instance key associated to this flow node instance.

processDefinitionKey int64

The process definition key associated to this flow node instance.

processDefinitionId string

The process definition id associated to this flow node instance.

startDate date-time

Date when flow node instance started.

endDate date-time

Date when flow node instance finished.

flowNodeId string

The flow node id for this flow node instance.

treePath string

The path from process instance leading to this flow node instance.

type string

Possible values: [UNSPECIFIED, PROCESS, SUB_PROCESS, EVENT_SUB_PROCESS, START_EVENT, INTERMEDIATE_CATCH_EVENT, INTERMEDIATE_THROW_EVENT, BOUNDARY_EVENT, END_EVENT, SERVICE_TASK, RECEIVE_TASK, USER_TASK, MANUAL_TASK, TASK, EXCLUSIVE_GATEWAY, INCLUSIVE_GATEWAY, PARALLEL_GATEWAY, EVENT_BASED_GATEWAY, SEQUENCE_FLOW, MULTI_INSTANCE_BODY, CALL_ACTIVITY, BUSINESS_RULE_TASK, SCRIPT_TASK, SEND_TASK, UNKNOWN]

Type of flow node as defined set of values.

state string

Possible values: [ACTIVE, COMPLETED, TERMINATED]

State of flow node instance as defined set of values.

hasIncident boolean

Shows whether this flow node instance has an incident. If true also an incidentKey is provided.

incidentKey int64

Incident key associated with this flow node instance.

tenantId string

The tenant id of the incident.

Example (from schema)

{
  "flowNodeInstanceKey": 0,
  "processInstanceKey": 0,
  "processDefinitionKey": 0,
  "processDefinitionId": "string",
  "startDate": "2024-10-10T15:06:34.478Z",
  "endDate": "2024-10-10T15:06:34.478Z",
  "flowNodeId": "string",
  "treePath": "string",
  "type": "UNSPECIFIED",
  "state": "ACTIVE",
  "hasIncident": true,
  "incidentKey": 0,
  "tenantId": "string"
}

400

The flow node instance Get failed. More details are provided in the response body.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

The flow node instance with the given key was not found. More details are provided in the response body.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

An internal error occurred while processing the request.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...