Queries for historic case activity instances that fulfill the given parameters. The size of the result set can be retrieved by using the Get Historic Case Activity Instance Count method.

Method

GET /history/case-activity-instance

Parameters

Query Parameters

Name	Description
caseActivityInstanceId	Filter by case activity instance id.
caseActivityInstanceIdIn	Only include case activity instances which belong to one of the passed and comma-separated activity instance ids.
caseInstanceId	Filter by case instance id.
caseDefinitionId	Filter by case definition id.
caseExecutionId	Filter by the id of the case execution that executed the case activity instance.
caseActivityId	Filter by the case activity id (according to CMMN XML).
caseActivityIdIn	Only include case activity instances which belong to one of the passed and comma-separated activity ids.
caseActivityName	Filter by the case activity name (according to CMMN XML).
caseActivityType	Filter by the case activity type (according to CMMN XML).
createdBefore	Restrict to instances that were created before the given date. By default*, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.
createdAfter	Restrict to instances that were created after the given date. By default*, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.
endedBefore	Restrict to instances that ended before the given date. By default*, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.
endedAfter	Restrict to instances that ended after the given date. By default*, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.
finished	Only include finished case activity instances. Value may only be true, as false is the default behavior.
unfinished	Only include unfinished case activity instances. Value may only be true, as false is the default behavior.
required	Only include required case activity instances. Value may only be true, as false is the default behavior.
repeatable	Only include repeatable case activity instances. Value may only be true, as false is the default behavior.
repetition	Only include case activity instances which are repetitions. Value may only be true, as false is the default behavior.
available	Only include available case activity instances. Value may only be true, as false is the default behavior.
enabled	Only include enabled case activity instances. Value may only be true, as false is the default behavior.
disabled	Only include disabled case activity instances. Value may only be true, as false is the default behavior.
active	Only include active case activity instances. Value may only be true, as false is the default behavior.
completed	Only include completed case activity instances. Value may only be true, as false is the default behavior.
terminated	Only include terminated case activity instances. Value may only be true, as false is the default behavior.
tenantIdIn	Filter by a comma-separated list of tenant ids. A case activity instance must have one of the given tenant ids.
withoutTenantId	Only include historic case activity instances that belong to no tenant. Value may only be true, as false is the default behavior.
sortBy	Sort the results by a given criterion. Valid values are caseActivityInstanceID, caseInstanceId, caseExecutionId, caseActivityId, caseActivityName, createTime, endTime, duration, caseDefinitionId and tenantId. Must be used in conjunction with the sortOrder parameter.
sortOrder	Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.
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.

* For further information, please see the documentation.

Result

A JSON array of historic case activity instance objects. Each historic activity instance object has the following properties:

Name	Type	Description
id	String	The id of the case activity instance.
parentCaseActivityInstanceId	String	The id of the parent case activity instance.
caseActivityId	String	The id of the case activity that this object is an instance of.
caseActivityName	String	The name of the case activity that this object is an instance of.
caseActivityType	String	The type of the activity this case execution belongs to.
caseDefinitionId	String	The id of the case definition that this case activity instance belongs to.
caseInstanceId	String	The id of the case instance that this case activity instance belongs to.
caseExecutionId	String	The id of the case execution that executed this case activity instance.
taskId	String	The id of the task that is associated to this case activity instance. Is only set if the case activity is a human task.
calledProcessInstanceId	String	The id of the called process instance. Is only set if the case activity is a process task.
calledCaseInstanceId	String	The id of the called case instance. Is only set if the case activity is a case task.
createTime	String	The time the instance was created. Default format* yyyy-MM-dd'T'HH:mm:ss.SSSZ.
endTime	String	The time the instance ended. Default format* yyyy-MM-dd'T'HH:mm:ss.SSSZ.
durationInMillis	Number	The time the instance took to finish (in milliseconds).
required	Boolean	If true, this case activity instance is required.
repeatable	Boolean	If true, this case activity instance is repeatable.
repetition	Boolean	If true, this case activity instance is a repetition.
available	Boolean	If true, this case activity instance is available.
enabled	Boolean	If true, this case activity instance is enabled.
disabled	Boolean	If true, this case activity instance is disabled.
active	Boolean	If true, this case activity instance is active.
completed	Boolean	If true, this case activity instance is completed.
terminated	Boolean	If true, this case activity instance is terminated.
tenantId	String	The tenant id of the case activity instance.

* For further information, please see the documentation.

Response Codes

Code	Media type	Description
200	application/json	Request successful.
400	application/json	Returned if some of the query parameters are invalid, for example if a sortOrder parameter is supplied, but no sortBy. See the Introduction for the error response format.

Example

Request

GET /history/case-activity-instance?caseActivityName=aCaseActivityName&completed=false

Response

[
  {
    "active": false,
    "available": true,
    "calledCaseInstanceId": "aHistoricCalledCaseInstanceId",
    "calledProcessInstanceId": "aHistoricCalledProcessInstanceId",
    "caseActivityId": "aCaseActivity",
    "caseActivityName": "aCaseActivityName",
    "caseDefinitionId": "aCaseDefId",
    "caseExecutionId": "aCaseExecutionId",
    "caseInstanceId": "aCaseInstId",
    "completed": false,
    "createTime": "2013-04-23T11:20:43.000+0200",
    "disabled": false,
    "durationInMillis": 2000,
    "enabled": false,
    "endTime": "2013-04-23T18:42:43.000+0200",
    "id": "aCaseActivityInstId",
    "parentCaseActivityInstanceId": "aHistoricParentCaseActivityInstanceId",
    "taskId": "aTaskId",
    "terminated": false,
    "required": false,
    "repeatable": true,
    "repetition": false,
    "tenantId": null
  }
]