Reference 360

Back Next

Export value mappings to CSV format with display attributes in the header

Exports the value mappings in a crosswalk to CSV format with display attributes instead of codes, in the header.

POST request

To export value mappings in a crosswalk with display attributes in the header, submit a POST request with the following URI:

/rdm-service/external/v3/export

In the request header, you must specify the

attribute to

application/octet-stream

Use the following parameters in the request body to specify the crosswalk value mappings to export:

Field	Type	Description
Delimiter	String	Optional. Delimiter used to separate values. Value must be COMMA , SEMICOLON , SPACE , TAB , PIPE , COLON , SECTION , CIRCUMFLEX , or ASTERISK . Default is COMMA .
codepage	String	Code page used for the export file. Value must be UTF8 or MS_WINDOWS . Default is UTF8 .
decimalSeparator	String	Optional. Decimal separator used for numbers. Value must be COMMA or DOT . Default is DOT .
thousandSeparator	String	Optional. Grouping separator used for numbers. Value must be COMMA , DOT , SPACE , SINGLEQUOTE or NONE . Default is 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	File name for the exported file. Value must end with the .csv file extension.
containerType	String	Type of asset that contains value mappings. Value must be crosswalk .
containerId	String	ID of the crosswalk. You can find the ID of assets in Reference 360 or use REST APIs to retrieve the IDs. For more information, see Asset IDs.
pageSize	Number	Optional. Number of records to display on each page. The maximum value is 10000 . Default is 10000 .
page	Number	Optional. Page number to display. Default is 0 .
pit	String	Optional. Date to retrieve the point in time information about the crosswalk. Use the ISO format: yyyy-mm-dd. Default value is the current timestamp in yyyy-mm-dd format.
repeatHeaders	Boolean	Optional. Indicates whether to populate headers in the CSV response for the requested page. Value is true or false . Default is true .
useDisplayAttributes	Boolean	Indicates to use display attributes in the header of the CSV file. Value must be true .
codelistNameAndFieldDelimiter	String	Optional. Delimiter used to separate the codelist name and the display attribute name in the header. Value must be COMMA , SEMICOLON , SPACE , TAB , PIPE , COLON , SECTION , CIRCUMFLEX , or ASTERISK . Default is SPACE .

POST response

The response is a CSV file.

POST example

To export value mappings in a crosswalk with display attributes in the header, you might use the following request:

POST https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v3/export HTTP/1.1
Content-Type: application/json
Accept: application/octet-stream
Content-Length: 454

{
   "delimiter":"SEMICOLON",
   "codepage":"UTF8",
   "decimalSeparator":"COMMA",
   "thousandSeparator":"DOT",
   "dateFormat":"ISO",
   "filename":"testdata.csv",
   "containerType":"crosswalk",
   "containerId":"a8ef483f4f448a6ec273d547",
   "pageSize":10000,
   "page":0,
   "pit":"2021-11-09",
   "repeatHeaders":false,   
   "useDisplayAttributes":true,
   "codelistNameAndFieldDelimiter":"SPACE"
}

The following sample response shows the exported data in the CSV format:

HTTP/1.1 200 OK
Content-Disposition: attachment;filename=testdata.csv
Content-Type: application/octet-stream
RDM-PAGE: 0
RDM-TOTAL-NUMBER-OF-ELEMENTS: 10
RDM-NUMBER-OF-ELEMENTS: 10
RDM-PAGE-SIZE: 10000
RDM-FIRST-PAGE: true
RDM-LAST-PAGE: true
Content-Length: 560

SourceCodelist Name;SourceCodelist Code;TargetCodelist Name;TargetCodelist Code
sourceName0;sourceCode0;targetName0;targetCode0
sourceName1;sourceCode1;targetName1;targetCode1
sourceName2;sourceCode2;targetName2;targetCode2
sourceName3;sourceCode3;targetName3;targetCode3
sourceName4;sourceCode4;targetName4;targetCode4
sourceName5;sourceCode5;targetName5;targetCode5
sourceName6;sourceCode6;targetName6;targetCode6
sourceName7;sourceCode7;targetName7;targetCode7
sourceName8;sourceCode8;targetName8;targetCode8
sourceName9;sourceCode9;targetName9;targetCode9

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Export value mappings to CSV format with display attributes in the header

Export value mappings to CSV format with display attributes in the header

POST request

POST response

POST example