Get all named ID values
get
/services/rest/connect/v1.4/namedIDs/{fullyQualifiedPath}
Request
Path Parameters
-
fullyQualifiedPath: string
The fully qualified path to reach a namedID. The path is constructed as /{resourceName}/{propertyName}.
Response
Supported Media Types
- application/json
Default Response
Root Schema : Collection of namedIDs
Type:
object
Title:
Collection of namedIDs
Collection of namedIDs
Show Source
Nested Schema : items
Type:
Show Source
object
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Examples
Use GET with the following syntax to list the available named IDs for a particular resource:
https://your_site_interface/services/rest/connect/version/namedIDs/resource
Request URI example
The following example shows how to get the list of named IDs for the incidents resource:
https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents
Response body example
{
"assignedTo": {
"links": [
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/assignedTo"
}
]
},
"banner": {
"links": [
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/banner"
}
]
},
"billedMinutes": {
"links": [
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/billedMinutes"
}
]
},
"channel": {
"links": [
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/channel"
}
]
},
"chatQueue": {
"links": [
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/chatQueue"
}
]
},
"language": {
"links": [
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/language"
}
]
},
"mailing": {
"links": [
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/mailing"
}
]
},
"milestoneInstances": {
"links": [
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/milestoneInstances"
}
]
},
"queue": {
"links": [
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/queue"
}
]
},
"responseEmailAddressType": {
"links": [
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/responseEmailAddressType"
}
]
},
"severity": {
"links": [
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/severity"
}
]
},
"sLAInstance": {
"links": [
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/sLAInstance"
}
]
},
"statusWithType": {
"links": [
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/statusWithType"
}
]
},
"threads": {
"links": [
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/threads"
}
]
},
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents"
},
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents"
},
{
"rel": "describedby",
"href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/namedIDs/incidents",
"mediaType": "application/schema+json"
}
]
}