List timer jobs
GET {{baseUrl}}/timer-jobs?id=aute aliquip Excepteur ut&processInstanceId=aute aliquip Excepteur ut&executionId=aute aliquip Excepteur ut&processDefinitionId=aute aliquip Excepteur ut&elementId=aute aliquip Excepteur ut&elementName=aute aliquip Excepteur ut&withException=true&dueBefore=1980-11-28T23:03:22.176Z&dueAfter=1980-11-28T23:03:22.176Z&exceptionMessage=aute aliquip Excepteur ut&withoutTenantId=true&locked=true&unlocked=true&filterByCurrentSubscription=true&offset=aute aliquip Excepteur ut&count=aute aliquip Excepteur ut&sort=tenantId
List timer jobs
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
id | string | Only return job with the given id | |
processInstanceId | string | Only return jobs part of a process or case with the given id | |
executionId | string | Only return jobs part of an execution with the given id | |
processDefinitionId | string | Only return jobs with the given process or case definition id | |
elementId | string | Only return jobs with the given element id | |
elementName | string | Only return jobs with the given element name | |
withException | boolean | If true, only return jobs for which an exception occurred while executing it. If false, this parameter is ignored. | |
dueBefore | string | Only return jobs which are due to be executed before the given date. Jobs without duedate are never returned using this parameter. | |
dueAfter | string | Only return jobs which are due to be executed after the given date. Jobs without duedate are never returned using this parameter. | |
exceptionMessage | string | Only return jobs with the given exception message | |
withoutTenantId | boolean | If true, only returns jobs without a tenantId set. If false, the withoutTenantId parameter is ignored. | |
locked | boolean | If true, only return jobs which are locked. If false, this parameter is ignored. | |
unlocked | boolean | If true, only return jobs which are unlocked. If false, this parameter is ignored. | |
filterByCurrentSubscription | boolean | Only return the jobs in the current subscription | |
offset | string | Start position value in the list of items, used for pagination. | |
count | string | Number of items to be limited in the response, used for pagination. By default the count value is set to 10. | |
sort | string | Property to sort on, to be used together with the order. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"links":{"empty":false},"content":[{"id":"f8985abd-3391-11ea-b509-eeee0affefe7","processInstanceId":"SampleProcessInstanceId","processDefinitionId":"SampleProcessDefinitionId","executionId":"SampleExecutionId","elementId":"SampleElementId","elementName":"SampleElementName","retries":3,"exceptionMessage":"null","dueDate":"2021-05-04T16:35:10.474Z","createTime":"2020-05-04T16:35:10.474Z","tenantId":"3732adaa-f6f0-4512-873d-357fcebcbd02","subscriptionId":"827afd64-9915-4e16-ad6f-8dfb604deebe","links":{"empty":true}},{"id":"f8985abd-3391-11ea-b509-eeee0affefe7","processInstanceId":"SampleProcessInstanceId","processDefinitionId":"SampleProcessDefinitionId","executionId":"SampleExecutionId","elementId":"SampleElementId","elementName":"SampleElementName","retries":3,"exceptionMessage":"null","dueDate":"2021-05-04T16:35:10.474Z","createTime":"2020-05-04T16:35:10.474Z","tenantId":"3732adaa-f6f0-4512-873d-357fcebcbd02","subscriptionId":"827afd64-9915-4e16-ad6f-8dfb604deebe","links":{"empty":true}}]}