Get Decision Instances Count

Query for the number of historic decision instances that fulfill the given parameters. Takes the same parameters as the Get Decision Instances method.

Method

GET /history/decision-instance/count

Parameters

Query Parameters

Name Description
decisionInstanceId Filter by decision instance id.
decisionInstanceIdIn Filter by decision instance ids. Must be a comma-separated list of decision instance ids.
decisionDefinitionId Filter by the decision definition the instances belongs to.
decisionDefinitionKey Filter by the key of the decision definition the instances belongs to.
decisionDefinitionName Filter by the name of the decision definition the instances belongs to.
processDefinitionId Filter by the process definition the instances belongs to.
processDefinitionKey Filter by the key of the process definition the instances belongs to.
processInstanceId Filter by the process instance the instances belongs to.
caseDefinitionId Filter by the case definition the instances belongs to.
caseDefinitionKey Filter by the key of the case definition the instances belongs to.
caseInstanceId Filter by the case instance the instances belongs to.
activityIdIn Filter by the activity ids the instances belongs to. Must be a comma-separated list of acitvity ids.
activityInstanceIdIn Filter by the activity instance ids the instances belongs to. Must be a comma-separated list of acitvity instance ids.
evaluatedBefore Restrict to instances that were evaluated before the given date. The date must have the format yyyy-MM-dd'T'HH:mm:ss, e.g., 2013-01-23T14:42:45.
evaluatedAfter Restrict to instances that were evaluated after the given date. The date must have the format yyyy-MM-dd'T'HH:mm:ss, e.g., 2013-01-23T14:42:45.
sortBy Sort the results by a given criterion. Valid values are evaluationTime. 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.

Result

A JSON object that contains the count as the only property.

Name Value Description
count Number The number of matching historic decision instances.

Response Codes

Code Media type Description
200 application/json Request successful.
400 application/json Returned if some of the query parameters are invalid. See the Introduction for the error response format.

Example

Request

GET /history/decision-instance/count

Response

{
  "count": 4
}

On this Page: