Returns the task with the given ID or an error if there is no task with this ID.

The Get Task by ID API returns the task for the specified task ID. You will see an error message if the task ID does not exist. You must be an This task is available to Administrator or and the Tenant's Administrator to execute this API..This task is available to Administrator.

Request

GET {ExportServiceURL}/tasks/{taskId}

Response

JSON object representing export task.

{
    "id": "1c8fdae2-1398-4ed3-a62c-a0926c2fbc76",
    "groupId": "1c8fdae2-1398-4ed3-a62c-a0926c2fbc76",
    "createdTime": 1697192357861,
    "createdBy": "john.smith",
    "updatedTime": 1697193409141,
    "updatedBy": "john.smith",
    "type": "com.reltio.export.tasks.v4.ExportTask",
    "status": "COMPLETED",
    "name": "entity-export-task[jsmith123_10-19_entities_b49027]",
    "parallelExecution": false,
    "nodesGroup": "etalon-idev-02-jobs",
    "startTime": 1697192373482,
    "endTime": 1697193345470,
    "parameters": {
        "tenantId": "jsmith123",
        "username": "john.smith",
        "mailAddress": "john.smith@reltio.com",
        "taskId": "jsmith123_10-19_entities_b49027",
        "exportName": "jsmith123_10-19_entities",
        "exportPath": "entities/john.smith/2023/13-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": 222,
            "lastFiveMinThroughput": 335,
            "entitiesTotal": 99805,
            "headerNumber": 99805,
            "entitiesNumber": 99805,
            "overallThroughput": 205,
            "overallReadThroughput": 205
        },
        "exportUrls": [
            "https://idev-02.reltio.com/download.html?tenant=apanchenko123&downloadExportUrl=...",
            "https://idev-02.reltio.com/download.html?tenant=apanchenko123&downloadExportUrl=...",
            "https://idev-02.reltio.com/download.html?tenant=apanchenko123&downloadExportUrl=...",
            "https://idev-02.reltio.com/download.html?tenant=apanchenko123&downloadExportUrl=..."
        ],
        "statusId": 90,
        "numberOfObjects": 99805,
        "numberOfProcessedObjects": 99805,
        "warnings": "[]",
        "numberOfReadObjects": 99805,
        "status": "Completed"
    },
    "throughput": 102.78579,
    "duration": "16m 11s"
}