Jump to

• Request
• Response
• Examples

Get all named ID hierarchy values

get

/services/rest/connect/v1.4/namedIDHierarchies/{fullyQualifiedPath}

Request

Path Parameters

• fullyQualifiedPath(required): string
  The fully qualified path to reach a namedIDHierarchy. The path is constructed as /{resourceName}/{propertyName}.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Collection of namedIDHierarchies

Type: object

Title: Collection of namedIDHierarchies

Collection of namedIDHierarchies

Show Source

• items: array items

{
    "properties":{
        "items":{
            "items":{
                "type":"object",
                "properties":{
                    "parents":{
                        "$ref":"#/definitions/namedIDHierarchies/properties/parents"
                    },
                    "id":{
                        "$ref":"#/definitions/namedIDHierarchies/properties/id"
                    },
                    "lookupName":{
                        "$ref":"#/definitions/namedIDHierarchies/properties/lookupName"
                    }
                }
            },
            "type":"array"
        }
    },
    "type":"object",
    "description":"Collection of namedIDHierarchies",
    "title":"Collection of namedIDHierarchies"
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "items":{
        "type":"object",
        "properties":{
            "parents":{
                "$ref":"#/definitions/namedIDHierarchies/properties/parents"
            },
            "id":{
                "$ref":"#/definitions/namedIDHierarchies/properties/id"
            },
            "lookupName":{
                "$ref":"#/definitions/namedIDHierarchies/properties/lookupName"
            }
        }
    },
    "type":"array"
}

Nested Schema : items

Type: object

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object
• parents: array parents
  List of the parents of the entry, in order from root to immediate parent

{
    "type":"object",
    "properties":{
        "parents":{
            "$ref":"#/definitions/namedIDHierarchies/properties/parents"
        },
        "id":{
            "$ref":"#/definitions/namedIDHierarchies/properties/id"
        },
        "lookupName":{
            "$ref":"#/definitions/namedIDHierarchies/properties/lookupName"
        }
    }
}

Nested Schema : parents

Type: array

Maximum Length: 255

List of the parents of the entry, in order from root to immediate parent

Show Source

• Array of: object NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.
  Title: NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.

  NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.

{
    "items":{
        "type":"object",
        "$ref":"#/definitions/namedIDHierarchies-parent"
    },
    "type":"array",
    "description":"List of the parents of the entry, in order from root to immediate parent",
    "maxLength":"255"
}

Nested Schema : NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.

Type: object

Title: NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.

NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    },
    "type":"object",
    "description":"NamedID in which the ID is read-only.  Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.",
    "title":"NamedID in which the ID is read-only.  Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs."
}

Back to Top

Examples

Use GET with the following syntax to list the available named ID hierarchies for a particular resource:

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

Request URI example

The following example shows how to get the list of named ID hierarchies for the incidents resource:

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

Response body example

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

Back to Top