Reference 360 > Reference 360 REST API > export version 3

export version 3

Use this resource to export code values in a code list and value mappings in a crosswalk at a point in time to JSON and CSV formats.

Export code lists at a point in time to JSON format

Exports the code values in a code list at a point in time to the JSON format.

POST request

To export code values in a code list, submit a POST request with the following URI:

/rdm-service/external/v3/export

Note: In the request header, you must specify the Accept attribute to application/json.

Use the following parameters in the request body to specify the code list to export:

Field	Type	Description
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.
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 for export version 2 and 3.
excludeParentId	Boolean	Optional. Indicates whether to include the parent ID of code values in the JSON 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.
sort	Array	Optional. Sort criteria for exporting sorted code values. Values must be comma-separated field names prefixed with their sort directions. The plus symbol (+) indicates ascending order, and the minus symbol (-) indicates descending order. For example, "_sort": ["+Name","-Code"] indicates to sort the names in the ascending order and codes in the descending order.
pit	String	Optional. Date to retrieve the point in time information about the code list. Use the ISO format: yyyy-mm-dd.
addLabelsForReferenceAttribute	Boolean	Optional. Displays values for reference and dependent attributes based on the display attributes of reference and dependent code lists, respectively.
includeMetadataAttributes	Boolean	Optional. Indicates whether to include metadata of the code list in the JSON format. Default is false.

POST response

The response is in the JSON format.

Note: When you export code values in a code list, the API response does not include the code values that do not contain relationships. The number of exported code values might result in mismatch with the number of imported code values.

POST example

To export the code values in a code list at a point in time, 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/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
Content-Length: 356

{
"dateFormat": "ISO",
"containerType": "codelist",
"containerId": "3dac5bc1b65697fba1ccf8f4",
"filter": {
"_and": [
{
"Name": {
"_eq": "Global Business Services"
}
}
]
},
"excludeParentId": false,
"pageSize": 10000,
"page": 0,
"sort": [
"+Name",
"+Code"
],
"pit": "2022-08-12",
"repeatHeaders": false,
"addLabelsForReferenceAttribute": true,
"includeMetadataAttributes": true
}

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

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 426

{
"pageSize": 10,
"page": 0,
"totalNumberOfElements": 1,
"numberOfElements": 1,
"lastPage": true,
"firstPage": true,
"content": [
{
"Code": "GBS",
"_meta": {
"lastUpdateDate": "2024-09-02",
"creationDate": "2024-09-02",
"parentRelUpdatedBy": "",
"parentRelLastUpdateDate": "",
"createdBy": "user_10_24",
"updatedBy": "user_10_24"
},
"fields": {
"Description": "Description for GBS",
"GeoRefAttr": "GER",
"GeoRefAttr.label": "GERMANY-GER-GERMANYDESC",
"Code": "GBS",
"Name": "Global Business Services",
"Business ID": "RDM0000123"
}
}
]
}

Export code lists at point in time to CSV format

Exports the code values in a code list at a point in time to the CSV format.

POST request

To export code values in a code list, submit a POST request with the following URI:

/rdm-service/external/v3/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	Optional. Delimiter used to separate values. Value must be ASTERISK, CIRCUMFLEX, COLON, COMMA, PIPE, SECTION, SEMICOLON, SPACE or TAB. Default is COMMA.
codepage	String	Optional. 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 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 for export version 2 and 3.
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 code values 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.
sort	Array	Optional. Sort criteria for exporting sorted code values. Values must be comma-separated field names prefixed with their sort directions. The plus symbol (+) indicates ascending order, and the minus symbol (-) indicates descending order. For example, "_sort": ["+Name","-Code"] indicates to sort the names in the ascending order and codes in the descending order.
pit	String	Optional. Date to retrieve the point in time information about the code list. Use the ISO format: yyyy-mm-dd.
repeatHeaders	Boolean	Optional. Indicates whether to populate headers in the CSV response. Value is true or false. Default is true.
addLabelsForReferenceAttribute	Boolean	Optional. Displays values for reference and dependent attributes based on the display attributes of reference and dependent code lists, respectively.
includeMetadataAttributes	Boolean	Optional. Indicates whether to include metadata of the code list in the CSV format. Default is false.

POST response

The response is a CSV file.

POST example

To export the code values in a code list at a point in time, 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: 580

