Get Job Logs
Queries for historic job logs that fulfill the given parameters. The size of the result set can be retrieved by using the Get Job Log Count method.
Method
GET /history/job-log
Parameters
Query Parameters
| 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. |
| sortBy | Sort the results by a given criterion. Valid values are
timestamp, jobId, jobDefinitionId, jobDueDate, jobRetries, jobPriority,
activityId, executionId, processInstanceId, processDefinitionId, processDefinitionKey, deploymentId, occurrence 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. |
Result
A JSON array of historic job log objects. Each historic job log object has the following properties:
| Name | Value | Description |
|---|---|---|
| id | String | The id of the log entry. |
| timestamp | String | The time when the log entry has been written. |
| removalTime | String | The time after which the log entry should be removed by the History Cleanup job. Default format* yyyy-MM-dd'T'HH:mm:ss.SSSZ. |
| jobId | String | The id of the associated job. |
| jobDueDate | String | The date on which the associated job is supposed to be processed. |
| jobRetries | Number | The number of retries the associated job has left. |
| jobPriority | Number | The execution priority the job had when the log entry was created. |
| jobExceptionMessage | String | The message of the exception that occurred by executing the associated job. |
| jobDefinitionId | String | The id of the job definition on which the associated job was created. |
| jobDefinitionType | String | The job definition type of the associated job. See the User Guide for more information about job definition types. |
| jobDefinitionConfiguration | String | The job definition configuration type of the associated job. |
| activityId | String | The id of the activity on which the associated job was created. |
| executionId | String | The execution id on which the associated job was created. |
| processInstanceId | String | The id of the process instance on which the associated job was created. |
| processDefinitionId | String | The id of the process definition which the associated job belongs to. |
| processDefinitionKey | String | The key of the process definition which the associated job belongs to. |
| deploymentId | String | The id of the deployment which the associated job belongs to. |
| rootProcessInstanceId | String | The process instance id of the root process instance that initiated the process which the associated job belongs to. |
| tenantId | String | The id of the tenant that this historic job log entry belongs to. |
| creationLog | boolean | A flag indicating whether this log represents the creation of the associated job. |
| failureLog | boolean | A flag indicating whether this log represents the failed execution of the associated job. |
| successLog | boolean | A flag indicating whether this log represents the successful execution of the associated job. |
| deletionLog | boolean | A flag indicating whether this log represents the deletion of the associated job. |
* 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/job-log?jobId=aJobId
Response
[
{
"id" : "someId",
"timestamp" : "2015-01-15T15:22:20.000+0200",
"removalTime": "2018-02-10T14:33:19.000+0200",
"jobId" : "aJobId",
"jobDefinitionId" : "aJobDefinitionId",
"activityId" : "serviceTask",
"jobType" : "message",
"jobHandlerType" : "async-continuation",
"jobDueDate" : null,
"jobRetries" : 3,
"jobPriority" : 15,
"jobExceptionMessage" : null,
"executionId" : "anExecutionId",
"processInstanceId" : "aProcessInstanceId",
"processDefinitionId" : "aProcessDefinitionId",
"processDefinitionKey" : "aProcessDefinitionKey",
"deploymentId" : "aDeploymentId",
"rootProcessInstanceId": "aRootProcessInstanceId",
"tenantId": null,
"creationLog" : true,
"failureLog" : false,
"successLog" : false,
"deletionLog" : false
}
]