Reference 360

Back Next

Get hierarchy details (v2)

Retrieves the details of a hierarchy based on the internal ID or alias.

GET request

To retrieve the details of a hierarchy based on an internal ID or alias, submit a GET request with the following URI:

/rdm-service/external/v2/hierarchies/{key}

GET request query parameters

The following table describes the parameter in the request:

Parameter	Type	Description
key	String	Internal ID or alias of the hierarchy.

GET response

The response contains the details of the hierarchy.

The following table describes the attributes in the response body:

Field	Type	Description
id	String	ID of the hierarchy. For more information, see Asset IDs.
name	String	Name of the hierarchy.
internalId	String	Unique identifier of the code list.
alias	String	Alternative identifier of the code list.
description	String	Optional. Description of the hierarchy.
version	String	Optional. Version of the hierarchy.
application	String	Optional. Application that uses the hierarchy.
domain	String	Optional. Domain of the hierarchy.
confidentiality	String	Optional. Confidentiality of the hierarchy.
priority	String	Optional. Priority of the hierarchy.
status	String	Optional. Status of the hierarchy.
effectiveDate	String	Optional. Date the hierarchy became effective.
approvedOn	String	Optional. Date the hierarchy was approved.

GET example

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

The following sample response shows the details of the hierarchy:

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

{
  "id": "640717485b243e32c4b048f9",
  "name": "Cost centers",
  "internalId": "hierarchy_internal_id",
  "alias": "hierarchy_alias",
  "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 (v2)

Get hierarchy details (v2)

GET request

GET request query parameters

GET response

GET example