{
"delimiter":"COMMA",
"codepage":"UTF8",
"decimalSeparator":"COMMA",
"thousandSeparator":"DOT",
"dateFormat":"ISO",
"filename":"testdata.csv",
"containerType":"codelist",
"containerId":"f6770b657b381038f9e9db3c",
"filter":{
"_and":[
{
"Name":{
"_eq":"ABC University"
}
}
]
},
"columns":[
{
"fieldName":"Name"
},
{
"fieldName":"Code"
},
{
"fieldName":"Business ID"
}
],
"excludeParentId":false,
"pageSize":10000,
"page":0,
"sort":[
"+Name",
"+Code"
],
"pit":"2022-08-12",
"repeatHeaders":false,
"addLabelsForReferenceAttribute":true,
"includeMetadataAttributes": false
}

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

Export value mappings at a point in time to JSON format

Exports the value mappings in a crosswalk at a point in time to the JSON format.

POST request

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

/rdm-service/external/v3/export

Note: In the request header, you must specify the Accept attribute to application/json.

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

Field	Type	Description
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.
containerType	String	Type of asset that contains code values. Value must be crosswalk.
containerId	String	ID of the crosswalk. 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.
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	Date to retrieve the point in time information about the crosswalk. Use the ISO format: yyyy-mm-dd.

POST response

The response is in the JSON format.

POST example

To export the value mappings in a crosswalk at a point in time, you might use the following request:

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

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 366

{
"pageSize":2,
"page":0,
"totalNumberOfElements":2,
"numberOfElements":2,
"lastPage":true,
"firstPage":true,
"content":[
{
"fields":{
"toCode":"DEU",
"fromCode":"DE"
},
"sourcePKey":"DE_DEU"
},
{
"fields":{
"toCode":"AFG",
"fromCode":"AF"
},
"sourcePKey":"AF_AFG"
}
]
}

Export value mappings at a point in time to CSV format

Exports the value mappings in a crosswalk at a point in time to the CSV format.

POST request

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

/rdm-service/external/v3/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 crosswalk to export:

Field	Type	Description
delimiter	String	Optional. Delimiter used to separate values. Value must be ASTERISK, CIRCUMFLEX, COLON, COMMA, PIPE, SECTION, SEMICOLON, SPACE or TAB. Default is COMMA.
codepage	String	Optional. 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 code values. Value must be crosswalk.
containerId	String	ID of the crosswalk. 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.
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	Date to retrieve the point in time information about the crosswalk. Use the ISO format: yyyy-mm-dd.
repeatHeaders	Boolean	Indicates whether to populate headers in the CSV response.

POST response

The response is in the CSV format.

POST example

To export the value mappings in a crosswalk at a point in time, you might use the following request:

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: 578

sourcePKey,_from.id.sourcePKey,_to.id.sourcePKey
sourcePKey,_from.id.sourcePKey,_to.id.sourcePKey
sourceCode0_targetCode0,sourceCode0,targetCode0
sourceCode1_targetCode1,sourceCode1,targetCode1
sourceCode2_targetCode2,sourceCode2,targetCode2
sourceCode3_targetCode3,sourceCode3,targetCode3
sourceCode4_targetCode4,sourceCode4,targetCode4
sourceCode5_targetCode5,sourceCode5,targetCode5
sourceCode6_targetCode6,sourceCode6,targetCode6
sourceCode7_targetCode7,sourceCode7,targetCode7
sourceCode8_targetCode8,sourceCode8,targetCode8
sourceCode9_targetCode9,sourceCode9,targetCode9

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

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 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. 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.
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 outgoing crosswalk mappings to CSV format

Exports outgoing crosswalk value mappings to CSV format.

POST request

To export outgoing crosswalk value mappings, submit a POST request with the following URI:

/rdm-service/external/v3/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 outgoing 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 outgoing value mappings from a codelist. Value must be codelist_crosswalk.
containerId	String	ID of the codelist from which the outgoing crosswalks must be exported. 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.
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 outgoing to export outgoing 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 outgoing 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: 888

