Reference 360

Back Next

Get code list details (v2)

Retrieves the details of a code list, such as the properties, status, structure definition, and attributes based on the internal ID or alias.

GET request

To retrieve the details of a code list based on an internal ID or alias, submit a GET request with the following URI:

/rdm-service/external/v2/codelists/{codeListKey}

GET response

The response contains the details of the specified code list.

The following table describes the attributes in the response body:

Field	Type	Description
id	String	ID of the asset. For more information, see Asset IDs.
internalId	String	Unique identifier of the code list.
alias	String	Alternative identifier of the code list.
rdsDetails	-	Includes details for the reference data set.
id	String	ID of the reference data set.
internalID	String	Unique identifier of the reference data set.
alias	String	Alternative identifier of the reference data set.
name	String	Name of the code list.
description	String	Optional. Description of the code list.
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 aren't 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. User name of the user who approved the asset.
approvedOn	String	Optional. Date the asset was approved.
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.
labels	Array	Includes list of display names for the fields from the target code list.
language	String	Language in which the field name is displayed.
value	String	Value for the field.
relatedRdsDetails	Array	Includes details of the related reference data set.
id	String	ID of the reference data set. For more information, see Asset IDs.
internalId	String	Unique identifier of the reference data set.
alias	String	Alternative identifier of the reference data set.
relatedListDetails	Array	Includes details of the related code list.
id	String	ID of the code list. For more information, see Asset IDs.
internalId	String	Unique identifier of the code list.
alias	String	Alternative identifier of the code list.
displayColumns		Optional. List of display fields used as labels for the code list.
language	String	Language in which the field name is displayed.
value	String	Value for the field.
dependencyDef	-	Optional. Includes the definition of the asset specified as the dependency.
rdsDetails	-	Includes details for the reference data set.
id	String	Asset ID of the reference data set. For more information, see Asset IDs.
internalID	String	Unique identifier of the reference data set.
externalContacts	Array	Includes details of the external contacts to send notifications.
contactName	String	Name of the contact.
contactType	String	Type of contact, such as email or SMS.
contactDetail	String	Details of contact, such as email address or phone number.
externalUrls	Array	Includes details of the external URLs of the code list.
urlName	String	Name of the external URL.
urlLink	String	Link for the external URL.

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 example

To retrieve the details of a 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/sap_country 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": "e0f3e8e73466a98e71b1731b",
  "internalId": "sap_country",
  "rdsDetails": {
    "id": "Unit Term",
    "internalId": "unit_term",
    "alias": "units"
  },
  "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,
      "labels": [
        {
          "language": "en",
          "value": "Name"
        }
      ]
    },
    {
      "name": "Code",
      "origin": "TERM",
      "datatype": "String",
      "mandatory": true,
      "labels": [
        {
          "language": "en",
          "value": "Code"
        }
      ]
    },
    {
      "name": "Description",
      "origin": "TERM",
      "datatype": "String",
      "mandatory": false,
      "labels": [
        {
          "language": "en",
          "value": "Description"
        }
      ]
    },
    {
      "name": "refField2",
      "origin": "CODELIST",
      "datatype": "Reference",
      "mandatory": true,
      "relatedRdsDetails": {
        "id": "907cea2cca037950cd1ad67a",
        "internalId": "relSetInternalId2",
        "alias": "relSetAliasId2"
      },
      "relatedListDetails": {
        "id": "5449217342ac9d487f389b47",
        "internalId": "relListInternalId2",
        "alias": "relListAliasId2"
      },
      "displayColumns": [
        "column5"
      ],
      "labels": [
        {
          "language": "en",
          "value": "refField2"
        }
      ]
    },
    {
      "name": "achronym",
      "origin": "CODELIST",
      "datatype": "String",
      "mandatory": false,
      "labels": [
        {
          "language": "en",
          "value": "achronym"
        }
      ]
    }
  ],
  "dependencyDef": {
    "rdsDetails": {
      "id": "UnitSystemTerm",
      "internalId": "unitsystemterm",
      "alias": "unit_system_term"
    },
    "codeListDetails": {
      "id": "UnitSystems",
      "internalId": "unitsystems",
      "alias": "unit_systems"
    },
    "displayColumns": [
      "Name"
    ]
  },
  "externalContacts": [
    {
      "contactName": "Test Name",
      "contactType": "SMS",
      "contactDetail": "+49 - 7867564543"
    },
    {
      "contactName": "Test Name1",
      "contactType": "EMAIL",
      "contactDetail": "test@info.com"
    }
  ],
  "externalUrls": [
    {
      "urlName": "TestUrlName",
      "urlLink": "https://abc.com"
    },
    {
      "urlName": "TestUrlName1",
      "urlLink": "https://abc1.com"
    }
  ]
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Get code list details (v2)

Get code list details (v2)

GET request

GET response

GET example