openapi: 3.0.0
info:
  title: Webex Admin Address Book Business Hour API
  version: 1.0.0
  description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling.
tags:
- name: Business Hour
paths:
  /organization/{orgid}/business-hours:
    get:
      tags:
      - Business Hour
      summary: List Business Hours resource(s)
      description: "Retrieve a list of Business Hours resource(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API."
      operationId: getAllConfig_11
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: filter
        in: query
        description: "Specify a filter based on which the results will be fetched. Supported filterable fields:  id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see  <a href=\"https://www.here.com/docs/bundle/data-client-library-developer-guide-java-scala/page/client/rsql.html\">this reference</a>. For a list of supported operators, see <a href=\"https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference\">this syntax guide</a>.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n"
        required: false
        schema:
          type: string
        example: id=="2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
      - name: attributes
        in: query
        description: Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (workingHours)
        required: false
        schema:
          type: string
          format: string
        example: id
      - name: page
        in: query
        description: Defines the number of displayed page. The page number starts from 0.
        schema:
          type: integer
          default: 0
          example: 0
        example: 0
      - name: pageSize
        in: query
        description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.
        schema:
          type: integer
          default: 100
          example: 100
      - name: singleObjectResponse
        in: query
        description: Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.
        schema:
          type: boolean
          default: false
          example: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BusinessHoursDTOList'
              example:
              - organizationId: f53c8b54-46ca-43f6-ba05-08426a46e23d
                holidaysId: string
                timezone: America/New_York
                name: Agent-Profile Auto WrapUp
                description: This business hour can be set for happy hours
                createdTime: string
                lastUpdatedTime: string
                id: 93912f11-6017-404b-bf14-5331890b1797
                workingHoursCount: string
                version: 1
                overridesId: string
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
      deprecated: false
    post:
      tags:
      - Business Hour
      summary: Create a new Business Hours resource
      description: Create a new Business Hours resource in a given organization.
      operationId: createConfig_20
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessHoursDTO'
        required: true
      responses:
        '201':
          description: Created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BusinessHoursDTO'
        '400':
          description: The request was invalid and cannot be served. An accompanying error message will explain further
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '400'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '400'
                    entity: cc_user
                    references: []
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '409':
          description: Similar entity is already present
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '409'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '409'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
      deprecated: false
  /organization/{orgid}/business-hours/bulk:
    post:
      tags:
      - Business Hour
      summary: Bulk save Business Hours resource(s)
      description: Create, Update or delete Business Hours resource(s) in bulk in a given organization.
      operationId: saveAllConfig_19
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRequestDTOBusinessHoursDTO'
        required: true
      responses:
        '207':
          description: Multi-Status
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BulkResponseDTO'
        '400':
          description: The request was invalid and cannot be served. An accompanying error message will explain further
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '400'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '400'
                    entity: cc_user
                    references: []
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '409':
          description: Similar entity is already present
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '409'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '409'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
      deprecated: false
  /organization/{orgid}/business-hours/bulk-export:
    get:
      tags:
      - Business Hour
      summary: Bulk export Business Hours resource(s)
      description: Export all Business Hours resource(s) in a given organization.
      operationId: bulkExport_19
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: page
        in: query
        description: Defines the number of displayed page. The page number starts from 0.
        schema:
          type: integer
          example: 0
          default: 0
      - name: pageSize
        in: query
        description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.
        schema:
          type: integer
          example: 100
          default: 10
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BulkExportDTOBusinessHoursBulkExportDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      deprecated: true
  /organization/{orgid}/business-hours/{id}:
    get:
      tags:
      - Business Hour
      summary: Get specific Business Hours resource by ID
      description: Retrieve an existing Business Hours resource by ID in a given organization.
      operationId: getConfig_22
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: id
        in: path
        description: Resource ID of the Business Hours resource.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BusinessHoursDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
      deprecated: false
    put:
      tags:
      - Business Hour
      summary: Update specific Business Hours resource by ID
      description: Update an existing Business Hours resource by ID in a given organization.
      operationId: updateConfig_22
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: id
        in: path
        description: Resource ID of the Business Hours resource.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessHoursDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BusinessHoursDTO'
        '400':
          description: The request was invalid and cannot be served. An accompanying error message will explain further
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '400'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '400'
                    entity: cc_user
                    references: []
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '412':
          description: Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '412'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '412'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
      deprecated: false
    delete:
      tags:
      - Business Hour
      summary: Delete specific Business Hours resource by ID
      description: Delete an existing Business Hours resource by ID in a given organization.
      operationId: deleteConfig_19
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: id
        in: path
        description: Resource ID of the Business Hours resource.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '412':
          description: Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '412'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '412'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
      deprecated: false
  /organization/{orgid}/business-hours/{id}/incoming-references:
    get:
      tags:
      - Business Hour
      summary: List references for a specific Business Hours resource
      description: Retrieve a list of all entities that have reference to an existing Business Hours resource by ID in a given organization.
      operationId: getIncomingReferences_16
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: id
        in: path
        description: ID of this contact center resource.
        required: true
        schema:
          type: string
        example: af9eecc5-0472-4549-9a83-2afdae0d4ba0
      - name: type
        in: query
        description: Entity type of the other entity that has a reference to this specific entity.
        required: false
        schema:
          type: string
        example: reference-entity
      - name: page
        in: query
        description: Defines the number of displayed page. The page number starts from 0.
        schema:
          type: integer
          default: 0
          example: 0
        example: 0
      - name: pageSize
        in: query
        description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.
        schema:
          type: integer
          default: 100
          example: 100
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EntityReferenceInfoDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
      deprecated: false
  /organization/{orgid}/v2/business-hours:
    get:
      tags:
      - Business Hour
      summary: List Business Hours resource(s)
      description: "Retrieve a list of Business Hours resource(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API."
      operationId: getAllConfigWithMetaData_18
      parameters:
      - name: orgid
        in: path
        description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
      - name: filter
        in: query
        description: "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, workingHours, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see  <a href=\"https://www.here.com/docs/bundle/data-client-library-developer-guide-java-scala/page/client/rsql.html\">this reference</a>. For a list of supported operators, see <a href=\"https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference\">this syntax guide</a>.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n"
        required: false
        schema:
          type: string
        example: id=="af9eecc5-0472-4549-9a83-2afdae0d4ba0"
      - name: attributes
        in: query
        description: Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (workingHours)
        required: false
        schema:
          type: string
          format: string
        example: id
      - name: search
        in: query
        description: 'Filter data based on the search keyword.Supported search columns(name)


          The examples below show some search queries

          - "Cisco"

          - field=="name";value=="Cisco"

          - fields=in=("name");value=="Cisco"

          '
        required: false
        schema:
          type: string
        example: contact center
      - name: page
        in: query
        description: Defines the number of displayed page. The page number starts from 0.
        schema:
          type: integer
          default: 0
          example: 0
        example: 0
      - name: pageSize
        in: query
        description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.
        schema:
          type: integer
          default: 100
          example: 100
      - name: sort
        in: query
        description: "Sorting criteria in the format: property(, asc | desc). Default sort order is ascending. Supported sortable fields (name, timezone, createdTime, lastUpdatedTime). \n\n\nThe examples below show some sort queries\n- name,asc\n- timezone,desc\n"
        schema:
          type: string
          default: timeZone
          example: timeZone
      - name: includeCount
        in: query
        description: Enable the flag to get the count of workingHours
        schema:
          type: boolean
          default: false
          example: false
      - name: singleObjectResponse
        in: query
        description: Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.
        schema:
          type: boolean
          default: false
          example: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseEnvelopeBusinessHoursDTO'
              example:
                data:
                - organizationId: f53c8b54-46ca-43f6-ba05-08426a46e23d
                  holidaysId: string
                  timezone: America/New_York
                  name: Agent-Profile(Auto WrapUp)
                  description: This business hour can be set for happy hours
                  createdTime: string
                  lastUpdatedTime: string
                  id: 93912f11-6017-404b-bf14-5331890b1797
                  workingHoursCount: string
                  version: 1
                  overridesId: string
                meta:
                  additionalProp1: string
                  additionalProp2: string
                  additionalProp3: string
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '429':
          description: Too many requests have been sent in a given amount of time and the request has been rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
      deprecated: false
