Reference 360

Back Next

Get reference data set details (v2)

Retrieves the details of a reference data set, such as the properties, status, structure definition, and attributes. You can retrieve the details of a reference data set based on the internal ID or alias.

GET request

To retrieve the details of 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>

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 the summary information and definition of the reference data set.

The following table describes the attributes in the response body:

Field	Type	Description
id	String	ID of the reference data set. For more information, see Asset IDs.
name	String	Name of the reference data set.
description	String	Optional. Description of reference data set.
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 .
internalId	String	Unique identifier of the reference data set.
alias	String	Alternative identifier of the reference data set.
defaultListDetails	Object	Includes details of the default code list for the reference data set.
id	String	ID of the default code list for the reference data set. For more information, see Asset IDs.
internalId	String	Unique identifier of the default code list for the reference data set.
alias	String	Alternative identifier of the default code list for the reference data set.
domain	String	Optional. Domain of the reference data set.
confidentiality	String	Optional. Confidentiality of the reference data set.
priority	String	Optional. Priority of the reference data set.
status	String	Optional. Status of the reference data set.
effectiveDate	String	Optional. Date the reference data set became effective.
approvedById	String	Optional. ID of the approver of the reference data set.
approvedByName	String	Optional. Username of the user who approved the reference data set.
approvedOn	String	Optional. Date the reference data set was approved.
displayColumns	String	Optional. List of display columns used as labels for code values. Default is name .
codeValueFields	Object	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	Object	Optional. Includes the definition of the asset specified as the dependency.
rdsDetails	Object	Includes details for the 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.
displayColumns	Array	Optional. Display columns used as labels for code values associated with the dependent asset.

GET example

To retrieve the details of 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 HTTP/1.1Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

The following sample response shows the details of a reference data set:

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 2752
{
  "id": "fba77ab1fdb64d78fc52efb1",
  "name": "Country",
  "description": "A Business Term named Country",
  "hierarchical": false,
  "levels": 1,
  "internalId": "rds_units",
  "alias": "units_rds",
  "defaultListDetails": {
    "id": "045e33bb684b4fcfa58c4e06",
    "internalId": "iso_units",
    "alias": "isounits"
  },
  "domain": "International standards",
  "confidentiality": "private",
  "priority": "Prio1",
  "status": "Draft",
  "effectiveDate": "2017-04-01",
  "approvedOn": "2017-03-01",
  "displayColumns": [
    "Name"
  ],
  "codeValueFields": [
    {
      "name": "Name",
      "origin": "TERM",
      "datatype": "String",
      "mandatory": true,
      "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": "Alpha2Code",
      "origin": "TERM",
      "datatype": "String",
      "mandatory": true,
      "labels": [
        {
          "language": "en",
          "value": "Alpha2Code"
        }
      ]
    },
    {
      "name": "Alpha3Code",
      "origin": "TERM",
      "datatype": "String",
      "mandatory": false,
      "labels": [
        {
          "language": "en",
          "value": "Alpha3Code"
        }
      ]
    },
    {
      "name": "RefField",
      "origin": "TERM",
      "datatype": "Reference",
      "mandatory": true,
      "relatedRdsDetails": {
        "id": "93d5f260efa741436ba60591",
        "internalId": "testexternalrdsv2_2",
        "alias": "testexternalrds_2"
      },
      "displayColumns": [
        "column1",
        "column2"
      ],
      "labels": [
        {
          "language": "en",
          "value": "RefField"
        }
      ]
    }
  ],
  "dependencyDef": {
    "rdsDetails": {
      "id": "Continent",
      "internalId": "testexternalrdsv2",
      "alias": "testexternalrds_1"
    },
    "displayColumns": [
      "Name"
    ]
  }
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Get reference data set details (v2)

Get reference data set details (v2)

GET request

GET request query parameter

GET response

GET example