Export RDM Data Task

Information about how to export data from RDM.

To ensure RDM mastered data can be used by other systems or applications data, data stewards can export RDM lookup types and reference data in the CSV or JSON file format. This file can then be integrated with the required application. This endpoint creates a background task to export lookups data. The result of this task is a ZIP archive with a JSON or CSV file inside. When the task is completed, it sends an email notification to the user who initiated the task. The email contains a link to download the exported file or an error message if the export failed.

Request

Administrator role is required:

POST {RdmURL}/export/{RdmTenantId}

Table 1. Parameters
Parameter		Type	Required	Description
`fileFormat`		String	true	The file format for the exported data. Possible values: `CSV` and `JSON`.
`exportParents`		Boolean	false	To include parents or not as part of the exported data. By default, parents are included.
`exportLookupTypes`		Array	false	The list of lookup types to be exported. All lookup types are exported if this parameter is not specified.
`exportSources`		Object	No	All sources are included if this parameter is not specified.
`exportSources.enabled`		Boolean	Yes	To include source values or not as part of the exported data.
`exportSources.include`		Array	No	The list of sources to be included in the export. If this parameter is `null`, then all sources are included.
`exportLocalizations`		Object	No	All localizations are included if this parameter is not specified.
`exportLocalizations.enabled`		Boolean	Yes	To include localizations or not as part of the exported data.
`exportLocalizations.include`		Array	No	The list of language codes to be included. If this parameter is `null`, then all localizations are included.
`exportAttributes`		Object	No	All attributes are included if this parameter is not specified.
`exportAttributes.enabled`		Boolean	Yes	To include attributes or not as part of the exported data.
`exportAttributes.include`		Map	No	The map of attribute names by lookup type.
	`<key>`	String	Yes	Lookup type
	`<value>`	Array	Yes	The list of attribute names for the specified lookup type.
`exportUpdateInfo`		Boolean	No	To include update information of lookups, such as `updatedBy` and `updatedDate`. The default value is `false`.
`exportVersion`		Boolean	No	To include version of lookups or not as part of the exported data. The default value is `false`.
`email`		String	No	The email ID to send the download link after the export is complete. The email is sent to the user who scheduled export task if this parameter is not specified.

Body

POST https://{{rdm-service}}/export/{{tenant}}
Authorization: Bearer {{token}}
{
    "fileFormat":"csv",
    "exportParents": true,
    "exportLookupTypes": [
        "AddressType",
        "Credentials",
        "IdentifiersType",
        "ProfDesignation",
        "StateProvince"
    ],
    "exportSources": {
        "enabled": true,
        "include": [
            "AHA",
            "Reltio"
        ]
    },
    "exportLocalizations": {
        "enabled": false,
        "include": null
    },
    "exportAttributes": {
        "enabled": false,
        "include": {
            "AddressType": [
                "DisplayName",
                "NumberFormat"
            ]
        }
    },
    "exportUpdateInfo": false,
    "exportVersion": false
}

Response

{
    "taskId": "68390203-f7d8-4013-a9e4-ce93474c69f4"
}

The taskId is a task identifier that can be managed by the RDM Task API.

Decrypt Download URL

Decrypt the URL to Google Cloud Storage or AWS S3 from the download link that is sent in the email.

Request

POST https://{{rdm-service}}/export/{{tenant}}/decryptUrl
Authorization: Bearer {{token}}
 
https://storage.googleapis.com/rdm-dev.appspot.com/rdm-export-lookups/rdmDemo2_lookups_1548220669965.zip?GoogleAccessId=LxAcKmacAAN9Rsb5n0asTE7faKzbuCOg6q%2FwdSvmUTu2nY3HeGzUZk1MZZLO5wTW&Expires=1550035078&Signature=VO88BOnwF0vizkiTambGECp%2FOQVsAtguwFY848Z5di2jCzGjVxtBxH3NfZnasPjDdf5cFvFnc9oYqzqaYgpxviVMz3EWlS3VrI9W7Pz%2Fj%2FFBf7jRuQIvXiyTfi7iZvNhJHPbEviCv5XTw5pki3v1GLCG5up7JrVHGw4oQITfQOz3dEbsUnaJ%2FViCBcFVsIbYu5PwjVlA2NYvdc4AQNabEGVAWp%2Ftl7qvwf3FIUZOAvB8O8Bx8d%2Fo6MUNl7PLAb4aEGbg%2FxSppQFOq4b3diL5Hq5%2Fji4R7ydu%2FGRoAUDDHousFMbr7aMtF1k81itXD8g6ex%2FLxbdv7%2BejCMp%2BRctSHQ%3D%3D

Response

https://storage.googleapis.com/rdm-dev.appspot.com/rdm-export-lookups/rdmDemo2_lookups_1548220669965.zip?GoogleAccessId=rdm-dev%40appspot.gserviceaccount.com&Expires=1550035078&Signature=VO88BOnwF0vizkiTambGECp%2FOQVsAtguwFY848Z5di2jCzGjVxtBxH3NfZnasPjDdf5cFvFnc9oYqzqaYgpxviVMz3EWlS3VrI9W7Pz%2Fj%2FFBf7jRuQIvXiyTfi7iZvNhJHPbEviCv5XTw5pki3v1GLCG5up7JrVHGw4oQITfQOz3dEbsUnaJ%2FViCBcFVsIbYu5PwjVlA2NYvdc4AQNabEGVAWp%2Ftl7qvwf3FIUZOAvB8O8Bx8d%2Fo6MUNl7PLAb4aEGbg%2FxSppQFOq4b3diL5Hq5%2Fji4R7ydu%2FGRoAUDDHousFMbr7aMtF1k81itXD8g6ex%2FLxbdv7%2BejCMp%2BRctSHQ%3D%3D

Getting a Direct Download Link to the Exported File

Copy the download link from the email or an export task.
Decode this link by using a URL Decode tool.
Copy the value of the downloadExportUrl query parameter.
Use the decrypt download URL endpoint mentioned above with value of the downloadExportUrl query parameter and ensure that you use the endpoint on the same RDM tenant where lookups were exported.

Accelerate the Value of Data

Export RDM Data Task

Decrypt Download URL

Getting a Direct Download Link to the Exported File

Footer