Skip to main content
Version: Next

Get flow node instance

GET 
/flownode-instances/:flownodeInstanceKey

Returns flow node instance as JSON.

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​

The flow node instance is successfully returned.

Schema
    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.

    flowNodeName string

    The flow node name for 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.

    tenantId string

    The tenant ID of the incident.

    flowNodeInstanceKey string

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

    processInstanceKey string

    The process instance key associated to this flow node instance.

    processDefinitionKey string

    The process definition key associated to this flow node instance.

    incidentKey string

    Incident key associated with this flow node instance.

Loading...