Reference 360

Back Next

Get code lists (v2)

Retrieves all the code lists in a reference data set based on the internal ID or alias.

GET request

To retrieve all the code lists in a reference data set based on an internal ID or alias, submit a GET request with the following URI:

/rdm-service/external/v2/rds/<rdsKey>/codelists

GET request query parameter

The following table describes the query parameter:

Parameter	Description
rdsKey	Internal ID or alias of the reference data set.

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 body:


id	String	ID of the code lists in a reference data set. For more information, see Asset IDs.
rdsDetails	Object	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 reference data set.
name	String	Name of the code list.
description	String	Optional. Description of asset.
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 code list in the reference data set.
confidentiality	String	Optional. Confidentiality of the code list in the reference data set.
priority	String	Optional. Priority of the code list in the reference data set.
status	String	Optional. Status of the code list in the reference data set.
effectiveDate	String	Optional. Date the code list in the reference data set became effective.
approvedById	String	Optional. ID of the approver of the code list in the reference data set.
approvedByName	String	Optional. User name of the user who approved the code list in the reference data set.
approvedOn	String	Optional. Date the code list in the reference data set was approved.
displayColumns	String	Optional. List of display columns used as labels for code values. Default is name .
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.

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 all the code lists in a reference data set 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/rds/rds_units/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": "e36aebf55a48d54133b9e79a",
    "rdsDetails": {
      "id": "86845d3822371e96a4dbbcbb",
      "internalId": "rds_units",
      "alias": "units",
      "name": "rds_units"
    },
    "name": "Units",
    "description": "Code list for units",
    "version": "2.0",
    "application": "UN recommendation 20",
    "hierarchical": false,
    "levels": 1,
    "displayColumns": [
      "Name"
    ]
  },
  {
    "id": "fae288a8796d3664ed7b3ffd",
    "rdsDetails": {
      "id": "86845d3822371e96a4dbbcbb",
      "internalId": "rds_units",
      "alias": "units",
      "name": "rds_units"
    },
    "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 (v2)

Get code lists (v2)

GET request

GET request query parameter

GET response

GET example