Learn more about how to use the Get Task by ID for Tenant API to retrieve the details of a specific export task for a given tenant.

For the specified Task ID, the Get Task by ID for tenant API returns the task for the tenant. You will see an error message if the task ID does not exist. You must be an Administrator or the Tenant's Administrator to execute this API.

Request

GET {ExportServiceURL}/{Tenant}/tasks/{taskId}

Response

JSON object representing export task.

{
    "id": "1c8fdae2-1398-4ed3-a62c-a0926c2fbc76",
    "groupId": "1c8fdae2-1398-4ed3-a62c-a0926c2fbc76",
    "createdTime": 1697192357861,
    "createdBy": "{your user name}",
    "updatedTime": 1697193409141,
    "updatedBy": "{your user name}",
    "type": "com.reltio.export.tasks.v4.ExportTask",
    "status": "COMPLETED",
    "name": "entity-export-task[{your tenant-ID}_10-19_entities_b49027]",
    "parallelExecution": true,
    "nodesGroup": "{nodesGroup}",
    "startTime": 1697192373482,
    "endTime": 1697193345470,
    "parameters": {
        "tenantId": "{your tenant-ID}",
        "username": "{your user name}",
        "mailAddress": "user@example.com",
        "taskId": "{tenantId}_10-19_entities_b49027",
        "exportName": "{tenantId}_10-19_entities",
        "exportPath": "entities/user@example.com/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": "user@example.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://{environment}.reltio.com/download.html?tenant={tenantId}&downloadExportUrl=...",
            "https://{environment}.reltio.com/download.html?tenant={tenantId}&downloadExportUrl=...",
            "https://{environment}.reltio.com/download.html?tenant={tenantId}&downloadExportUrl=...",
            "https://{environment}.reltio.com/download.html?tenant={tenantId}&downloadExportUrl=..."
        ],
        "statusId": 90,
        "numberOfObjects": 99805,
        "numberOfProcessedObjects": 99805,
        "warnings": "[]",
        "numberOfReadObjects": 99805,
        "status": "Completed"
    },
    "throughput": 102.78579,
    "duration": "16m 11s"
}