Get External Task Log Count (POST)
Queries for the number of historic external task logs that fulfill the given parameters. This method takes the same message body as the Get External Task Logs (POST) method and therefore it is slightly more powerful than the Get External Task Log Count method.
Method
POST /history/external-task-log/count
Parameters
Request Body
A JSON object with the following properties:
Name | Description |
---|---|
logId | Filter by historic external task log id. |
externalTaskId | Filter by external task id. |
topicName | Filter by an external task topic. |
workerId | Filter by the id of the worker that the task was most recently locked by. |
errorMessage | Filter by external task exception message. |
activityIdIn | Only include historic external task logs which belong to one of the passed activity ids. |
activityInstanceIdIn | Only include historic external task logs which belong to one of the passed activity instance ids. |
executionIdIn | Only include historic external task logs which belong to one of the passed execution ids. |
processInstanceId | Filter by process instance id. |
processDefinitionId | Filter by process definition id. |
processDefinitionKey | Filter by process definition key. |
tenantIdIn | Only include historic external task log entries which belong to one of the passed and comma-separated tenant ids. |
priorityLowerThanOrEquals | Only include logs for which the associated external task had a priority lower than or equal to the given value. Value must be a valid long value. |
priorityHigherThanOrEquals | Only include logs for which the associated external task had a priority higher than or equal to the given value. Value must be a valid long value. |
creationLog | Only include creation logs. Value may only be true , as false is the default behavior. |
failureLog | Only include failure logs. Value may only be true , as false is the default behavior. |
successLog | Only include success logs. Value may only be true , as false is the default behavior. |
deletionLog | Only include deletion logs. Value may only be true , as false is the default behavior. |
Result
A JSON object that contains the count as the only property.
Name | Value | Description |
---|---|---|
count | Number | The number of matching historic external task logs. |
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
POST /history/external-task-log/count
Request Body:
{
"externalTaskId": "anExternalTaskId"
}
Response
{
"count": 1
}