Reference 360

Back Next

Get hierarchy model relationships (v2)

Retrieves the relationships in a hierarchy model based on the internal ID or alias.

GET request

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

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

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 relationships and the code lists in each relationship. The

child.codeListDetails

attribute contains the top-level node relationship.

The following table describes the attributes in the response body:

Field	Type	Definition
relations	Array	Lists the code list in the relationship.
child	Object	Contains information about the child in the hierarchy model.
codeListDetails	Object	Includes details for the child code list.
id	String	ID of the child code list.
internalId	String	Unique identifier of the child code list.
alias	String	Alternative identifier of the child code list.
name	String	Name of the child code list.
rdsDetails	Object	Includes details for the child reference data set.
id	String	ID of the child reference data set. For more information, see Asset IDs.
internalID	String	Unique identifier of the child reference data set.
alias	String	Alternative identifier of the child reference data set.
name	String	Name of the child reference data set.
parent	Object	Contains information about the parent in the hierarchy model.
codeListDetails	Object	Includes details for the parent code list.
id	String	ID of the parent code list.
internalId	String	Unique identifier of the parent code list.
alias	String	Alternative identifier of the parent code list.
name	String	Name of the parent code list.
rdsDetails	Object	Includes details for the parent reference data set.
id	String	ID of the parent reference data set. For more information, see Asset IDs.
internalID	String	Unique identifier of the parent reference data set.
alias	String	Alternative identifier of the parent reference data set.
name	String	Name of the parent reference data set.

GET example

To retrieve the relationships in a hierarchy model 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/parent_codelist/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": {
        "codeListDetails": {
          "id": "b9270cec5293af42eb60fa00",
          "internalId": "parent_codelist",
          "alias": "parentcodelist",
          "name": "Parent Codelist"
        },
        "rdsDetails": {
          "id": "fa9c90dfdd269c354581807f",
          "internalId": "parent_rds",
          "alias": "parentrds",
          "name": "Reference Data Set"
        }
      }
    },
    {
      "parent": {
        "codeListDetails": {
          "id": "b9270cec5293af42eb60fa00",
          "internalId": "parent_codelist",
          "alias": "parentcodelist",
          "name": "Parent Codelist"
        },
        "rdsDetails": {
          "id": "fa9c90dfdd269c354581807f",
          "internalId": "parent_rds",
          "alias": "parentrds",
          "name": "Reference Data Set"
        }
      },
      "child": {
        "codeListDetails": {
          "id": "d1cf0227c95f4668ffcfaeda",
          "internalId": "first_level_codelist",
          "alias": "firstlevelcodelist",
          "name": "First Level Codelist"
        },
        "rdsDetails": {
          "id": "fa9c90dfdd269c354581807f",
          "internalId": "parent_rds",
          "alias": "parentrds",
          "name": "Reference Data Set"
        }
      }
    }
  ]
}

The

child.codeListDetails

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 (v2)

Get hierarchy model relationships (v2)

GET request

GET request query parameters

GET response

GET example