Reference 360

Back Next

Get reference data sets

Retrieves all the reference data sets.

GET request

To retrieve all the reference data sets, submit a GET request with the following URI:

/rdm-service/external/v1/rds

GET response

The response contains information about each reference data sets.

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.
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.
displayColumns	String	Optional. List of display columns used as labels for code values. Default is name .

GET example

To retrieve all the reference data sets, you might use the following request:

GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/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":"15d106a7905bd02a580d2b8d",
    "name":"Country",
    "description":"A Business Term named Country",
    "hierarchical":false,
    "levels":1,
    "displayColumns":[ 
      "Name"
    ]
  },
  { 
    "id":"655df89e349a7fc1c0cd5f33",
    "name":"Currency",
    "hierarchical":false,
    "levels":1,
    "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

Get reference data sets

GET request

GET response

GET example