Reference 360

Back Next

Export code value hierarchy to JSON format (v2)

Exports the subset of code values in a hierarchical code list to a JSON file based on the internal ID or alias.

GET request

To export the subset of code values in a hierarchical code list based on an internal ID or alias, submit a GET request with the following URI:

/rdm-service/external/v2/codelists/{codeListKey}/codevalues/subset/{subsetId}/cursor?page={page}

This API supports only incremental pagination starting from page

. In the request header, you must specify the

attribute to

application/json

Use the following parameters in the request query to specify the subset of code values to export:

Field	Type	Description
codeListKey	String	Internal ID or alias of the hierarchical code list.
subSetIdentifier	String	ID of the subset.
page	Number	Page number to display. Default value is 0 .
limit	Number	Optional. Number of records to display on each page. Default value is 10000 .

GET response

The response is in JSON file.

GET example

To export the subset of code values in a hierarchical code list based on the internal ID or alias, you might use the following request:

GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/codelists/ent_country/codevalues/subset/71253be5deb0e7d4974935e0/cursor?page=0 HTTP/1.1
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

The following sample response shows the exported subset of code values in the JSON file:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 352

{
   "pageSize":2,
   "page":0,
   "numberOfElements":2,
   "content":[
      {
         "Code":"STUDENT-1001",
         "fields":{
            "Code":"STUDENT-1001",
            "Name":"ppniK"
         },
         "parentId":"UNIVERSITY-001"
      },
      {
         "Code":"UNIVERSITY-001",
         "fields":{
            "Code":"UNIVERSITY-001",
            "Name":"ABC University"
         }
      }
   ]
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Export code value hierarchy to JSON format (v2)

Export code value hierarchy to JSON format (v2)

GET request

GET response

GET example