Sign in
Historic Process Instance

Get

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

get/history/process-instance/{id}

Request

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

Path parameters

idstring required

The id of the historic process instance to be retrieved.

Response

Request successful.

idstring nullable

The id of the process instance.

rootProcessInstanceIdstring nullable

The process instance id of the root process instance that initiated the process.

superProcessInstanceIdstring nullable

The id of the parent process instance, if it exists.

superCaseInstanceIdstring nullable

The id of the parent case instance, if it exists.

caseInstanceIdstring nullable

The id of the parent case instance, if it exists.

processDefinitionNamestring nullable

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

processDefinitionKeystring nullable

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

processDefinitionVersioninteger nullable

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

processDefinitionIdstring nullable

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

businessKeystring nullable

The business key of the process instance.

startTimestring date-time nullable

The time the instance was started. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

endTimestring date-time nullable

The time the instance ended. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

removalTimestring date-time nullable

The time after which the instance should be removed by the History Cleanup job. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

durationInMillisinteger nullable

The time the instance took to finish (in milliseconds).

startUserIdstring nullable

The id of the user who started the process instance.

startActivityIdstring nullable

The id of the initial activity that was executed (e.g., a start event).

deleteReasonstring nullable

The provided delete reason in case the process instance was canceled during execution.

tenantIdstring nullable

The tenant id of the process instance.

state'ACTIVE' | 'SUSPENDED' | 'COMPLETED' | 'EXTERNALLY_TERMINATED' | 'INTERNALLY_TERMINATED' nullable

Last state of the process instance, possible values are:

ACTIVE - running process instance

SUSPENDED - suspended process instances

COMPLETED - completed through normal end event

EXTERNALLY_TERMINATED - terminated externally, for instance through REST API

INTERNALLY_TERMINATED - terminated internally, for instance by terminating boundary event

restartedProcessInstanceIdstring nullable

The id of the original process instance which was restarted.

Changes

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