ServiceNow Categories API

openapi: 3.2.0
info:
  title: ServiceNow Service Catalog Categories API
  description: The ServiceNow Service Catalog API provides REST endpoints for browsing catalog categories and items, retrieving catalog item details and variables, and submitting catalog requests. It enables external applications and portals to integrate with ServiceNow's self-service request capabilities including catalog browsing, cart management, and order submission.
  version: Yokohama
  contact:
    name: ServiceNow Support
    url: https://support.servicenow.com
  termsOfService: https://www.servicenow.com/terms-of-use.html
servers:
- url: https://{instance}.service-now.com/api/sn_sc
  description: ServiceNow Instance
  variables:
    instance:
      default: instance
      description: Your ServiceNow instance name
security:
- basicAuth: []
- oauth2: []
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:
    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
    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: []
  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.
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication using ServiceNow's OAuth provider.
      flows:
        password:
          tokenUrl: https://{instance}.service-now.com/oauth_token.do
          scopes: {}
externalDocs:
  description: ServiceNow Service Catalog API Documentation
  url: https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/integrate/inbound-rest/concept/c_ServiceCatalogAPI.html