我的书签
添加书签
移除书签Method
POST /history/process-instance
Parameters
|firstResult|Pagination of results. Specifies the index of the first result to return.
|maxResults|Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.
|sortBy|Mandatory. Sort the results lexicographically by a given criterion. Valid values are
instanceId, definitionId, definitionKey, definitionName, definitionVersion, businessKey, startTime, endTime, duration and tenantId.|sortOrder|Mandatory. Sort the results in a given order. Values may be asc for ascending order or desc for descending order.|sortBy|Mandatory. Sort the results lexicographically by a given criterion. Valid values are
instanceId, definitionId, definitionKey, definitionName, definitionVersion, businessKey, startTime, endTime, and tenantId.|sortOrder|Mandatory. Sort the results in a given order. Values may be
asc for ascending order or desc for descending order.|executedActivityBefore|Restrict to instances that executed an activity before the given date (inclusive). By default, the date must have the format
yyyy-MM-dd'T'HHss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.|executedActivityAfter|Restrict to instances that executed an activity after the given date (inclusive). By default, the date must have the format
yyyy-MM-dd'T'HH
ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.|executedActivityIdIn|Restrict to instances that executed an activity with one of given ids.
|activeActivityIdIn|Restrict to instances that have an active activity with one of given ids.
|executedJobBefore|Restrict to instances that executed an job before the given date (inclusive). By default, the date must have the format
yyyy-MM-dd'T'HHss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.|executedJobAfter|Restrict to instances that executed an job after the given date (inclusive). By default, the date must have the format
yyyy-MM-dd'T'HHss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.|active|Restrict to instances that are active
|suspended|Restrict to instances that are suspended
|completed|Restrict to instances that are completed
|externallyTerminated|Restrict to instances that are externally terminated
|internallyTerminated|Restrict to instances that are internally terminated
- For further information, please see the .
Result
- ACTIVE - running process instance
- SUSPENDED - suspended process instances
- EXTERNALLY_TERMINATED - terminated externally, for instance through REST API
- INTERNALLY_TERMINATED - terminated internally, for instance by terminating boundary event
- For further information, please see the documentation.
Response Codes
Example
POST /history/process-instance
Request Body:
[{"id":"7c80cc8f-ef95-11e6-b6e6-34f39ab71d4e","businessKey":null,"processDefinitionId":"invoice:1:7bf79f13-ef95-11e6-b6e6-34f39ab71d4e","processDefinitionKey":"invoice","processDefinitionName":"Invoice Receipt","processDefinitionVersion":1,"endTime":null,"durationInMillis":null,"startUserId":null,"startActivityId":"StartEvent_1","deleteReason":null,"superProcessInstanceId":null,"superCaseInstanceId":null,"caseInstanceId":null,"tenantId":null,"state":"ACTIVE"
