Process Instance

Get Activity Instance

Retrieves an Activity Instance (Tree) for a given process instance by id.

get/process-instance/{id}/activity-instances

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/process-instance/{id}/activity-instances
  • Auth: HTTP basic

Path parameters

idstring required

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

Response

Request successful.

idstring nullable

The id of the activity instance.

parentActivityInstanceIdstring nullable

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

activityIdstring nullable

The id of the activity.

activityNamestring nullable

The name of the activity

namestring nullable

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

activityTypestring nullable

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

processInstanceIdstring nullable

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

processDefinitionIdstring nullable

The id of the process definition.

executionIdsstring[] nullable

A list of execution ids.

incidentIdsstring[] nullable

A list of incident ids.

Changes

No recorded changes to this operation across all 1 revision of this API.