Reference 360

Back Next

Export hierarchies to a CSV file

Exports a hierarchy to a CSV file.

POST request

To export a hierarchy, submit a POST request with the following URI:

/rdm-service/external/v2/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 hierarchy to export:

Field	Type	Description
delimiter	String	Delimiter used to separate values. Value must be ASTERISK , CIRCUMFLEX , COLON , COMMA , PIPE , SECTION , SEMICOLON , SPACE , or TAB .
codepage	String	Code page used for the export file. Value must be UTF8 .
decimalSeparator	String	Decimal separator used for numbers. Value must be COMMA or DOT .
thousandSeparator	String	Grouping separator used for numbers. Value must be COMMA , DOT , SPACE , SINGLEQUOTE , or 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 hierarchy .
containerId	String	The ID of the hierarchy. 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.
columns	Array	Optional. Attribute columns you want to export. If you do not specify attribute columns, the export includes all attribute columns.
fieldName	String	Optional. Name of attribute column to include in the exported file.
codeListId	String	The ID of the code list associated to the attribute.
excludeParentId	Boolean	Optional. Indicates whether to include the parent ID of code values in the CSV file. Value is true or false .

POST response

The response is a CSV file. The CSV file contains two header rows followed by data rows.

The CSV file uses the following columns:

status.key

and

effectiveDate

. Based on your data model, you might have additional columns in the file.

POST example

To export the code values in a hierarchy, you might use the following request:

POST https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/export HTTP/1.1
Content-Type: application/json
Accept: application/octet-stream
Content-Length: 456
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

{
  "delimiter":"SEMICOLON",
  "codepage":"UTF8",
  "decimalSeparator":"COMMA",
  "thousandSeparator":"DOT",
  "dateFormat":"ISO",
  "filename":"testdata.csv",
  "containerType":"hierarchy",
  "containerId":"7681b69b2f02a8f81389307d",
  "columns":[
    {
      "fieldName":"Name",
      "codeListId":"5495ed772814d1a29c588599"
    },
    {
      "fieldName":"Code",
      "codeListId":"5495ed772814d1a29c588599"
    }
  ],
  "excludeParentId":false
}

To export code values with

in the Name attribute, you might use the following request:

POST https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/export HTTP/1.1
Content-Type: application/json
Accept: application/octet-stream
Content-Length: 346
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

{
  "delimiter":"SEMICOLON",
  "codepage":"UTF8",
  "decimalSeparator":"COMMA",
  "thousandSeparator":"DOT",
  "dateFormat":"ISO",
  "filename":"testdata.csv",
  "containerType":"crosswalk",
  "containerId":"350e0fcf85d589f5578226e9",
  "filter": {
    "_and": [
      {
        "Name": {
          "_contains": "US"
        }
      }
    ]
  }
}

The following sample response shows the exported data in a CSV file:

HTTP/1.1 200 OK
Content-Disposition: attachment;filename=testdata.csv
Content-Type: application/octet-stream
Content-Length: 140

Name,Code
Name,Code
Name0,Code0
Name1,Code1
Name2,Code2
Name3,Code3
Name4,Code4
Name5,Code5
Name6,Code6
Name7,Code7
Name8,Code8
Name9,Code9

For more information about exporting filtered code values, see Exporting filtered code values.

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Export hierarchies to a CSV file

Export hierarchies to a CSV file

POST request

POST response

POST example