Managing NamedIDs

A NamedID represents a menu selection and contains the list of possible values in a menu. The namedIDs resource is a collection of menu selections of a particular resource. For example, the incidents resource has assignedTo, severity, and queue as named IDs. The named ID severity has High, Medium, and Low as its possible values.

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

Retrieving a List of NamedIDs of a Resource

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

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

Request body

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

Response body

Returns an array of named IDs of a resource.

Example request

Using GET with the following URL returns the list of named IDs for the incidents resource:

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

Example response body

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

Viewing a Specific NamedID of a Resource

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

https://your_site_interface/services/rest/connect/version/namedIDs/resource/namedID_name

The following table lists the request path parameter:

Name Description

namedID_name

Name of the named ID, for example, severity

Request body

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

Response body

Returns the specific named ID of the resource.

Example request

Using GET with the following URL returns the severity named ID of the incidents resource:
https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/severity

Example response body

{
    items: [7]
    0:  {
    id: 1
    lookupName: "High"
    links: [1]
    0:  {
    rel: "canonical"
    href: "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/severity/1"
    }-
    -
    }-
    1:  {
    id: 2
    lookupName: "Medium"
    links: [1]
    0:  {
    rel: "canonical"
    href: "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/severity/2"
    }-
    -
    }-
    2:  {
    id: 3
    lookupName: "Low"
    links: [1]
    0:  {
    rel: "canonical"
    href: "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/severity/3"
    }-
    -
    }-
    3
    {
    ...
    }
    }-
    -
    links: [4]
    0:  {
    rel: "self"
    href: "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/severity"
    }-
    1:  {
    ...
    }-
    -
}