Reference 360

Back Next

Get code lists

Retrieves all the code lists in a reference data set.

GET request

To retrieve all the code lists in a reference data set, submit a GET request with the following URI:

/rdm-service/external/v1/rds/<reference data set ID>/codelists

You can find the ID of assets in

Reference 360

or use REST APIs to retrieve the IDs. For more information, see Asset IDs.

GET response

The response contains information about the code lists in the specified reference data set.

The following table describes the attributes in the response:

Field	Type	Definition
id	String	ID of the asset. Assets include reference data sets, code lists, crosswalks, and hierarchies. For more information, see Asset IDs.
termId	String	ID of the reference data set to which the code list is associated.
name	String	Name of the asset.
description	String	Optional. Description of asset.
displayColumns	String	Optional. List of display columns used as labels for code values. Default is name .
version	String	Optional. Version of the code list.
application	String	Optional. Application that uses the code list.
hierarchical	Boolean	Optional. Indicates whether code lists in the reference data set inherit the hierarchical structure definition.
levels	Number	Optional. Number of hierarchical levels supported in the code lists associated with the reference data set. If hierarchical is false or levels are not provided, value is 1 . If levels are unlimited, value is -1 .
domain	String	Optional. Domain of the asset.
confidentiality	String	Optional. Confidentiality of the asset.
priority	String	Optional. Priority of the asset.
status	String	Optional. Status of the asset.
effectiveDate	String	Optional. Date the asset became effective.
approvedById	String	Optional. ID of the approver of the asset.
approvedByName	String	Optional. Username of the user who approved the asset.
approvedOn	String	Optional. Date the asset was approved.

GET example

To retrieve all the code lists in a reference data set, you might use the following request:

GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/rds/15d106a7905bd02a580d2b8d/codelists HTTP/1.1
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

The following sample response shows the code lists in a reference data set:

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 747

[ 
  { 
    "id":"863efc094436e68bc4299204",
    "termId":"c0af1cd77e7a1a3d658883ad",
    "name":"Units",
    "description":"Code list for units",
    "version":"2.0",
    "application":"UN recommendation 20",
    "hierarchical":false,
    "levels":1,
    "displayColumns":[ 
      "Name"
    ]
  },
  { 
    "id":"17f60eb76ebcc75fec93dadc",
    "termId":"c0af1cd77e7a1a3d658883ad",
    "name":"SAP Units",
    "description":"Code list for SAP units",
    "version":"1.1",
    "application":"SAP",
    "hierarchical":true,
    "levels":10,
    "domain":"International standards",
    "confidentiality":"private",
    "priority":"Prio1",
    "status":"Draft",
    "effectiveDate":"2017-04-01",
    "approvedOn":"2017-03-01",
    "displayColumns":[ 
      "Name",
      "Code"
    ]
  }
]

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Get code lists

Get code lists

GET request

GET response

GET example