Reference 360

Back Next

Get hierarchy model relationships (v1)

Retrieves the relationships in a hierarchy model.

GET request

To retrieve the relationships in a hierarchy model, submit a GET request with the following URI:

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

GET response

The response contains the relationships and the code lists in each relationship. The

child.codeListId

attribute contains the top-level node relationship.

The following table describes the attributes in the response:

Field	Type	Definition
relations	-	Lists the code list in the relationship.
child	-	Contains information about the child code list.
parent	-	Contains information about the parent code list.
codeListId	String	ID of the code list.
codeListName	String	Name of the code list.
termId	String	ID of the reference data set to which the code list is associated.
termName	String	Name of the reference data set.

GET example

To retrieve the relationships in a hierarchy model, you might use the following request:

GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/hierarchies/6e7dd28fc13b417c5c19d1fb/relations 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: 452

{
  "relations":[
    {
      "child":{
        "codeListId":"8bc955e614df2040968e9d85",
        "codeListName":"Parent Codelist",
        "termId":"28a1320fe7f63cd25b58bef4",
        "termName":"Reference Data Set"
      }
    },
    {
      "parent":{
        "codeListId":"8bc955e614df2040968e9d85",
        "codeListName":"Parent Codelist",
        "termId":"28a1320fe7f63cd25b58bef4",
        "termName":"Reference Data Set"
      },
      "child":{
        "codeListId":"81a714a66863f954a9b60045",
        "codeListName":"First Level Codelist",
        "termId":"28a1320fe7f63cd25b58bef4",
        "termName":"Reference Data Set"
      }
    }
  ]
}

The

child.codeListId

attribute contains the top-level node relationship. For example, the first relationship in the example is the top-level node relationship.

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Get hierarchy model relationships (v1)

Get hierarchy model relationships (v1)

GET request

GET response

GET example