Logo
OpenText Developer Cloud public resources API Documentation

Acquire external worker jobs

POST {{baseUrl}}/external-jobs

Acquire external worker jobs for a specific topic with a particular worker id. The number of jobs to be acquired can be specified in the request along with the lock duration and number of possible retries.

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Content-Type
string




RESPONSES

status OK

{ "links": { "empty": false }, "content": [ { "id": "056f6c05-65b3-4d49-a55b-61b323a2ebe6", "variables": [ { "name": "SampleVariableName", "value": {}, "type": "string" }, { "name": "SampleVariableName", "value": {}, "type": "string" } ], "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": "dolore", "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", "variables": [ { "name": "SampleVariableName", "value": {}, "type": "string" }, { "name": "SampleVariableName", "value": {}, "type": "string" } ], "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": "ea ullamco", "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 } } ] }



Curl
curl -X POST 'baseUrl/external-jobs' -H 'Content-Type: */*' -d '{"lockDuration":"PT10M","topic":"Upload Invoice","workerId":"orderWorker-1","numberOfTasks":1,"numberOfRetries":10}'

ENDPOINTS