List external worker jobs

GET {{baseUrl}}/external-jobs?id=officia&executionId=officia&processInstanceId=officia&processDefinitionId=officia&elementId=officia&elementName=officia&topic=officia&withException=true&exceptionMessage=officia&locked=true&unlocked=true&filterByCurrentSubscription=true&offset=officia&count=officia

List external worker jobs

Request Params

KeyDatatypeRequiredDescription
idstringOnly return external task job with the given id.
executionIdstringOnly return jobs with the given executionId.
processInstanceIdstringOnly return jobs with the processInstanceId.
processDefinitionIdstringOnly return jobs with the given processDefinitionId.
elementIdstringOnly return jobs with the given elementId.
elementNamestringOnly return jobs with the given elementName.
topicstringOnly return the jobs with the given topic
withExceptionbooleanOnly return jobs with an exception.
exceptionMessagestringOnly return jobs with the given exception message.
lockedbooleanOnly return jobs that are locked.
unlockedbooleanOnly return jobs that are unlocked.
filterByCurrentSubscriptionbooleanOnly return the jobs in the current subscription
offsetstringStart position value in the list of items, used for pagination.
countstringNumber of items to be limited in the response, used for pagination. By default the count value is set to 10.

RESPONSES

status: OK

{"links":{"empty":true},"content":[{"id":"056f6c05-65b3-4d49-a55b-61b323a2ebe6","subscriptionId":"827afd64-9915-4e16-ad6f-8dfb604deebe","tenantId":"827afd64-9915-4e16-ad6f-8dfb604deebe","executionId":"56adec43-d43a-4112-9f49-cd7c64d1d75b","dueDate":"2021-05-04T16:35:10.474Z","elementName":"Order Execution","retries":3,"topic":"Upload Invoice","exceptionMessage":"Ut offic","correlationId":"0077ec6b-19d7-498f-9eda-97a29f82ffab","lockOwner":"orderWorker-1","elementId":"d91e60a2-1fed-4c84-96a2-1ff117fbe2dd","lockExpirationTime":"2020-05-04T16:35:10.474Z","createTime":"2020-05-04T16:35:10.474Z","processInstanceId":"1e09e53c-cf6a-11eb-ab94-50e08558ee22","processDefinitionId":"SampleDeployment:1:976626f9-3391-11ea-b509-eeee0affefe7","links":{"empty":true}},{"id":"056f6c05-65b3-4d49-a55b-61b323a2ebe6","subscriptionId":"827afd64-9915-4e16-ad6f-8dfb604deebe","tenantId":"827afd64-9915-4e16-ad6f-8dfb604deebe","executionId":"56adec43-d43a-4112-9f49-cd7c64d1d75b","dueDate":"2021-05-04T16:35:10.474Z","elementName":"Order Execution","retries":3,"topic":"Upload Invoice","exceptionMessage":"Excepteur","correlationId":"0077ec6b-19d7-498f-9eda-97a29f82ffab","lockOwner":"orderWorker-1","elementId":"d91e60a2-1fed-4c84-96a2-1ff117fbe2dd","lockExpirationTime":"2020-05-04T16:35:10.474Z","createTime":"2020-05-04T16:35:10.474Z","processInstanceId":"1e09e53c-cf6a-11eb-ab94-50e08558ee22","processDefinitionId":"SampleDeployment:1:976626f9-3391-11ea-b509-eeee0affefe7","links":{"empty":true}}]}