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