Reference 360

Back Next

Get code list details

Retrieves the details of a code list, such as the properties, status, structure definition, and attributes.

GET request

To retrieve the details of a code list, submit a GET request with the following URI:

/rdm-service/external/v1/codelists/<code list ID>

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 the details of the specified code list.

The following table describes the attributes in the response:

Field	Type	Description
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.
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.
defaultList	String	ID of the default code list.
displayColumns	String	Optional. List of display columns used as labels for code values. Default is name .
codeValueFields	-	Includes the attribute definition for code values in the reference data set.
name	String	Name of the field.
origin	String	Origin of the definition of the field.
datatype	String	Datatype of the field. Values are String , Integer , Decimal , Boolean , Date , or Reference .
mandatory	Boolean	Indicates whether the attribute is required.
relatedTermId	String	Optional. If the attribute datatype is Reference, lists the ID of the reference data set.
displayColumns	Array	Optional. If the attribute datatype is Reference, lists the display columns.
dependencyDef	-	Optional. Includes the definition of the asset specified as the dependency.
termId	String	Optional. ID of the asset specified as the dependency.
displayColumns	Array	Optional. Display columns used as labels for code values associated with the dependent asset.

GET example

To retrieve the details of a code list, you might use the following request:

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

The following sample response shows the details of a code list:

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

{ 
  "id":"4fb1356728272974bd46945f",
  "termId":"Unit Term",
  "name":"Units",
  "description":"Code list for units",
  "version":"2.0",
  "application":"UN recommendation 20",
  "hierarchical":false,
  "levels":1,
  "domain":"International standards",
  "confidentiality":"private",
  "priority":"Prio1",
  "status":"Draft",
  "effectiveDate":"2017-04-01",
  "approvedOn":"2017-03-01",
  "displayColumns":[ 
    "Name",
    "Code"
  ],
  "codeValueFields":[ 
    { 
      "name":"Name",
      "origin":"TERM",
      "datatype":"String",
      "mandatory":false
    },
    { 
      "name":"Code",
      "origin":"TERM",
      "datatype":"String",
      "mandatory":true
    },
    { 
      "name":"Description",
      "origin":"TERM",
      "datatype":"String",
      "mandatory":false
    },
    { 
      "name":"achronym",
      "origin":"CODELIST",
      "datatype":"String",
      "mandatory":false
    },
    { 
      "name":"refField2",
      "origin":"CODELIST",
      "datatype":"Reference",
      "mandatory":true,
      "relatedTermId":"b02c86d02ac7de3a688353dc",
      "relatedListId":"dc245266d5a61ce4d0535f74",
      "displayColumns":[ 
        "column5"
      ]
    }
  ],
  "dependencyDef":{ 
    "termId":"UnitSystem Term",
    "codelistId":"UnitSystems",
    "displayColumns":[ 
      "Name"
    ]
  }
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Get code list details

Get code list details

GET request

GET response

GET example