List external worker jobs
GET {{baseUrl}}/external-jobs?id=aute aliquip Excepteur ut&executionId=aute aliquip Excepteur ut&processInstanceId=aute aliquip Excepteur ut&processDefinitionId=aute aliquip Excepteur ut&elementId=aute aliquip Excepteur ut&elementName=aute aliquip Excepteur ut&topic=aute aliquip Excepteur ut&withException=false&exceptionMessage=aute aliquip Excepteur ut&locked=true&unlocked=true&filterByCurrentSubscription=true&offset=aute aliquip Excepteur ut&count=aute aliquip Excepteur ut
List external worker jobs
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
id | string | Only return external task job with the given id. | |
executionId | string | Only return jobs with the given executionId. | |
processInstanceId | string | Only return jobs with the processInstanceId. | |
processDefinitionId | string | Only return jobs with the given processDefinitionId. | |
elementId | string | Only return jobs with the given elementId. | |
elementName | string | Only return jobs with the given elementName. | |
topic | string | Only return the jobs with the given topic | |
withException | boolean | Only return jobs with an exception. | |
exceptionMessage | string | Only return jobs with the given exception message. | |
locked | boolean | Only return jobs that are locked. | |
unlocked | boolean | Only return jobs that are unlocked. | |
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. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"links":{"empty":false},"content":[{"id":"056f6c05-65b3-4d49-a55b-61b323a2ebe6","processDefinitionId":"SampleDeployment:1:976626f9-3391-11ea-b509-eeee0affefe7","processInstanceId":"1e09e53c-cf6a-11eb-ab94-50e08558ee22","executionId":"56adec43-d43a-4112-9f49-cd7c64d1d75b","elementName":"Order Execution","retries":3,"elementId":"d91e60a2-1fed-4c84-96a2-1ff117fbe2dd","createTime":"2020-05-04T16:35:10.474Z","tenantId":"827afd64-9915-4e16-ad6f-8dfb604deebe","subscriptionId":"827afd64-9915-4e16-ad6f-8dfb604deebe","dueDate":"2021-05-04T16:35:10.474Z","correlationId":"0077ec6b-19d7-498f-9eda-97a29f82ffab","lockExpirationTime":"2020-05-04T16:35:10.474Z","lockOwner":"orderWorker-1","exceptionMessage":"null","topic":"Upload Invoice","links":{"empty":false}},{"id":"056f6c05-65b3-4d49-a55b-61b323a2ebe6","processDefinitionId":"SampleDeployment:1:976626f9-3391-11ea-b509-eeee0affefe7","processInstanceId":"1e09e53c-cf6a-11eb-ab94-50e08558ee22","executionId":"56adec43-d43a-4112-9f49-cd7c64d1d75b","elementName":"Order Execution","retries":3,"elementId":"d91e60a2-1fed-4c84-96a2-1ff117fbe2dd","createTime":"2020-05-04T16:35:10.474Z","tenantId":"827afd64-9915-4e16-ad6f-8dfb604deebe","subscriptionId":"827afd64-9915-4e16-ad6f-8dfb604deebe","dueDate":"2021-05-04T16:35:10.474Z","correlationId":"0077ec6b-19d7-498f-9eda-97a29f82ffab","lockExpirationTime":"2020-05-04T16:35:10.474Z","lockOwner":"orderWorker-1","exceptionMessage":"null","topic":"Upload Invoice","links":{"empty":false}}]}