Reference 360

Back Next

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

In the request header, you must specify the

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

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

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

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 version 3

Download Guide

Watch

Comments

Reference 360 Homepage

Communities

Knowledge Base

Success Portal