{
"delimiter":"COMMA",
"codepage":"UTF8",
"decimalSeparator":"COMMA",
"thousandSeparator":"DOT",
"dateFormat":"ISO",
"filename":"testdata.csv",
"containerType":"codelist_crosswalk",
"containerId":"26ab763d543b157a4b12097f",
"columns":[
{
"fieldName":"Name"
},
{
"fieldName":"Code"
}
],
"excludeParentId":false,
"pageSize":10000,
"page":0,
"pit":"2021-10-13",
"repeatHeaders":false,
"direction":"outgoing",
"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,OutgoingCodelist1Name,OutgoingCodelist2Name
codelistCode0,outgoingCodelist1Code0|outgoingCodelist1Code1,outgoingCodelist2Code0
codelistCode1,outgoingCodelist1Code1|outgoingCodelist1Code2,outgoingCodelist2Code1
codelistCode2,outgoingCodelist1Code2|outgoingCodelist1Code3,outgoingCodelist2Code2
codelistCode3,outgoingCodelist1Code3|outgoingCodelist1Code4,outgoingCodelist2Code3
codelistCode4,outgoingCodelist1Code4|outgoingCodelist1Code5,outgoingCodelist2Code4
codelistCode5,outgoingCodelist1Code5|outgoingCodelist1Code6,outgoingCodelist2Code5
codelistCode6,outgoingCodelist1Code6|outgoingCodelist1Code7,outgoingCodelist2Code6
codelistCode7,outgoingCodelist1Code7|outgoingCodelist1Code8,outgoingCodelist2Code7
codelistCode8,outgoingCodelist1Code8|outgoingCodelist1Code9,outgoingCodelist2Code8
codelistCode9,outgoingCodelist1Code9|outgoingCodelist1Code10,outgoingCodelist2Code9

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

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 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. 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.
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

Export value mappings to CSV format with codelist names in the header

Export value mappings to CSV format with codelist names in the header.

POST request

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

/rdm-service/external/v3/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 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. 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.
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.
useAssetNameInHeader	Boolean	Indicates to use the AssetName attribute in the header. Value must be true.

POST response

The response is a CSV file.

POST example

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

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

Filter criteria for export version 2 and 3

You can export a filtered set of code values in a code list.

You can only filter values in the code attribute or values in attributes that are configured as display attributes. For example, you might want to filter values with 001 in the code attribute.

Supported filter operators and filter values for different field types

The filter operators depend on the field type of the attribute.

The following table describes the filter operators supported for each field type:

Field Type	Supported Filter Operators	Filter Values
Boolean	_eq (equal to) _ne (not equal to) _or (or) _and (and)	Boolean
Decimal or Integer	_eq (equal to) _ne (not equal to) _gt (greater than) _gte (greater than or equal to) _lt (less than) _lte (less than or equal to) _or (or) _and (and)	Number
String	_eq (equal to) _ne (not equal to) _or (or) _and (and)	Text
Date	_eq (equal to) _ne (not equal to) _or (or) _and (and)	ISO 8601 date or date and time For example, 2019-12-24 or 2019-12-15T14:17:04Z.
Reference Data	_eq (equal to) _ne (not equal to) _in (in) _or (or) _and (and)	Values in the Code attribute or values in the display attributes for the reference data.

Filter examples

To filter assets with fields that are equal to NY, you can use the following filter operator:

{
"state":{
"_eq":"NY"
}
}

To filter assets with fields that are not equal to NY, you can use the following filter operator:

{
"state":{
"_ne":"NY"
}
}

To filter assets with number fields that are greater than 68, you can use the following filter operator:

{
"age":{
"_gt":68
}
}

To filter assets with number fields that are greater than or equal to 68, you can use the following filter operator:

{
"age":{
"_gte":68
}
}

To filter assets with number fields that are less than 68, you can use the following filter operator:

{
"age":{
"_lt":68
}
}

To filter assets with number fields that are less than or equal to 68, you can use the following filter operator:

{
"age":{
"_lte":68
}
}

To filter assets with fields that match any of the specified values, you can use the following filter operator:

{
"state":{
"_in":[
"NY",
"CA"
]
}
}

To filter assets with fields that match all the specified values, you can use the following filter operator:

{
"_and":[
{
"state":"CA"
},
{
"age":68
}
]
}

To filter assets with fields that match at least one of the specified values, you can use the following filter operator:

{
"_or":[
{
"state":"CA"
},
{
"age":68
}
]
}

When you use a comma in the code, the comma acts like an _and operator. For example, the following code filters the state "NY" and people of age "68":

{
{
"state":"NY"
},
{
"age":68
}
}