Data Export Task

Learn about the Data Export task.

The Reltio Data Science Data Export task extracts data from the primary storage and stores it in the Reltio S3 storage as a parquet file.

To prepare the Reltio data for processing by Reltio Data Science (export data from the database to S3), use Reltio Data Science Job REST APIs to run a Data Export job. Following object types are available for data export:

EntitiesExport - This task extracts entity data including simple, nested, and reference attributes.
InteractionsExport
RelationsExport
MatchesExport
MergesExport

Request: POST {{riUrl}}/api/v1.0/jobs

Table 1. Parameters
Parameter	Name	Required	Details
Headers	`Authorization`	Yes	Information about authentication access token in format "Bearer `<accessToken>`" (see details in Authentication API).
Headers	`Content-Type`	Yes	Should be `Content-Type: application/json`.
Body	`application`	Yes	Indicates the type of tasks to run. The possible values are: `EntitiesExport` `InteractionsExport` `RelationsExport` `MergesExport` `MatchesExport`
	`payload.types`	No	Indicates the comma-separated list of data types that can be exported. Here, data types denote a particular entity, relation, or interaction type. For example, In case of `EntitiesExport`, data types can be entity types like `HCP`, `HCO`, `Location`, and so on. In case of `RelationsExport`, the data types can be `HasAddress`, `Employment`, and so on. In case of `InteractionsExport`, the data types can be `Email`, `ExhibitionEvent`, and so on. Note: The `payload.types` parameter is not required and when omitted, all data types are exported. Also, this parameter is not applicable for the `MatchesExport` and `MergesExport` tasks.
	`cluster.size`	No	Indicates the number of executors Note: If this parameter is omitted, the cluster size is calculated automatically.

Request (To export all data types)

{
  "name":"Data export",
  "tenant":"{{tenant}}",
  "tasks": [
    {
     "application": "EntitiesExport"
   },
   {
     "application": "RelationsExport"
   },
   {
     "application": "InteractionsExport"
   },
   {
     "application": "MergesExport"
   },
   {
     "application": "MatchesExport"
   }
  ],
  "cluster": {
    "cluster.size": 2
  }
}

Request (To export certain entity types):

{
 "name":"Entities Export",
 "tenant":"{{tenant}}",
 "tasks": [
   {
     "application": "EntitiesExport",
     "payload":{
           "types": "HCP,HCO,Location"
     }
   }
 ]
}

Response

{
  "id": "1ssRPDE",
  "uri": "/api/v1.0/jobs/1ssRPDE",
  "status": "PROCESSING"
}

Accelerate the Value of Data

Data Export Task

Footer