Managing NamedIDHierarchies

A NamedIDHierarchy is a NamedID that holds a hierarchical value. The namedIDHierarchies resource is a collection of hierarchical NamedIDs of a particular resource.

For example, source is a NamedIDHierarchy of the Organization resource with some of its possible values being CX Console and End-User pages. However, CX Console has Incident Editor, Contact Editor, and Opportunity Editor as its child values.

You can use the Connect REST API to perform the following tasks:

Retrieving a List of NamedIDHierarchies 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/resource

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 request

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

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

Example response body

{
    items: [1]
    0: {
    name: "source"
    links: [1]
    0: {
    rel: "canonical"
    href: "https://mysite.example.com/services/rest/connect/v1.4/namedIDHierarchies/incidents/source"
    }-
    -
    }-
    -
    links: [4]
    0: {
    rel: "self"
    href: "https://mysite.example.com/services/rest/connect/v1.4/namedIDHierarchies/namedIDHierarchies/incidents"
    }-
    1: {
    rel: "canonical"
    href: "https://mysite.example.com/services/rest/connect/v1.4/namedIDHierarchies/namedIDHierarchies/incidents"
    }-
    2: {
    ...
	}-
    -
}

Viewing a Specific NamedIDHierarchy 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 request

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

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

Example response body

{
    items: [170]
    0:{
    id: 32001
    lookupName: "Management & Config"
    parents: [1]
    0:  {
    id: null
    lookupName: null
    }-
    -
    }-
    1: {
    id: 32002
    lookupName: "CX Console"
    parents: [1]
    0: {
    id: null
    lookupName: null
    }-
    -
    }-
    3: {
    id: 32004
    lookupName: "End-User pages"
    parents: [1]
    0:  {
    id: null
    lookupName: null
    }-
    -
    }-
    4: {
    id: 32005
    lookupName: "WAP"
    parents: [1]
    0: {
    id: null
    lookupName: null
    }-
    -
    }-
    5 {
    ...
    }
    ...
    18: {
    id: 1001
    lookupName: "Incident Editor"
    parents: [1]
    0:  {
    id: 32002
    lookupName: "CX Console"
    }-
    -
    ...
    72: {
    id: 3015
    lookupName: "Manual Social Escalation"
    parents: [1]
    0:  {
    id: 32004
    lookupName: "End-User pages"
    }-
    -
    }-
    ...
    169: 
    {
    ...
}