Table of Contents

Search

  1. Preface
  2. Introducing Reference 360
  3. Getting started with Reference 360
  4. Manage system reference data
  5. Manage reference data sets
  6. Manage code lists
  7. Manage code values
  8. Manage crosswalks
  9. Import data
  10. Manage hierarchies
  11. Manage attributes
  12. Manage workflows
  13. Manage jobs
  14. Reference 360 REST API
  15. Glossary

Reference 360

Reference 360

Export outgoing crosswalk mappings to CSV format

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

0 COMMENTS

We’d like to hear from you!