Export relations

Learn more about the Export Relations API, which is used to export relations.

This API filters relations, exports them, uploads a CSV or JSON file to the storage and sends a link to the exported data (if post processing is enabled and the partSize parameter isn’t specified) or a link to the Export Console UI page (in the opposite cases) to the user.

Note: Details about Amazon S3, Google Cloud Storage (GCS), or an Azure Blob Storage destination file for export are explained. You can also include Start Date, End Date, Pin and Ignore attributes during export. For more information, see topic topic Storing Export Results.

Request

Standard endpoint:

POST {ExportServiceURL}/export/{{tenant}}/relations

See Table 1: Parameters to find out the list of parameters.

Table 1. Parameters
Parameters	Name	Required	Details
Headers	`Authorization`	Yes	Information about the authentication access token in the format of `Bearer accessToken` (see details in Authentication API ).
	`Content-Type`	Yes	Must be `Content-Type:application/json`.
	`Custom S3/GCS/Azure Destination`	No	A custom S3/GCS/Azure destination, where export results must be saved. For more information, see topic Store export results.
Body		No	JSON object with parameters for filtering the exported entities.
Query	`email`		This parameter indicates the comma-separated list of custom email addresses to which the notification is sent after the export is completed. If the parameter isn’t specified, the Export Service notifies the Reltio user who submitted the export request.
	`dateFormat`	No	This parameter denotes the format of date and time attribute values (CSV and JSON export formats support this parameter). The possible values are `timestamp` and `readable`. The default value is `timestamp`.
	`returnVotes`	No	This parameter denotes that votes must be returned. The default value is `false`.
	`fileFormat`	No	The possible values are `csv` and `json`. This parameter defines what output format must be used for export. The default value is `csv`. Exporting to `json` gives better performance compared to exporting to `csv`.
	`activeness`	No	This parameter determines how the Export Service must process the active and expired objects. The possible values are as follows: `ALL`: Both active and expired objects are exported. This is the default value. `ACTIVE`: Only active objects are exported. `NOT_ACTIVE`: Only expired objects are exported.
	`partSize`	No	This parameter indicates human readable part size and is applied only when `skipPostprocessing=false`. The service splits the result files depending on this setting. For more information, see topic Export Data into Multiple Files.
	`name`	No	This parameter indicates a name of the export task displayed in the task status. The name is also used by the Export UI. For more information, see topic Naming an Export Job.
	`select`	No	This parameter accepts a list of relation fields to be exported. If not specified, then all fields are present in export. For example, `select=type,attributes.Title`. Note: `startObject` and `endObject` aren’t supported for the `select` query when you export to a CSV file.
	`filter`	No	Enables relations filtering by a condition. Format for filter query parameter: `filter=({Condition Type}[AND/OR {Condition Type}]*)`. For more information, see topic Relations Filtering.
	`options`	No	This is a comma-separated list of different options. The available options are as follows: `searchByOv`: This option is disabled by default and is used to search only by attributes with `ov=true`. `resolveMergedEntities`: If this option is specified, the Export Service returns winner URIs for start/end objects in relations. `resolveRelationEdgeTypes`: This option is disabled by default. When it’s enabled, the entity type of the start/end objects of relations is displayed. Note: Labels and directional labels of start/end objects of relations aren’t supported for Spark based export.
	`sePrefix`	No	This parameter is only for CSV export. If set to `true`, then the fields related to start and end objects have either the prefix `StartObject` or the `prefixEndObject`. The default value is `false`. For more information, see topic `sePrefix` Query Parameter in CSV Relations Export.
	`headersStyle`	No	This parameter defines how the Export Service must name the CSV columns for the attribute values. This parameter is only applicable for CSV export. The possible values are as follows: `name` - Attribute names are used for CSV column names. `label` - Attribute labels are used for CSV column names. The default value is `name`. For more information, see topic The Headers Style Query Parameter in CSV Entities or Relations Export File.
	`skipPostprocessing`	No	During data extraction, the Export Service generates many small partial files of the export results. If this parameter is enabled, then the Export Service returns links to these files as results and the `partSize` parameter is ignored. Otherwise, the Export Service combines the partial files into one or more files depending on the `partSize` parameter and return the links to the combined files as results. The default value is false for Export Version 1 and true for Export Version 2.
	`Custom S3/GCS/Azure Destination`	No	A custom S3/GCS/Azure destination, where export results must be saved. For more information, see topic Store export results.
	`filenameTemplate`	No	This parameter enables you to specify a file name template, which generates resultant output file names when the configured export version is Export V2. For more information, see topic Naming Output Files.
	`sendHidden`	No	This parameter enables you to include or exclude hidden attributes to the exported result. By default, the value of the parameter is set to be True. If the value of the parameter is set to False, the exported file won't include hidden attributes of relations.
	`anchorAttribute`	No	This parameter is only applicable for CSV export. The parameter specifies an anchor attribute, and precedes all the other attributes. Only a single OV value for that attribute is presented on a CSV line for a relation. If it's used with slicedByCrosswalks, the value is put on each CSV line no matter which crosswalk that value belongs to. This option isn’t affected by the select parameter. For more information, see topic Generate pivoted view of crosswalks.
	`slicedByCrosswalks`	No	This parameter is only applicable for CSV export. If the value of the parameter is set to true, the objects are sliced by crosswalks. Each set of attribute values are placed on a separate CSV line that represents a crosswalk these attributes belong to. For more information, see topic topic Generate pivoted view of crosswalks.

