Get a service disposition
get
/services/rest/connect/v1.4/serviceDispositions/{id}
Request
Path Parameters
-
id: integer
The unique identifier of the service disposition.
Response
Default Response
Root Schema : serviceDispositions
Type:
object
The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved.
Show Source
-
adminVisibleInterfaces(optional):
object namedIDs-serviceDispositions-adminVisibleInterfaces
The named ID that can be included in a list.
-
createdTime(optional):
string
The date and time when the service disposition was created. This attribute is read-only.
-
descriptions(optional):
object serviceDispositions-descriptions
The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.
-
displayOrder(optional):
integer
Minimum Value:
1
Maximum Value:2147483647
The display position of the service disposition relative to other dispositions with the same parent. -
dispositionHierarchy(optional):
array dispositionHierarchy
The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved. It is the reference to a resource in 'serviceDispositions' collection. Only ID or lookupName can be provided to specify the resources.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the service disposition. -
lookupName(optional):
string
Maximum Length:
255
The name used to look up the service disposition. -
name(optional):
string
Maximum Length:
80
The name of the service disposition in the language of the current interface. This attribute is read-only. -
names(optional):
object serviceDispositions-names
The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
-
parent(optional):
[
"object",
"null"
]
The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved. It is the reference to a resource in 'serviceDispositions' collection. Only ID or lookupName can be provided to specify the resource.
-
productLinks(optional):
object serviceDispositions-productLinks
The product linking for a category or a disposition.
-
updatedTime(optional):
string
The date and time when the service disposition was last updated. This attribute is read-only.
Nested Schema : namedIDs-serviceDispositions-adminVisibleInterfaces
Type:
object
The named ID that can be included in a list.
Show Source
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the object. This is the key for the list entry. -
lookupName(optional):
string
Maximum Length:
255
The name used to look up the object.
Nested Schema : serviceDispositions-descriptions
Type:
object
The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.
Show Source
-
labelText(optional):
[
"string",
"null"
]
Maximum Length:
1333
The label text. -
language(optional):
object namedIDs-serviceDispositions-descriptions-language
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.
Nested Schema : dispositionHierarchy
Type:
array
The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved. It is the reference to a resource in 'serviceDispositions' collection. Only ID or lookupName can be provided to specify the resources.
Show Source
Nested Schema : serviceDispositions-names
Type:
object
The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
Show Source
-
labelText(optional):
string
Maximum Length:
80
The language-specific label text. The value cannot be null or empty. -
language(optional):
object namedIDs-serviceDispositions-names-language
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.
Nested Schema : serviceDispositions-productLinks
Type:
object
The product linking for a category or a disposition.
Show Source
-
serviceProduct(optional):
object serviceProduct
The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceProducts' collection. Only ID or lookupName can be provided to specify the resource.
Nested Schema : namedIDs-serviceDispositions-descriptions-language
Type:
object
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(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : items
Type:
object
Nested Schema : namedIDs-serviceDispositions-names-language
Type:
object
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(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : serviceProduct
Type:
object
The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceProducts' collection. Only ID or lookupName can be provided to specify the resource.
Examples
Use GET with the following syntax to retrieve a specific service disposition:
https://your_site_interface/services/rest/connect/version/serviceDispositions/disposition_id
Request URI example
https://mysite.example.com/services/rest/connect/v1.4/serviceDispositions/38
Response body example
{
"id": 38,
"lookupName": "Satisfied",
"adminVisibleInterfaces": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/serviceDispositions/38/
adminVisibleInterfaces"
}
]
},
"descriptions": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/serviceDispositions/38/
descriptions"
}
]
},
"displayOrder": 1,
"dispositionHierarchy": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/serviceDispositions/38/
dispositionHierarchy"
}
]
},
"name": "Satisfied",
"names": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/serviceDispositions/38/names"
}
]
},
"parent": null,
"productLinks": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/serviceDispositions/38/
productLinks"
}
]
},
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/serviceDispositions/38"
},
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/serviceDispositions/38"
},
{
"rel": "describedby",
"href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/serviceDispositions",
"mediaType": "application/schema+json"
}
]
}