Reference 360

Back Next

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

In the request header, you must specify the

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

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

Download Guide

Watch

Comments

Reference 360 Homepage

Communities

Knowledge Base

Success Portal