RDM Task API
Overview of asynchronous tasks available for RDM tenants
This API allows you to create a task to reindex, rewrite, and delete lookups. In addition, you can get a task based on the task ID, get a list of tasks defined for the tenant, and delete tasks.
Users with either ROLE_ADMIN or ROLE_ADMIN_TENANT role only can use this API.
Create a Task
Request:
POST https://{{rdm-service}}/tasks/{{tenantId}}
Authorization: Bearer {{token}}
{
"type": "reindex",
"parameters": {
"uris": [
"rdm/Country/RF",
...
"rdm/Country/USA"
]
}
}Response:
{
"id": "0093e14f-5335-4823-b64b-46bedd967fe9",
"type": "reindex",
"tenantId": "forTask",
"createdBy": "andrey.hudyakov@reltio.com",
"createdTime": 1503397780502,
"status": "NOT_STARTED",
"parameters": {
"uris": [
"rdm/Country/RF",
...
"rdm/Country/USA"
]
}
}Get Tasks
Request:
GET https://{{rdm-service}}/tasks/{{tenantId}}/0093e14f-5335-4823-b64b-46bedd967fe9
Authorization: Bearer {{token}}Response
{
"id": "0093e14f-5335-4823-b64b-46bedd967fe9",
"type": "reindex",
"tenantId": "forTask",
"createdBy": "andrey.hudyakov@reltio.com",
"createdTime": 1503397780502,
"status": "NOT_STARTED",
"parameters": {
"uris": [
"rdm/Country/RF",
...
"rdm/Country/USA"
]
}
}List Tasks
Request:
GET https://{{rdm-service}}/tasks/{{tenantId}}
Authorization: Bearer {{token}}Response
[
{
"id": "0093e14f-5335-4823-b64b-46bedd967fe9",
"type": "reindex",
"tenantId": "forTask",
"createdBy": "andrey.hudyakov@reltio.com",
"createdTime": 1503397780502,
"status": "NOT_STARTED",
"parameters": {
"uris": [
"rdm/Country/RF",
...
"rdm/Country/USA"
]
}
}
]Delete Tasks
Deleting tasks are for those task that are not can be deleted safely. If you need to delete running task use the force parameter setting. The task will continue to work.
Request:
DELETE https://{{rdm-service}}/tasks/{{tenantId}}/{{taskId}}
Authorization: Bearer {{token}}Response
{
"status": "success"
}