Get Active Tasks
The API returns the export tasks for all tenants.
The Get Active Tasks returns export tasks for all tenants and is available to everyone. This API returns tasks with the following statuses:
SCHEDULEDSCHEDULED_POLLPROCESSINGPAUSINGPAUSEDCANCELINGWAITINGWAITING_FOR_RESOURCE- Indicates that the task is temporarily suspended due to the large number of activities being performed in your tenant.
Request
GET {ExportServiceURL}/tasks| Name | Required | Type | Details |
|---|---|---|---|
max | No | Integer | The parameter represents the positive integer value to identify the maximum number of tasks to return in a response. The default value is 50. |
offset | No | Integer | The parameter represents the positive integer value to identify starting what element in a result set should be returned in a response. The parameter can be used to organize pagination in combination with max parameter. The default value is 0. |
Response
Example: JSON
An array of active export tasks:
[
{
"id": "7fe02b5b-9685-4f4e-b8c2-3cf6819dbf89",
"groupId": "7fe02b5b-9685-4f4e-b8c2-3cf6819dbf89",
"createdTime": 1697119819160,
"createdBy": "john.smith",
"updatedTime": 1697120884333,
"updatedBy": "john.smith",
"type": "com.reltio.export.tasks.v4.ExportTask",
"status": "PROCESSING",
"name": "entity-export-task[apanchenko123_14-10_entities_d2d375]",
"parallelExecution": false,
"nodesGroup": "etalon-idev-02-jobs",
"startTime": 1697119874795,
"parameters": {
"tenantId": "tenant123",
"username": "john.smith",
"mailAddress": "john.smith@reltio.com",
"taskId": "jsmith123_14-10_entities_d2d375",
"exportName": "jsmith123_14-10_entities",
"exportPath": "entities/john.smith/2023/12-Oct-2023",
"fileFormat": "CSV",
"dateFormat": "TIMESTAMP",
"ovOnly": "true",
"exploded": "false",
"encryptUrl": "true",
"includeType": "[\"configuration/entityTypes/HCP\",\"configuration/entityTypes/Contact\",\"configuration/entityTypes/Individual\"]",
"queryParams": "{\"filter\":\"equals(type,'configuration/entityTypes/Individual') and equals(attributes.FirstName, 'John')\"}",
"specifiedMailAddress": "john.smith@reltio.com",
"exportType": "ENTITIES",
"activeness": "ALL",
"headersStyle": "name",
"sePrefix": "false",
"skipPostprocessing": "true",
"fileCompression": "ZIP",
"headerFormat": "DEFAULT",
"headerOrder": "DEFAULT"
},
"currentState": {
"globalStatus": {
"headerTotal": 99805,
"lastFiveMinReadThroughput": 205,
"lastFiveMinThroughput": 84,
"eta": "10m 4s",
"entitiesTotal": 99805,
"headerNumber": 99805,
"entitiesNumber": 25477,
"overallThroughput": 123,
"overallReadThroughput": 158,
"etaMillis": 604000
},
"statusId": 60,
"numberOfObjects": 61477,
"numberOfProcessedObjects": 25477,
"warnings": "[]",
"numberOfReadObjects": 61477,
"status": "Exporting..."
},
"throughput": 25.075787,
"duration": "16m 56s"
},
{
"id": "0f5681c9-39a2-4fc1-981d-ba4db25ab995",
"groupId": "0f5681c9-39a2-4fc1-981d-ba4db25ab995",
"createdTime": 1697120262317,
"createdBy": "john.smith",
"updatedTime": 1697120581111,
"updatedBy": "john.smith",
"type": "com.reltio.export.tasks.v4.ExportTask",
"status": "PAUSED",
"name": "relation-export-task[apanchenko123_14-17_relations_0c4156]",
"parallelExecution": false,
"nodesGroup": "etalon-idev-02-jobs",
"startTime": 1697120356793,
"pausedTime": 1697120569543,
"parameters": {
"tenantId": "apanchenko123",
"username": "john.smith",
"mailAddress": "john.smith@reltio.com",
"taskId": "jsmith123_14-17_relations_0c4156",
"exportName": "jsmith123_14-17_relations",
"exportPath": "relations/john.smith/2023/12-Oct-2023",
"fileFormat": "CSV",
"dateFormat": "TIMESTAMP",
"ovOnly": "true",
"encryptUrl": "true",
"exportVotes": "false",
"includeType": "[\"configuration/relationTypes/HasAddress\"]",
"queryParams": "{}",
"specifiedMailAddress": "john.smith@reltio.com",
"exportType": "RELATIONS",
"activeness": "ALL",
"headersStyle": "name",
"sePrefix": "false",
"skipPostprocessing": "true",
"fileCompression": "ZIP",
"headerFormat": "DEFAULT",
"headerOrder": "DEFAULT"
},
"currentState": {
"globalStatus": {
"headerTotal": 757105,
"lastFiveMinReadThroughput": 55,
"lastFiveMinThroughput": 65,
"eta": "2h 31m 49s",
"relationsNumber": 0,
"relationsTotal": 757105,
"headerNumber": 84000,
"overallThroughput": 157,
"overallReadThroughput": 195,
"etaMillis": 9109000
},
"statusId": 20,
"numberOfObjects": 104400,
"numberOfProcessedObjects": 84000,
"warnings": "[]",
"numberOfReadObjects": 104400,
"status": "Creating headers for CSV file..."
},
"throughput": 396.2264,
"duration": "3m 32s"
}
]