Sign in
Process Instance

Get Process Instance

Retrieves a process instance by id, according to the ProcessInstance interface in the engine.

get/process-instance/{id}

Request

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

Path parameters

idstring required

The id of the process instance to be retrieved.

Response

Request successful.

idstring nullable

The id of the process instance.

definitionIdstring nullable

The id of the process definition that this process instance belongs to.

definitionKeystring nullable

The key of the process definition that this process instance belongs to.

businessKeystring nullable

The business key of the process instance.

caseInstanceIdstring nullable

The id of the case instance associated with the process instance.

endedboolean nullable

A flag indicating whether the process instance has ended or not. Deprecated: will always be false!

suspendedboolean nullable

A flag indicating whether the process instance is suspended or not.

tenantIdstring nullable

The tenant id of the process instance.

Changes

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