Jump to

• Request
• Response
• Examples

Get a service product

get

/services/rest/connect/v1.4/serviceProducts/{id}

Request

Path Parameters

• id(required): integer
  The unique identifier of the service product.

Back to Top

Response

Default Response

Body ()

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: object namedIDs-serviceProducts-adminVisibleInterfaces
  The named ID that can be included in a list.
• categoryLinks: object serviceProducts-categoryLinks
  The category linking for a product.
• createdTime: string
  The date and time when the service product was created. This attribute is read-only.
• descriptions: 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: integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The display position of the service product relative to other products with the same parent.
• dispositionLinks: object serviceProducts-dispositionLinks
  The disposition linking for a product.
• endUserVisibleInterfaces: object namedIDs-serviceProducts-endUserVisibleInterfaces
  The named ID that can be included in a list.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the service product.
• lookupName: string
  Maximum Length: 255

  The name used to look up the service product.
• name: string
  Maximum Length: 80

  The name of the service product in the language of the current interface.
• names: 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: [ "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: 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: string
  The date and time when the service product was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the service product was last updated. This attribute is read-only."
        },
        "name":{
            "type":"string",
            "description":"The name of the service product in the language of the current interface.",
            "maxLength":"80"
        },
        "parent":{
            "type":[
                "object",
                "null"
            ],
            "description":"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."
        },
        "dispositionLinks":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The product to disposition linking.",
            "$ref":"#/definitions/serviceProducts-dispositionLinks"
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the service product.",
            "maxLength":"255"
        },
        "descriptions":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of descriptions, one for each supported language.",
            "$ref":"#/definitions/serviceProducts-descriptions"
        },
        "productHierarchy":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"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."
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the service product was created. This attribute is read-only."
        },
        "categoryLinks":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The product to category linking.",
            "$ref":"#/definitions/serviceProducts-categoryLinks"
        },
        "adminVisibleInterfaces":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of interfaces on which the category is available for administration use.",
            "$ref":"#/definitions/namedIDs-serviceProducts-adminVisibleInterfaces"
        },
        "endUserVisibleInterfaces":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of interfaces on which the category is available for end user use.",
            "$ref":"#/definitions/namedIDs-serviceProducts-endUserVisibleInterfaces"
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the service product.",
            "maximum":"9223372036854776000"
        },
        "displayOrder":{
            "minimum":"1",
            "type":"integer",
            "description":"The display position of the service product relative to other products with the same parent.",
            "maximum":"2147483647"
        },
        "names":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"The list of names, one for each supported language.",
            "$ref":"#/definitions/serviceProducts-names"
        }
    }
}

Nested Schema : namedIDs-serviceProducts-adminVisibleInterfaces

Type: object

The named ID that can be included in a list.

Show Source

• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the object. This is the key for the list entry.
• lookupName: string
  Maximum Length: 255

  The name used to look up the object.

{
    "type":"object",
    "description":"The named ID that can be included in a list.",
    "properties":{
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the object. This is the key for the list entry.",
            "maximum":"9223372036854776000"
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the object.",
            "maxLength":"255"
        }
    }
}

Nested Schema : serviceProducts-categoryLinks

Type: object

The category linking for a product.

Show Source

• serviceCategory: 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.

{
    "type":"object",
    "description":"The category linking for a product.",
    "properties":{
        "serviceCategory":{
            "type":"object",
            "description":"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: [ "string", "null" ]
  Maximum Length: 1333

  The label text.
• language: 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.

{
    "type":"object",
    "description":"The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.",
    "properties":{
        "labelText":{
            "type":[
                "string",
                "null"
            ],
            "description":"The label text.",
            "maxLength":"1333"
        },
        "language":{
            "type":"object",
            "description":"The ID of the language. This is the key for the list entry.",
            "$ref":"#/definitions/namedIDs-serviceProducts-descriptions-language"
        }
    }
}

Nested Schema : serviceProducts-dispositionLinks

Type: object

The disposition linking for a product.

Show Source

• serviceDisposition: 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.

{
    "type":"object",
    "description":"The disposition linking for a product.",
    "properties":{
        "serviceDisposition":{
            "type":"object",
            "description":"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: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the object. This is the key for the list entry.
• lookupName: string
  Maximum Length: 255

  The name used to look up the object.

{
    "type":"object",
    "description":"The named ID that can be included in a list.",
    "properties":{
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the object. This is the key for the list entry.",
            "maximum":"9223372036854776000"
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the object.",
            "maxLength":"255"
        }
    }
}

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: string
  Maximum Length: 80

  The language-specific label text. The value cannot be null or empty.
• language: 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.

{
    "type":"object",
    "description":"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.",
    "properties":{
        "labelText":{
            "type":"string",
            "description":"The language-specific label text. The value cannot be null or empty.",
            "maxLength":"80"
        },
        "language":{
            "type":"object",
            "description":"The ID of the language. This is the key for the list entry.",
            "$ref":"#/definitions/namedIDs-serviceProducts-names-language"
        }
    }
}

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

• Array of: object items

{
    "items":{
        "type":"object"
    },
    "type":"array",
    "description":"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."
}

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: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

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: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : items

Type: object

Back to Top

Examples

Use GET with the following syntax to retrieve a specific service product:

https://your_site_interface/services/rest/connect/version/serviceProducts/product_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/serviceProducts/1

Response body example

{
    "id": 1,
    "lookupName": "Mobile Phones",
    "adminVisibleInterfaces": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceProducts/1/
                 adminVisibleInterfaces"
            }
        ]
    },
    "categoryLinks": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceProducts/1/
                 categoryLinks"
            }
        ]
    },
    "descriptions": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceProducts/1/
                 descriptions"
            }
        ]
    },
    "displayOrder": 1,
    "dispositionLinks": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceProducts/1/
                 dispositionLinks"
            }
        ]
    },
    "endUserVisibleInterfaces": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceProducts/1/
                 endUserVisibleInterfaces"
            }
        ]
    },
    "name": "Mobile Phones",
    "names": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceProducts/1/names"
            }
        ]
    },
    "parent": null,
    "productHierarchy": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceProducts/1/
                 productHierarchy"
            }
        ]
    },
    "links": [
        {
            "rel": "self",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceProducts/1"
        },
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceProducts/1"
        },
        {
            "rel": "describedby",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
             serviceProducts",
            "mediaType": "application/schema+json"
        }
    ]
}

Back to Top