Question
How do I stop an export task?
"id": "1d61e92f-264a-4002-8259-b98a1a294597",
"groupId": "0774f7d7-ee19-4ad7-a6c3-3ba367bc2f84",
Answer
1. Make sure that you have ROLE_API for the tenant. If you do not have the proper access, you will receive the following:
2. Use the API Call [Postman]
3. If you do not know the task Id, perform the following API.
GET https://<environment>/jobs/<tenant>/tasks
You can get the task id from:
4. If you have the task id, perform the following API.
PUT https://<envirnoment>/jobs/tasks/<task or job id>/_stop
You should receive the following response.
5. If you have the task id where there are many sub-tasks and you are planning to stop all sub-tasks, step-4 will be a time-consuming task
In the example below, you can see multiple, 30+, sub-tasks.
"id": "11c996e7-cdfe-4817-ba0d-96e1b34f6880",
"groupId": "191ddea2-306e-41c3-85f6-97f1df50b429",
"parallelTasksIds": "[\"206391fc-5758-43ac-9d3d-972afb942fe3\",\"2220984a-4c81-4f82-8d93-30f141f79cbd\",\"662ee7c6-a141-40c2-8987-5c910beb1a97\",\"409e1485-550e-4141-9ce0-219396201179\",\"4b27e2bf-471f-4660-ad8f-2f582486c5e2\",\"ed59bd4a-24a8-4921-b7fd-9e608872557b\",\"d37d8760-82d5-41d8-a8e6-248b1ce21543\",\"8bb32019-d7ed-4780-bbfa-16872c2258f0\",\"86560883-7789-43b4-bafd-d0c673a04764\",\"e37517b4-421c-48d4-9a9c-9539d6f9e1bd\",\"f94b137d-1d2a-47e3-815b-08ca2d856ba5\",\"0bd1ca8d-2211-4bb5-8430-72a748a65471\",\"20b80ce0-c94e-408d-a01c-933792f3313f\",\"dd7e9419-8aae-465b-942f-5e7e60bc0786\",\"8ab68c81-2d79-4538-a70d-33244cf3bd31\",\"8189fe6d-0dcb-4746-afbf-c10eaa0f77c7\",\"5be8d36d-0116-4313-b239-cbeaa4dccb40\",\"5b962241-9f94-4003-a790-6ce75a1341b7\",\"cb0288b1-20dd-45d2-836a-27b14a339912\",\"d91170b4-af5d-4158-8497-7f7ed3491982\",\"f8ea1502-32de-497a-9f24-41ab62edd861\",\"feb88b5d-342d-40b3-8caa-8d88aa120f37\",\"300bfd3e-9c7e-4419-85ff-2412b9fd8c95\",\"49071fc0-b387-4c4e-99a6-fffeecae9daa\",\"ef2e2b08-8ba2-410b-9749-31188c1c6dc9\",\"4f935025-ee16-47eb-92ff-034bc74e6b50\",\"15cd13f0-f8c0-4fcc-a327-20f706dec932\",\"e198e46f-f9cb-4c35-9a26-c68d7f36c237\",\"6a718375-6871-445e-a27b-fb2f6d19a771\",\"840c86ff-c0dc-4d3b-a188-ecb43d22fb78\",\"f75887f6-fbb9-46fb-b9e9-d9adab194284\",\"3d910e40-1486-4e24-880c-df1447f931be\",\"7b82ae5d-1bfe-43b2-b928-3c5a3e367b93\",\"b52ef230-ebe4-49e4-9a6a-d65024ca337c\",\"50bc78fb-7e2c-4f76-86ee-05453e0e5d50\"]",
To stop all the sub-tasks, please use the group-id which is the same for all the sub-tasks. All the sub-tasks for the group-id will be stopped. Below is the API call for stopping the group-id.
PUT : https://<environment>/jobs/tenantId/groups/group-id/_stop
References
- https://docs.reltio.com/tasksapi/getactivetasks.html
- https://docs.reltio.com/tasksapi/stoptaskfortenant.html?hl=stop%2Ctask
- https://docs.reltio.com/security/systemrolesbasedonpermissions.html?hl=role_api
Comments
Please sign in to leave a comment.