REST API for Oracle B2C Service

Get a service category

get

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

Request

Path Parameters

id: integer

The unique identifier of the service category.

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.

{
    "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.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the service category was last updated. This attribute is read-only."
        },
        "name":{
            "type":"string",
            "description":"The name of the service category in the language of the current interface. This attribute is read-only.",
            "maxLength":80
        },
        "parent":{
            "type":[
                "object",
                "null"
            ],
            "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."
        },
        "categoryHierarchy":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "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 resources."
        },
        "productLinks":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The category to product linking.",
            "$ref":"#/definitions/serviceCategories-productLinks"
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the service category.",
            "maxLength":255
        },
        "descriptions":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of descriptions, one for each supported language.",
            "$ref":"#/definitions/serviceCategories-descriptions"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the service category was created. This attribute is read-only."
        },
        "adminVisibleInterfaces":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of interfaces on which the category is available for administration use.",
            "$ref":"#/definitions/namedIDs-serviceCategories-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-serviceCategories-endUserVisibleInterfaces"
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the service category.",
            "maximum":9.223372036854776E18
        },
        "displayOrder":{
            "minimum":1,
            "type":"integer",
            "description":"The display position of the service category relative to other categories with the same parent.",
            "maximum":2147483647
        },
        "names":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"The list of names, one for each supported language.",
            "$ref":"#/definitions/serviceCategories-names"
        }
    }
}

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.

{
    "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":9.223372036854776E18
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the object.",
            "maxLength":255
        }
    }
}

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

Array of: object items

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

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.

{
    "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-serviceCategories-descriptions-language"
        }
    }
}

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.

{
    "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":9.223372036854776E18
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the object.",
            "maxLength":255
        }
    }
}

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.

{
    "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-serviceCategories-names-language"
        }
    }
}

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.

{
    "type":"object",
    "description":"The product linking for a category or a disposition.",
    "properties":{
        "serviceProduct":{
            "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. 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

{
    "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 : 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

{
    "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 : 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 category:

https://your_site_interface/services/rest/connect/version/serviceCategories/category_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/30

Response body example

{
  "id": 30,
  "lookupName": "Information",
  "adminVisibleInterfaces": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/30/
         adminVisibleInterfaces"
      }
    ]
  },
  "categoryHierarchy": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/30/
         categoryHierarchy"
      }
    ]
  },
  "descriptions": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/30/
         descriptions"
      }
    ]
  },
  "displayOrder": 1,
  "endUserVisibleInterfaces": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/30/
         endUserVisibleInterfaces"
      }
    ]
  },
  "name": "Information",
  "names": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/30/names"
      }
    ]
  },
  "parent": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/29"
      },
      {
        "rel": "canonical",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/29"
      },
      {
        "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/30/productLinks"
      }
    ]
  },
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/30"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/30"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/serviceCategories",
      "mediaType": "application/schema+json"
    }
  ]
}