Question
We need to provide all the Relations (Affiliation and Address) for a specific market downstream. Is there an API to get this data from Reltio?
Answer
Yes, this can be achieved using Reltio's Export API, which allows you to export relations—either all at once or filtered by specific criteria like relation types or update timestamps.
The Export Service provides flexible options to export all or a subset of relations in various formats (CSV, JSON). The results can be written to S3 and linked in the response or sent to your email.
Option 1: Export All Relations
Endpoint:
POST {ExportServiceURL}/export/{tenant}/relations/_all
Behavior:
- Exports all relation records in the tenant.
- Sends a link to the exported file to the API user's email.
- Output is typically multiple files compressed in GZIP format.
Option 2: Export Filtered Relations
Endpoint:
POST {ExportServiceURL}/export/{tenant}/relations
Sample Request Body:
{
"ovOnly": true,
"updateTimeFilter": {
"since": 1394726957000
},
"includeType": [
"configuration/relationTypes/HasAddress",
"configuration/relationTypes/HasAdminRole"
]
}
Behavior:
- Exports only the relations that match your filters.
- You can include relation types, date filters, and other optional parameters like file format and notification preferences.
Additional Parameters (Optional)
-
filter: Custom conditions using operators likeequals,missing,range, etc. -
fileFormat: Output file type (csvorjson). Default iscsv. -
dateFormat: Use"timestamp"or"readable"for date values. -
skipPostprocessing: Set tofalseif you want a single output file (not recommended for large datasets). -
email: Comma-separated list of notification recipients.
References
Â
Comments
Please sign in to leave a comment.