Reference 360

Back Next

Get hierarchy details

Retrieves the details of a hierarchy, such as the properties and status.

GET request

To retrieve the details of a hierarchy, submit a GET request with the following URI:

/rdm-service/external/v1/hierarchies/<hierarchy ID>

GET response

The response contains the details of the hierarchy.

The following table describes the attributes in the response:

Field	Type	Definition
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.
version	String	Optional. Version of the code list.
domain	String	Optional. Domain of the asset.
confidentiality	String	Optional. Confidentiality of the asset.
priority	String	Optional. Priority of the asset.
application	String	Optional. Application that uses the code list.
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.

GET example

To retrieve the hierarchy details, you might use the following request:

GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/hierarchies/6e7dd28fc13b417c5c19d1fb HTTP/1.1
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

The following sample response shows hierarchies:

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

{
  "id":"6e7dd28fc13b417c5c19d1fb",
  "name":"Cost centers",
  "description":"Cost center hierarchy",
  "version":"v1",
  "application":"App1",
  "domain":"Internal standards",
  "confidentiality":"private",
  "priority":"Prio1",
  "status":"Draft",
  "effectiveDate":"2017-04-01",
  "approvedOn":"2020-03-01"
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Get hierarchy details

Get hierarchy details

GET request

GET response

GET example