Create a service category
post
/services/rest/connect/v1.4/serviceCategories
Request
The hierarchical service category that provides an option to group answers and incidents for better organization and refined searching in the knowledge base.
Root Schema : serviceCategories
Type:
object
The hierarchical service category that provides an option to group answers and incidents for better organization and refined searching in the knowledge base.
Show Source
-
adminVisibleInterfaces(optional):
object namedIDs-serviceCategories-adminVisibleInterfaces
The named ID that can be included in a list.
-
categoryHierarchy(optional):
array categoryHierarchy
The hierarchical service category 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 'serviceCategories' collection. Only ID or lookupName can be provided to specify the resources.
-
createdTime(optional):
string
The date and time when the service category was created. This attribute is read-only.
-
descriptions(optional):
object serviceCategories-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 category relative to other categories with the same parent. -
endUserVisibleInterfaces(optional):
object namedIDs-serviceCategories-endUserVisibleInterfaces
The named ID that can be included in a list.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the service category. -
lookupName(optional):
string
Maximum Length:
255
The name used to look up the service category. -
name(optional):
string
Maximum Length:
80
The name of the service category in the language of the current interface. This attribute is read-only. -
names(optional):
object serviceCategories-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 category 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 'serviceCategories' collection. Only ID or lookupName can be provided to specify the resource.
-
productLinks(optional):
object serviceCategories-productLinks
The product linking for a category or a disposition.
-
updatedTime(optional):
string
The date and time when the service category was last updated. This attribute is read-only.
Nested Schema : namedIDs-serviceCategories-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 : categoryHierarchy
Type:
array
The hierarchical service category 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 'serviceCategories' collection. Only ID or lookupName can be provided to specify the resources.
Show Source
Nested Schema : serviceCategories-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-serviceCategories-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 : namedIDs-serviceCategories-endUserVisibleInterfaces
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 : serviceCategories-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-serviceCategories-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 : serviceCategories-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 : items
Type:
object
Nested Schema : namedIDs-serviceCategories-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 : namedIDs-serviceCategories-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.
Response
Default Response
Root Schema : serviceCategories
Type:
object
The hierarchical service category that provides an option to group answers and incidents for better organization and refined searching in the knowledge base.
Show Source
-
adminVisibleInterfaces(optional):
object namedIDs-serviceCategories-adminVisibleInterfaces
The named ID that can be included in a list.
-
categoryHierarchy(optional):
array categoryHierarchy
The hierarchical service category 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 'serviceCategories' collection. Only ID or lookupName can be provided to specify the resources.
-
createdTime(optional):
string
The date and time when the service category was created. This attribute is read-only.
-
descriptions(optional):
object serviceCategories-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 category relative to other categories with the same parent. -
endUserVisibleInterfaces(optional):
object namedIDs-serviceCategories-endUserVisibleInterfaces
The named ID that can be included in a list.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the service category. -
lookupName(optional):
string
Maximum Length:
255
The name used to look up the service category. -
name(optional):
string
Maximum Length:
80
The name of the service category in the language of the current interface. This attribute is read-only. -
names(optional):
object serviceCategories-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 category 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 'serviceCategories' collection. Only ID or lookupName can be provided to specify the resource.
-
productLinks(optional):
object serviceCategories-productLinks
The product linking for a category or a disposition.
-
updatedTime(optional):
string
The date and time when the service category was last updated. This attribute is read-only.
Nested Schema : namedIDs-serviceCategories-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 : categoryHierarchy
Type:
array
The hierarchical service category 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 'serviceCategories' collection. Only ID or lookupName can be provided to specify the resources.
Show Source
Nested Schema : serviceCategories-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-serviceCategories-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 : namedIDs-serviceCategories-endUserVisibleInterfaces
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 : serviceCategories-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-serviceCategories-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 : serviceCategories-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 : items
Type:
object
Nested Schema : namedIDs-serviceCategories-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 : namedIDs-serviceCategories-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 POST with the following syntax to create a new service category object:
https://your_site_interface/services/rest/connect/version/serviceCategories
Request URI example
https://mysite.example.com/services/rest/connect/v1.4/serviceCategories
Request body example
{
"names": [
{
"labelText": "Returns",
"language":
{
"id":1
}
},
{
"labelText": "Retours",
"language":
{
"id":8
}
}
],
"parent":
{
"id":32
}
}
Note:
Thenames
array is required for service categories. It contains a list of names, one for each supported language.
Response body example
{
"id": 68,
"lookupName": "Returns",
"adminVisibleInterfaces": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/68/adminVisibleInterfaces"
}
]
},
"categoryHierarchy": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/68/categoryHierarchy"
}
]
},
"descriptions": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/68/descriptions"
}
]
},
"displayOrder": 2,
"endUserVisibleInterfaces": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/68/endUserVisibleInterfaces"
}
]
},
"name": "Returns",
"names": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/68/names"
}
]
},
"parent": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/32"
},
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/32"
},
{
"rel": "describedby",
"href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/serviceCategories",
"mediaType": "application/schema+json"
}
]
},
"productLinks": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/68/productLinks"
}
]
},
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/68"
},
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/68"
},
{
"rel": "describedby",
"href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/serviceCategories",
"mediaType": "application/schema+json"
}
]
}