Use this resource to export data to CSV or JSON format. You can export code values in a code list and value mappings in a crosswalk.
Export code values to a CSV file
Exports the code values in a code list to a CSV file.
POST request
To export code values in a code list, submit a POST request with the following URI:
/rdm-service/external/v1/export
Note: In the request header, you must specify the Accept attribute to application/octet-stream.
Use the following parameters in the request body to specify the code list to export:
Field
Type
Description
delimiter
String
Delimiter used to separate values. Value must be ASTERISK, CIRCUMFLEX, COLON, COMMA, PIPE, SECTION, SEMICOLON, SPACE, or TAB.
codepage
String
Code page used for the export file. Value must be UTF8.
decimalSeparator
String
Decimal separator used for numbers. Value must be COMMA or DOT.
thousandSeparator
String
Grouping separator used for numbers. Value must be COMMA, DOT, SPACE, SINGLEQUOTE, or NONE.
dateFormat
String
Format used for dates. Use one of the following formats:
- DE. For dd.mm.yyyy format.
- ISO. For yyyy-mm-dd format.
- US. For mm/dd/yyyy format.
filename
String
Default name for the CSV file that you can download. The filename parameter is required to map the Content-Disposition header to indicate that you can save the API response as a CSV file.
containerType
String
Type of asset that contains code values. Value must be codelist.
containerId
String
The ID of the code list.
Note: You can find the ID of assets in Reference 360 or use REST APIs to retrieve the IDs. For more information, see Asset IDs.
filter
Object
Optional. Filter criteria for exporting filtered code values. For more information, see Filter criteria.
columns
Array
Optional. Attribute columns you want to export. If you do not specify attribute columns, the export includes all attribute columns.
excludeParentId
Boolean
Optional. Indicates whether to include the parent ID of code values in the CSV file. Value is true or false.
POST response
The response is a CSV file. The CSV file contains two header rows followed by data rows.
The CSV file contains the following columns: status.key and effectiveDate. Based on your data model, you might have additional columns in the file.
POST example
To export the code values in a code list, you might use the following request:
POST https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/export HTTP/1.1 Content-Type: application/json Accept: application/octet-stream IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX