Skip to main content
GET
/
process-instance
/
{id}
/
activity-instances
Get Activity Instance
curl --request GET \
  --url http://{host}:{port}/{contextPath}/process-instance/{id}/activity-instances \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "eca75c6b-f70c-11e9-8777-e4a7a094a9d6",
  "parentActivityInstanceId": null,
  "activityId": "invoice:2:e9d77375-f70c-11e9-8777-e4a7a094a9d6",
  "activityType": "processDefinition",
  "processInstanceId": "eca75c6b-f70c-11e9-8777-e4a7a094a9d6",
  "processDefinitionId": "invoice:2:e9d77375-f70c-11e9-8777-e4a7a094a9d6",
  "childActivityInstances": [
    {
      "id": "approveInvoice:eca89509-f70c-11e9-8777-e4a7a094a9d6",
      "parentActivityInstanceId": "eca75c6b-f70c-11e9-8777-e4a7a094a9d6",
      "activityId": "approveInvoice",
      "activityType": "userTask",
      "processInstanceId": "eca75c6b-f70c-11e9-8777-e4a7a094a9d6",
      "processDefinitionId": "invoice:2:e9d77375-f70c-11e9-8777-e4a7a094a9d6",
      "childActivityInstances": [],
      "childTransitionInstances": [],
      "executionIds": [
        "eca75c6b-f70c-11e9-8777-e4a7a094a9d6"
      ],
      "activityName": "Approve Invoice",
      "incidentIds": [
        "648d7e21-f71c-11e9-a725-e4a7a094a9d6"
      ],
      "incidents": [
        {
          "id": "648d7e21-f71c-11e9-a725-e4a7a094a9d6",
          "activityId": "AttachedTimerBoundaryEvent"
        }
      ],
      "name": "Approve Invoice"
    }
  ],
  "childTransitionInstances": [],
  "executionIds": [
    "eca75c6b-f70c-11e9-8777-e4a7a094a9d6"
  ],
  "activityName": "Invoice Receipt",
  "incidentIds": null,
  "incidents": null,
  "name": "Invoice Receipt"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The id of the process instance for which the activity instance should be retrieved.

Response

Request successful.

A JSON object corresponding to the Activity Instance tree of the given process instance.

​
id
string | null

The id of the activity instance.

​
parentActivityInstanceId
string | null

The id of the parent activity instance, for example a sub process instance.

​
activityId
string | null

The id of the activity.

​
activityName
string | null

The name of the activity

​
name
string | null

The name of the activity. This property is deprecated. Please use 'activityName'.

​
activityType
string | null

The type of activity (corresponds to the XML element name in the BPMN 2.0, e.g., 'userTask')

​
processInstanceId
string | null

The id of the process instance this activity instance is part of.

​
processDefinitionId
string | null

The id of the process definition.

​
childActivityInstances
object[] | null

A list of child activity instances.

​
childTransitionInstances
object[] | null

A list of child transition instances. A transition instance represents an execution waiting in an asynchronous continuation.

​
executionIds
string[] | null

A list of execution ids.

​
incidentIds
string[] | null

A list of incident ids.

​
incidents
object[] | null

A list of JSON objects containing incident specific properties:

  • id: the id of the incident
  • activityId: the activity id in which the incident occurred