Get Active Tasks for Tenant

Get tasks for a specified tenant.

This API is available to Administrator and Tenant's Administrator and returns export tasks for the specified all tenants with the following statuses:

SCHEDULED
PROCESSING
PAUSING
PAUSED
CANCELING
WAITING

Note: Available to Admin and the Tenant's Admin.

Requests

GET https://{{URL}}/{Tenant}/tasks?entityTypes=HCP&entityTypes=HCO
Authorization: Bearer {{token}}

GET https://{{URL}}/{Tenant}/tasks?type=com.reltio.businesslogic.tasks.delete.DeleteEntitiesByTypeTask&createdBy=user1&orderBy=CREATED_TIME
&ascending=true
Authorization: Bearer {{token}}

Table 1. Parameters
Name	Required	Details
`max`	No	Positive Integer value to identify the maximum number of tasks to return in a response. Default is `50`.
`offset`	No	Positive Integer value to identify starting what element in the result set should be returned in a response. Can be used to organize pagination in combination with the `max` parameter. Default is `0`.

Response

An array of active tasks for the specified tenant.

 [
  {
    "id": "236aae38-5169-4aa7-8043-1e73cba1c974",
    "groupId": "795b9a9f-394b-4b6b-ba38-e89910f8101d",
    "createdTime": 1632840246312,
    "createdBy": "export_user",
    "updatedTime": 1632981572600,
    "updatedBy": "export_user",
    "type": "com.reltio.export.tasks.local.es.EntitiesESExportTask",
    "status": "PROCESSING",
    "name": "entities-es-export-task[customerTenantId_14-44_entities_e869]",
    "createdOnHost": "export-565d87c549-ddgk4",
    "executedOnHost": "export-c8844cd98-xr5hb",
    "parallelExecution": false,
    "nodesGroup": "etalon-test-jobs",
    "startTime": 1632840260244,
    "parameters": {
      "tenantId": "customerTenantId",
      "updatedSince": "1632996467515",
      "username": "export_user",
      "mailAddress": "user@example.com",
      "taskId": "customertenantid_10-27_entities_d46e",
      "exportName": "customertenantid_10-27_entities",
      "exportPath": "entities/export_user/2021/30-Sep-2021",
      "fileFormat": "CSV",
      "dateFormat": "TIMESTAMP",
      "ovOnly": "true",
      "exploded": "false",
      "encryptUrl": "true",
      "useEsHeadersCollectionExport": "false",
      "includeType": "[\"configuration/entityTypes/Location\"]",
      "updatedBefore": "1632997643113",
      "queryParams": "{\"filter\":\"equals(attributes.Country,'US')\",\"select\":\"createdBy,updatedBy,id\"}",
      "specifiedMailAddress": "user@example.com",
      "exportType": "ENTITIES",
      "activeness": "ALL",
      "headersStyle": "name",
      "sePrefix": "false",
      "skipPostprocessing": "true",
      "fileCompression": "GZIP",
      "headerFormat": "DEFAULT"
    },
    "currentState": {
      "lastExecutionEC2Instances": "i-01cceffe41320be2b",
      "numberOfFailedToPublishEvents": 0,
      "globalStatus": {
        "headerTotal": 235306,
        "lastFiveMinReadThroughput": 171,
        "lastFiveMinThroughput": 169,
        "eta": "25m 3s",
        "entitiesTotal": 235306,
        "headerNumber": 112800,
        "entitiesNumber": 0,
        "overallThroughput": 238,
        "overallReadThroughput": 240,
        "etaMillis": 1503000
      },
      "lastHourThroughput": 237.0203094482422,
      "statusId": 20,
      "numberOfProcessedObjects": 112800,
      "numberOfObjects": 113550,
      "storageType": "S3",
      "restored": true,
      "status": "Creating headers for CSV file..."
    },
    "throughput": 228.34009,
    "duration": "8m 14s"
  }
]

Footer

You've found your way to a temporary environment. Content is not complete or final. Looking for Reltio documentation? Go to docs.reltio.com.

Unify and manage your data

Get Active Tasks for Tenant

Footer