Getting the Tasks List
Use this API to retrieve the tasks list. By default, all tasks are returned. You can also filter the results by specifying the tenant, profile, or task status. When you do this, only the tasks for the specified values are displayed.
For example: if you want to view the tasks associated with a tenant called tenant, a profile called profile, and a task status of active, enter these values in the tenant, profile, and status parameters respectively.
The API parameters are listed in Table 1: Get Tasks List.
Parameters | Name | Required | Description |
---|---|---|---|
Headers | ContentType | Yes | Format must be Content-Type:application/json . |
Headers | Authorization | Yes | Contains information about the authentication access token. Format must be Bearer 'access token . |
Path/Query | tenant | Yes | Contains the Reltio tenant name. |
Path/Query | profile | Yes | Contains the Salesforce Profile ID. In most cases, the Profile ID is the Salesforce Organization ID, and it has 18 digits. |
Query | status | No | Contains the task status. The supported task statuses are active and inactive . |
Query | offset | No | Contains the result offset. |
Query | limit | No | Contains the number of results that will be displayed. |
Request for One Tenant
This request returns tasks for a single tenant.
GET {connector}/tasks/{tenant}/{profile}
Response
[
{
"id": 1,
"type": "sync",
"status": "completed",
"createdBy": "username",
"created": "2021-05-24T09:37:08.614Z",
"profile": "tenant1+profile1"
},
]