Reference 360

Back Next

Get reference data sets (v2)

Retrieves all the reference data sets based on the internal ID or alias.

GET request

To retrieve all the reference data sets based on the internal ID or alias, submit a GET request with the following URI:

/rdm-service/external/v2/rds

GET response

The response contains information about each reference data sets.

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 aren't 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.
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	Array	Optional. List of display columns used as labels for code values. Default is name .

GET example

To retrieve all the reference data sets 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 HTTP/1.1
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

The following sample response shows the reference data sets:

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

[ 
  {
    "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"
    },
    "displayColumns": [
      "Name"
    ]
  },
  { 
    "id":"655df89e349a7fc1c0cd5f33",
    "name":"Currency",
    "hierarchical":false,
    "levels":1,
    "internalId": "rds_currency",
    "alias": "currency_rds",
    "domain":"International standards",
    "confidentiality":"private",
    "priority":"Prio1",
    "status":"Draft",
    "effectiveDate":"2017-04-01",
    "approvedOn":"2017-03-01",
    "displayColumns":[ 
      "Name"
    ]
  }
]

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Get reference data sets (v2)

Get reference data sets (v2)

GET request

GET response

GET example