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 based on identifiers, such as internal ID or alias.
Export code lists at point in time to JSON format (v4)
Exports the code values in a code list at a point in time to the JSON format based on an internal ID or alias.
POST request
To export code values in a code list based on an internal ID or alias, submit a POST request with the following URI:
/rdm-service/external/v4/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_HYPHEN. For mm-dd-yyyy format.
- US_SLASH. For mm/dd/yyyy format.
containerType
String
Type of asset that contains code values. Value must be codelist.
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 or date and time to retrieve the point in time information about the code list. Use the following ISO formats for date, and date and time:
- Date. yyyy-mm-dd
- Date and time. yyyy-mm-dd HH-mm-ss
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 based on the internal ID or alias, you might use the following request:
Export code lists at point in time to CSV format (v4)
Exports the code values in a code list at a point in time to the CSV format based on the internal ID or alias.
POST request
To export code values in a code list based on the internal ID or alias, submit a POST request with the following URI:
/rdm-service/external/v4/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_HYPHEN. For mm-dd-yyyy format.
- US_SLASH. 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.
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 or date and time to retrieve the point in time information about the code list. Use the following ISO formats for date, and date and time:
- Date. yyyy-mm-dd
- Date and time. yyyy-mm-dd HH-mm-ss
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.
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 based on the internal ID or alias, you might use the following request:
status.key;effectiveDate;Name;Code;Description;Business ID status.status.key;effectiveDate;Name;Code;Description;Business ID ;;ABC University;ABC;Description for ABC;RDM0000123
Export value mappings at point in time to JSON format (v4)
Exports the value mappings in a crosswalk at a point in time to the JSON format based on an internal ID or alias.
POST request
To export value mappings in a crosswalk based on an internal ID or alias, submit a POST request with the following URI:
/rdm-service/external/v4/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_HYPHEN. For mm-dd-yyyy format.
- US_SLASH. For mm/dd/yyyy format.
containerType
String
Type of asset that contains code values. Value must be crosswalk.
containerKey
String
Internal ID or alias of the crosswalk.
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 based on an internal ID or alias, you might use the following request:
Export value mappings at point in time to CSV format (v4)
Exports the value mappings in a crosswalk at a point in time to the CSV format based on an internal ID or alias.
POST request
To export value mappings in a crosswalk based on an internal ID or alias, submit a POST request with the following URI:
/rdm-service/external/v4/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_HYPHEN. For mm-dd-yyyy format.
- US_SLASH. 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.
containerKey
String
Internal ID or alias of the crosswalk.
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 based on the internal ID or alias, you might use the following request:
Exports incoming crosswalk value mappings to CSV format based on an internal ID or alias.
POST request
To export incoming crosswalk value mappings based on an internal ID or alias, submit a POST request with the following URI:
/rdm-service/external/v4/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 code list. Value must be codelist_crosswalk.
containerKey
String
Internal ID or alias of the code list from which the incoming crosswalks must be exported.
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 based on an internal ID or alias, 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 Content-Length: 888
CodelistName,IncomingCodelist1Name,IncomingCodelist2Name Enterprise Country;ISO Country Codes;Salesforce Country IN;ISO_IN;SF_IN DE;ISO_DE;SF_DE FR;ISO_FR;SF_FR CN;;ISO_CN;SF_CN
Export outgoing crosswalk mappings (v4)
Exports outgoing crosswalk value mappings to CSV format based on an internal ID or alias.
POST request
To export outgoing crosswalk value mappings based on an internal ID or alias, submit a POST request with the following URI:
/rdm-service/external/v4/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 code list. Value must be codelist_crosswalk.
containerKey
String
Internal ID or alias of the code list from which the outgoing crosswalks must be exported.
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 based on the internal ID or alias, 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 Content-Length: 888
CodelistName,OutgoingCodelist1Name,OutgoingCodelist2Name Salesforce Country;Enterprise Country SF_IN;IN SF_US;US SF_FR;FR
Export value mappings to CSV format with display attributes in the header (v4)
Exports the value mappings in a crosswalk to CSV format with display attributes instead of codes, in the header. Use this resource to export value mappings in a crosswalk with display attributes in the header based on an internal ID or alias.
POST request
To export value mappings in a crosswalk with display attributes in the header based on an internal ID or alias, submit a POST request with the following URI:
/rdm-service/external/v4/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.
containerKey
String
Internal ID or alias of the crosswalk.
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 based on the internal ID or alias, you might use the following request:
POST https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v4/export HTTP/1.1 Content-Type: application/json Accept: application/octet-stream Content-Length: 454
SourceCodelist Name;TargetCodelist Name Salesforce Country Name;Enterprise Country Name SF France;France SF India;India SF United States;United States
Export value mappings to CSV format with code list names in CSV header (v4)
Export value mappings to CSV format with code list names in the header based on an internal ID or alias.
POST request
To export value mappings in a crosswalk with code list names in the header based on an internal ID or alias, submit a POST request with the following URI:
/rdm-service/external/v4/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.
containerKey
String
Internal ID or alias of the crosswalk.
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 code list names in the header based on an internal ID or alias, you might use the following request:
POST https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v4/export HTTP/1.1 Content-Type: application/json Accept: application/octet-stream Content-Length: 454