REST API for Oracle B2C Service

Manage Named IDs

A named ID 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 accounts resource has emails, phones, and profile as named IDs. The named ID profile has Administrator, Marketing Manager, and Sales Manager as its possible values. You can use the Connect REST API to perform the following tasks:

Retrieve a List of Named IDs 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 URL

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/accounts

Example Response

{
    "emailNotification": {
        "links": [
            {
                "rel": "canonical",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/accounts/emailNotification"
            }
        ]
    },
    "emails": {
        "links": [
            {
                "rel": "canonical",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/accounts/emails"
            }
        ]
    },
    "phones": {
        "links": [
            {
                "rel": "canonical",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/accounts/phones"
            }
        ]
    },
    "profile": {
        "links": [
            {
                "rel": "canonical",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/accounts/profile"
            }
        ]
    },
    "salesSettings": {
        "links": [
            {
                "rel": "canonical",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/accounts/salesSettings"
            }
        ]
    },
    "staffGroup": {
        "links": [
            {
                "rel": "canonical",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/accounts/staffGroup"
            }
        ]
    },
    "links": [
        {
            "rel": "self",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/accounts"
        },
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/accounts"
        },
        {
            "rel": "describedby",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/namedIDs/accounts",
            "mediaType": "application/schema+json"
        }
    ]
}

View a Specific Named ID 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, profile

Request Body

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

Response Body

Returns the specific named ID of the resource.

Example URL

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/accounts/profile

Example Response

{
    "items": [
        {
            "id": 12,
            "lookupName": "Administrator",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/accounts/profile/12"
                }
            ]
        },
        {
            "id": 6,
            "lookupName": "Marketing Manager",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/accounts/profile/6"
                }
            ]
        },
        {
            "id": 7,
            "lookupName": "Sales Manager",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/accounts/profile/7"
                }
            ]
        },
        {
            "id": 10,
            "lookupName": "Sales Representative",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/accounts/profile/10"
                }
            ]
        },
        {
            "id": 8,
            "lookupName": "Service Manager",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/accounts/profile/8"
                }
            ]
        },
        {
            "id": 19,
            "lookupName": "SsoProfile",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/accounts/profile/19"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/accounts/profile"
        },
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/accounts/profile"
        },
        {
            "rel": "describedby",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/namedIDs/accounts/profile",
            "mediaType": "application/schema+json"
        }
    ]
}