ServiceNow Categories API

openapi: 3.1.0
info:
  title: ServiceNow Contact Aggregate Statistics Categories API
  description: 'The Contact API provides endpoints that enable you to retrieve and update Customer Service Management (CSM) contact records.


    In addition, you can generate new social media profile records when creating a contact.


    The Contact API requires the Customer Service plugin (com.sn_customerservice) and is provided within the now namespace.


    **Authentication**: Users need the `csm_ws_integration` role for full API access.

    '
  version: Zurich
  contact:
    name: ServiceNow
    url: https://docs.servicenow.com
  x-namespace: now
servers:
- url: https://{instance}.servicenow.com/api/now
  description: ServiceNow instance
  variables:
    instance:
      default: instance
      description: Your ServiceNow instance name
security:
- basicAuth: []
tags:
- name: Categories
  description: Operations for browsing catalog categories.
paths:
  /servicecatalog/categories/{sys_id}:
    get:
      operationId: getCategory
      summary: Servicenow Retrieve a Catalog Category
      description: Retrieves details for a specific catalog category including its child categories and items.
      tags:
      - Categories
      parameters:
      - $ref: '#/components/parameters/sysId'
      responses:
        '200':
          description: Successful response returning category details.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    $ref: '#/components/schemas/Category'
              examples:
                Getcategory200Example:
                  summary: Default getCategory 200 response
                  x-microcks-default: true
                  value:
                    result:
                      sys_id: '500123'
                      title: Example Title
                      description: A sample description.
                      full_description: example_value
                      subcategories:
                      - sys_id: '500123'
                        title: Example Title
        '404':
          description: Category not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Getcategory404Example:
                  summary: Default getCategory 404 response
                  x-microcks-default: true
                  value:
                    error:
                      message: example_value
                      detail: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Category:
      type: object
      description: A catalog category.
      properties:
        sys_id:
          type: string
          description: Unique identifier for the category.
          example: '500123'
        title:
          type: string
          description: The display title of the category.
          example: Example Title
        description:
          type: string
          description: A description of the category.
          example: A sample description.
        full_description:
          type: string
          description: The full description of the category.
          example: example_value
        subcategories:
          type: array
          description: Child categories.
          items:
            type: object
            properties:
              sys_id:
                type: string
              title:
                type: string
          example: []
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
              description: A human-readable error message.
            detail:
              type: string
              description: Detailed information about the error.
          example: example_value
  parameters:
    sysId:
      name: sys_id
      in: path
      required: true
      description: The unique system identifier.
      schema:
        type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Basic authentication with ServiceNow credentials. User must have the csm_ws_integration role.