Reference 360

Back Next

Export incoming crosswalk mappings to CSV format

Exports incoming crosswalk value mappings to CSV format.

POST request

To export incoming crosswalk value mappings, 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 incoming crosswalk value mappings to export:

Field	Type	Description
Delimiter	String	Optional. Delimiter used to separate values that belong to a mapping. 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 incoming value mappings from a codelist. Value must be codelist_crosswalk .
containerId	String	ID of the codelist from which the incoming crosswalks must be exported. You can find the ID of assets in Reference 360 or use REST APIs to retrieve the IDs. For more information, see Asset IDs.
columns	Array	Optional. Attribute columns you want to export. If you do not specify attribute columns, the export includes all the attribute columns.
fieldName	String	Optional. Name of attribute column to include in the exported file.
excludeParentId	Boolean	Optional. Indicates whether to include the parent ID of value mappings in the CSV file. Value is true or false . Default is false .
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. Value is true or false . Default is true .
direction	String	Use incoming to export incoming crosswalks.
mappingDelimiter	String	Optional. Delimiter used to separate values from different mappings. Value must be COMMA , SEMICOLON , SPACE , TAB , PIPE , COLON , SECTION , CIRCUMFLEX , HYPHEN , or ASTERISK . Default is COMMA .

POST response

The response is a CSV file.

POST example

To export the incoming crosswalk value mappings, 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
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
Content-Length: 517

{
   "delimiter":"COMMA",
   "codepage":"UTF8",
   "decimalSeparator":"COMMA",
   "thousandSeparator":"DOT",
   "dateFormat":"ISO",
   "filename":"testdata.csv",
   "containerType":"codelist_crosswalk",
   "containerId":"9a34f404a1e836f3a16af3e9",
   "columns":[
      {
         "fieldName":"Name"
      },
      {
         "fieldName":"Code"
      }
   ],
   "excludeParentId":false,
   "pageSize":10000,
   "page":0,
   "pit":"2021-10-21",
   "repeatHeaders":false,
   "direction":"incoming",
   "mappingDelimiter":"PIPE"
}

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
Content-Length: 888

CodelistName,IncomingCodelist1Name,IncomingCodelist2Name
codelistCode0,incomingCodelist1Code0|incomingCodelist1Code1,incomingCodelist2Code0
codelistCode1,incomingCodelist1Code1|incomingCodelist1Code2,incomingCodelist2Code1
codelistCode2,incomingCodelist1Code2|incomingCodelist1Code3,incomingCodelist2Code2
codelistCode3,incomingCodelist1Code3|incomingCodelist1Code4,incomingCodelist2Code3
codelistCode4,incomingCodelist1Code4|incomingCodelist1Code5,incomingCodelist2Code4
codelistCode5,incomingCodelist1Code5|incomingCodelist1Code6,incomingCodelist2Code5
codelistCode6,incomingCodelist1Code6|incomingCodelist1Code7,incomingCodelist2Code6
codelistCode7,incomingCodelist1Code7|incomingCodelist1Code8,incomingCodelist2Code7
codelistCode8,incomingCodelist1Code8|incomingCodelist1Code9,incomingCodelist2Code8
codelistCode9,incomingCodelist1Code9|incomingCodelist1Code10,incomingCodelist2Code9

export version 3

Download Guide

Watch

Comments

Reference 360 Homepage

Communities

Knowledge Base

Success Portal