components:
  schemas:
    ApiErrorResponse:
      description: Response body for an API error.
      type: object
      properties:
        trackingId:
          type: string
          description: "An opaque identifier for mapping protocol failures to service internal codes. \n\nWhen specified in a request, it can be used for co-relating events across services"
          example: c1a4fcef-aee2-4dea-8977-29f594760552
        error:
          description: An object containing details about the error.
          $ref: '#/components/schemas/ErrorDetails'
    WorkingHoursDTO:
      type: object
      description: Working hours
      example:
      - name: Happy Hours
        days:
        - MON
        - TUE
        - WED
        - THU
        - FRI
        startTime: '17:00'
        endTime: '18:59'
      - name: Open Hours
        days:
        - MON
        - TUE
        - WED
        - THU
        - FRI
        - SAT
        - SUN
        startTime: '19:00'
        endTime: '23:59'
      properties:
        name:
          type: string
          maxLength: 80
          minLength: 1
          pattern: ^[a-zA-Z0-9_-]+(\s?[a-zA-Z0-9_-]+)*$
        days:
          type: array
          items:
            type: string
            enum:
            - SUN
            - MON
            - TUE
            - WED
            - THU
            - FRI
            - SAT
          minItems: 1
        startTime:
          type: string
        endTime:
          type: string
      required:
      - days
      - name
    BusinessHoursBulkExportDTO:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        timezone:
          type: string
        holidayName:
          type: string
        overrideName:
          type: string
        workingHours:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/WorkingHoursBulkExportDTO'
    WorkingHoursBulkExportDTO:
      type: object
      properties:
        workingHourName:
          type: string
          description: Name of the working hour shift.
        startTime:
          type: string
          description: Start time of the working hour shift.
        endTime:
          type: string
          description: End time of the working hour shift.
        days:
          type: array
          description: List of days for which this working hour shift is applicable.
          items:
            type: string
            description: Day of the week.
    BulkResponseItemDTO:
      type: object
      properties:
        itemIdentifier:
          type: integer
          description: Unique item identifier for a bulk operation.
          format: int32
          example: 10
        status:
          type: integer
          description: Indicates the error status code.
          format: int32
          example: 400
        operationType:
          type: string
          description: The kind of operation desired of an entity.
          example: CREATE
          enum:
          - CREATE
          - UPDATE
          - DELETE
          - GET
        href:
          type: string
          description: The resource URI of an entity.
          example: /api/organization/6705c69d-4585-42ad-bfc3-79cc485dfb15/team/7b26d174-0016-4682-9858-65918e05f85
        apiError:
          $ref: '#/components/schemas/ApiErrorResponse'
      example:
        apiError:
          error:
            key: '400'
            message:
            - description: 'siteId: not found for given orgId.'
              entity: string
              references:
              - id: string
                name: string
            reason: dependency exists
          trackingId: ccconfig_c1a4fcef-aee2-4dea-8977-29f594760552
        href: /api/organization/6705c69d-4585-42ad-bfc3-79cc485dfb15/team/7b26d174-0016-4682-9858-65918e05f85
        itemIdentifier: 10
        operationType: CREATE
        status: 400
    ErrorDetails:
      description: Details of an error.
      type: object
      properties:
        key:
          type: string
          description: An application defined error code.
          example: '401'
        message:
          type: array
          description: A message providing details about the error.
          items:
            $ref: '#/components/schemas/OperationError'
    BusinessHoursDTO:
      type: object
      properties:
        organizationId:
          type: string
          format: uuid
          description: ID of the contact center organization. This field is required for all bulk save operations.
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
          maxLength: 36
          minLength: 32
          pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$
        id:
          type: string
          description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.
          example: 93912f11-6017-404b-bf14-5331890b1797
        version:
          type: integer
          format: int32
          description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
          example: 1
        name:
          type: string
          description: Enter a name for the agent profile.
          example: Agent-Profile(Auto WrapUp)
          maxLength: 80
          minLength: 1
          pattern: ^[a-zA-Z0-9_-]+(\s?[a-zA-Z0-9_-]+)*$
        description:
          type: string
          description: (Optional) Enter a description of the profile.
          example: This business hour can be set for happy hours
          maxLength: 255
          minLength: 0
        timezone:
          type: string
          description: The time zone that you provision for your business hour.
          example: America/New_York
          minLength: 1
        workingHours:
          type: array
          description: Working hours
          example:
          - name: Happy Hours
            days:
            - MON
            - TUE
            - WED
            - THU
            - FRI
            startTime: '17:00'
            endTime: '18:59'
          - name: Open Hours
            days:
            - MON
            - TUE
            - WED
            - THU
            - FRI
            - SAT
            - SUN
            startTime: '19:00'
            endTime: '23:59'
          items:
            $ref: '#/components/schemas/WorkingHoursDTO'
          minItems: 1
          uniqueItems: true
        holidaysId:
          type: string
        overridesId:
          type: string
        workingHoursCount:
          type: integer
          format: int64
        createdTime:
          type: integer
          format: int64
          description: This is the created time of the entity.
        lastUpdatedTime:
          type: integer
          format: int64
          description: This is the updated time of the entity.
      required:
      - name
      - timezone
      - workingHours
    BusinessHoursDTOList:
      type: object
      properties:
        organizationId:
          type: string
          format: uuid
          description: ID of the contact center organization. This field is required for all bulk save operations.
          example: f53c8b54-46ca-43f6-ba05-08426a46e23d
          maxLength: 36
          minLength: 32
          pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$
        id:
          type: string
          description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.
          example: 93912f11-6017-404b-bf14-5331890b1797
        version:
          type: integer
          format: int32
          description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
          example: 1
        name:
          type: string
          description: Enter a name for the agent profile.
          example: Agent-Profile Auto WrapUp
          maxLength: 80
          minLength: 1
          pattern: ^[a-zA-Z0-9_-]+(\s?[a-zA-Z0-9_-]+)*$
        description:
          type: string
          description: (Optional) Enter a description of the profile.
          example: This business hour can be set for happy hours
          maxLength: 255
          minLength: 0
        timezone:
          type: string
          description: The time zone that you provision for your business hour.
          example: America/New_York
          minLength: 1
        holidaysId:
          type: string
          description: ID of the holiday list associated with this business hour.
        overridesId:
          type: string
          description: ID of the override associated with this business hour.
        workingHoursCount:
          type: integer
          format: int64
          description: The number of working hour shifts configured for this business hour.
        createdTime:
          type: integer
          format: int64
          description: This is the created time of the entity.
        lastUpdatedTime:
          type: integer
          format: int64
          description: This is the updated time of the entity.
    BulkRequestItemDTOBusinessHoursDTO:
      type: object
      description: List of items in the bulk request.
      properties:
        itemIdentifier:
          type: integer
          format: int32
          description: Unique item identifier for a bulk operation.
          example: 10
        item:
          $ref: '#/components/schemas/BusinessHoursDTO'
          description: The Business Hours resource for this bulk operation item.
        requestAction:
          type: string
          description: Identifier for action type. Possible values are `SAVE` and `DELETE`.
          example: SAVE
    OperationError:
      description: An error message providing details about the operation failure.
      type: object
      properties:
        description:
          type: string
          description: A human readable explanation for the occurrence of an error.
          example: Incorrect Credentials.
    ResponseEnvelopeBusinessHoursDTO:
      type: object
      properties:
        meta:
          type: object
          additionalProperties: {}
        data:
          type: array
          items:
            $ref: '#/components/schemas/BusinessHoursDTO'
    BulkExportDTOBusinessHoursBulkExportDTO:
      type: object
      properties:
        totalResources:
          type: integer
          description: Total number of items
          format: int32
          example: 100
        pageNumber:
          type: integer
          description: Current page number
          format: int32
          example: 0
        pageSize:
          type: integer
          description: Page size for current data set
          format: int32
          example: 50
        rel:
          type: string
          description: Indicates whether more pages exist. When 'next' there are more pages available, otherwise 'last'.
          example: last
        resources:
          type: array
          items:
            $ref: '#/components/schemas/BusinessHoursBulkExportDTO'
    BulkResponseDTO:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/BulkResponseItemDTO'
    BulkRequestDTOBusinessHoursDTO:
      type: object
      properties:
        items:
          type: array
          description: List of items in the bulk request.
          items:
            $ref: '#/components/schemas/BulkRequestItemDTOBusinessHoursDTO'
    MetaDataReferencesPagingInfo:
      title: MetaDataReferencesPagingInfo
      type: object
      properties:
        orgid:
          maxLength: 36
          minLength: 32
          pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$
          type: string
          description: Org ID
          format: uuid
          example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
        page:
          type: integer
          description: Current page number
          format: int32
          example: 1
        pageSize:
          type: integer
          description: Page size for current data set
          format: int32
          example: 100
        totalPages:
          type: integer
          description: Number of pages
          format: int32
          example: 1
        totalRecords:
          type: integer
          description: Total number of items
          format: int32
          example: 1000
        links:
          type: object
          description: Map of pagination links with self, next, prev, last and first
          example:
            next: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=2&pageSize=10
            last: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=3&pageSize=10
            prev: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=0&pageSize=10
            self: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=1&pageSize=10
            first: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=0&pageSize=10
        referencedEntities:
          type: array
          description: List of referenced entities
          example:
          - agent-profile
          - entrypoint
          items:
            type: string
        currentEntity:
          type: string
          description: Name of current entity
          example: entity_name
      description: Metadata of response for references with paging information
    EntityInfo:
      type: object
      properties:
        id:
          type: string
          description: id
          example: id.
        name:
          type: string
          description: name
          example: name.
        additionalAttributes:
          type: object
          additionalProperties:
            type: string
            description: A map containing additional attributes of entity where both the key and value are Strings.
            example: '{"key1":"value1","key2":"value2"}'
          description: A map containing additional attributes of entity where both the key and value are Strings.
          example:
            key1: value1
            key2: value2
        createdDate:
          type: string
        lastModifiedDate:
          type: string
        version:
          type: integer
          format: int32
    EntityReferenceInfoDTO:
      type: object
      properties:
        description:
          type: string
          description: Description about reference info.
          example: list of referenced entities
        meta:
          $ref: '#/components/schemas/MetaDataReferencesPagingInfo'
        data:
          type: array
          items:
            $ref: '#/components/schemas/EntityInfo'
  securitySchemes:
    oauth2:
      flows:
        authorizationCode:
          authorizationUrl: /
          scopes: {}
          tokenUrl: /
      type: oauth2
    bearer-key:
      type: http
      description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN
      scheme: bearer
      bearerFormat: JWT
    bearerAuth:
      type: oauth2
      description: OAuth 2.0 Bearer token authentication
      flows:
        authorizationCode:
          authorizationUrl: https://webexapis.com/v1/authorize
          tokenUrl: https://webexapis.com/v1/access_token
          scopes:
            spark:applications_token: Create access tokens for Service Apps