Get Job Log Count (POST)

Queries for the number of historic job logs that fulfill the given parameters. This method takes the same message body as the Get Job Logs (POST) method and therefore it is slightly more powerful than the Get Job Log Count method.

Method

POST /history/job-log/count

Parameters

Request Body

A JSON object with the following properties:

Name Description
logId Filter by historic job log id.
jobId Filter by job id.
jobExceptionMessage Filter by job exception message.
jobDefinitionId Filter by job definition id.
jobDefinitionType Filter by job definition type. See the User Guide for more information about job definition types.
jobDefinitionConfiguration Filter by job definition configuration.
activityIdIn Only include historic job logs which belong to one of the passed activity ids.
executionIdIn Only include historic job 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.
deploymentId Filter by deployment id.
tenantIdIn Only include historic job log entries which belong to one of the passed and comma-separated tenant ids.
withoutTenantId Only include historic job log entries that belong to no tenant. Value may only be true, as false is the default behavior.
jobPriorityLowerThanOrEquals Only include logs for which the associated job had a priority lower than or equal to the given value. Value must be a valid long value.
jobPriorityHigherThanOrEquals Only include logs for which the associated job 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 job 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/job-log/count

Request Body:

{
  "jobId": "aJobId"
}

Response

{
  "count": 1
}

On this Page: