Get a named ID
get
/services/rest/connect/v1.4/namedIDs/{fullyQualifiedPath}/{id}
Request
Path Parameters
-
fullyQualifiedPath(required): string
The fully qualified path to reach a namedID. The path is constructed as /{resourceName}/{propertyName}.
-
id(required): integer
The unique identifier of the object.
Response
Supported Media Types
- application/json
Default Response
Root Schema : An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Type:
object
Title:
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
Examples
Use GET with the following syntax to list the values for a specific named ID for a particular resource:
https://your_site_interface/services/rest/connect/version/namedIDs/resource/namedID_name
Request URI example
The following example shows how to get the list of values for the severity named ID in the incidents resource:
https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/severity
Response body example
{
"items": [
{
"id": 4,
"lookupName": "1 -Severe",
"links": [
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/severity/4"
}
]
},
{
"id": 5,
"lookupName": "2 - Major",
"links": [
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/severity/5"
}
]
},
{
"id": 6,
"lookupName": "3 - Minor",
"links": [
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/severity/6"
}
]
},
{
"id": 7,
"lookupName": "4 - None",
"links": [
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/severity/7"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/severity"
},
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents/severity"
},
{
"rel": "describedby",
"href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/namedIDs/incidents/severity",
"mediaType": "application/schema+json"
}
]
}