See Table 2: Body Parameters to find the parameter and the corresponding values and value types.

Table 2. Body parameters
Parameter	Required	Value	Value type
`ovOnly`	No	The possible values are `true` or `false`. If not specified or the value is `true`, then only `ov=true` attributes are exported.	Boolean
`includeType`	No	This parameter indicates a JSON array of relation types. If specified, only relations that belong to the specified types or extend those types are exported.	JSON array
`updateTimeFilter`	No	This parameter indicates the JSON object with update time range. The format is `updateTimeFilter`: `{since : 1394726957000, to : 1394726959000}`. Either only one constraint is enabled or both of them are enabled.	JSON object
`groupBy`	No	This parameter indicates a list of Attribute Group Specifications that enable grouping of Complex Attributes. It’s only applicable for a CSV export. To know more about grouping nested and reference attributes (complex attributes) by one or several of the subattributes, see Parameters for CSV Headers in the Entities or Relations Export File.	JSON object
`headerFormat`	No	This parameter specifies how the Export Service must name the CSV header columns and is only applicable for CSV export. The possible values are: `DEFAULT` `CONSISTENT` For more information, see topic Parameters for CSV Headers in the Entities or Relations Export File.	String
`filter`	No	This parameter enables the filtering of objects by condition. The format for filter parameter is: `filter=({Condition Type}[AND/OR {Condition Type}]*)`. Note: The query `filter` parameter has priority and overrides the body `filter` parameter.	String
`sliceFilter`	No	This parameter is only applicable for CSV export format. You can use the parameter in combination with the `slicedByCrosswalks` query parameter. This parameter provides an ability to filter the individual slices generated by the `slicedByCrosswalks` parameter. The sourceSystems property is available for filtering by source type in sliceFilter parameter. The structure of `sliceFilter` parameter is the same as for regular filter parameter. For more information, see topic Generate pivoted view of crosswalks. Example: `not equals(sourceSystems, 'ReltioCleanser')`	String

Group nested and reference attributes by Anchor attributes

Grouping of Complex Attributes enables you to group nested and reference attributes (complex attributes) by one or several of the subattributes (called anchor attributes). For more information, see topic Group Nested and Reference Attributes.

Result of an export request

The response format is always a JSON object of the results of the export operation. For more information, see topic Result of an Export Request.

Example

Request

Request filtered to export entities updated since '1394726957000' and with type that extends HasAddress or HasAdminRole.

POST {ExportServiceURL}/export/{{tenant}}/relations

Headers

Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512
Content-Type: application/json
{
  "ovOnly" : true,
  "updateTimeFilter" : {"since" : 1394726957000},
  "includeType":["configuration/relationTypes/HasAddress", "configuration/relationTypes/HasAdminRole"]
}

Response

{
   "exportType":"RELATIONS",
   "version":"v2",
   "status":"scheduled",
   "details":"Export job has been scheduled. Result will be sent to your email: user@example.com",
   "taskIds":[
      "57fd98c7-924f-443c-b7bc-902b41a60a2e"
   ]
}

Accelerate the Value of Data

Export relations

Group nested and reference attributes by Anchor attributes

Result of an export request

Example

Footer