Manage Named ID Hierarchies

A named ID hierarchy is a named ID that holds a hierarchical value. The namedIDHierarchies resource is a collection of hierarchical named IDs of a particular resource. For example, source is a named ID hierarchy of the contacts resource with some of its possible values being CX Console and End-User pages. You can use the Connect REST API to perform the following tasks:

• Retrieve a List of Named ID Hierarchies of a Resource
• View a Specific Named ID Hierarchy of a Resource

Retrieve a List of Named ID Hierarchies of a Resource

Use the GET method with the following syntax to view the list of named ID hierarchies for a specific instance of a resource (that is, an object):

https://your_site_interface/services/rest/connect/version/namedIDHierarchies/contacts

Request Body

There are no elements in the request body for this task.

Response Body

Returns an array of named ID hierarchies of a resource.

Example URL

Using the GET method with the following URL returns the list of named ID hierarchies for the contacts resource:

https://mysite.example.com/services/rest/connect/v1.4/namedIDHierarchies/contacts

Example Response

{
    "source": {
        "links": [
            {
                "rel": "canonical",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDHierarchies/contacts/source"
            }
        ]
    },
    "links": [
        {
            "rel": "self",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDHierarchies/contacts"
        },
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDHierarchies/contacts"
        },
        {
            "rel": "describedby",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/namedIDHierarchies/contacts",
            "mediaType": "application/schema+json"
        }
    ]
}

View a Specific Named ID Hierarchy of a Resource

Use the GET method with the following syntax to view a named ID hierarchy of a specific instance of a resource (that is, an object):

https://your_site_interface/services/rest/connect/version/namedIDHierarchies/resource/namedIDHierarchy_name

The following table lists the request path parameter:

Name	Description
namedIDHierarchy_name	The name of the named ID hierarchy, for example, source.

Request Body

There are no elements in the request body for this task.

Response Body

Returns the specific named ID hierarchy of the resource.

Example URL

Using the GET method with the following URL returns the source named ID hierarchy of the contacts resource:

https://mysite.example.com/services/rest/connect/v1.4/namedIDHierarchies/contacts/source

Example Response

{
    "items": [
        {
            "id": 32001,
            "lookupName": "Management & Config",
            "parents": {
                "links": [
                    {
                        "rel": "self",
                        "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDHierarchies/contacts/source/32001/parents"
                    }
                ]
            },
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDHierarchies/contacts/source/32001"
                }
            ]
        },
        {
            "id": 32002,
            "lookupName": "CX Console",
            "parents": {
                "links": [
                    {
                        "rel": "self",
                        "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDHierarchies/contacts/source/32002/parents"
                    }
                ]
            },
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDHierarchies/contacts/source/32002"
                }
            ]
        },
        {
            "id": 32004,
            "lookupName": "End-User pages",
            "parents": {
                "links": [
                    {
                        "rel": "self",
                        "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDHierarchies/contacts/source/32004/parents"
                    }
                ]
            },
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDHierarchies/contacts/source/32004"
                }
            ]
        },
        {
            "id": 17040,
            "lookupName": "Web Console Reset Password",
            "parents": {
                "links": [
                    {
                        "rel": "self",
                        "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDHierarchies/contacts/source/17040/parents"
                    }
                ]
            },
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDHierarchies/contacts/source/17040"
                }
            ]
        },
        {
            "id": 18001,
            "lookupName": "Data Lifecycle Management Purge",
            "parents": {
                "links": [
                    {
                        "rel": "self",
                        "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDHierarchies/contacts/source/18001/parents"
                    }
                ]
            },
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDHierarchies/contacts/source/18001"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDHierarchies/contacts/source"
        },
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDHierarchies/contacts/source"
        },
        {
            "rel": "describedby",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/namedIDHierarchies/contacts/source",
            "mediaType": "application/schema+json"
        }
    ]
}