swagger: '2.0' info: description: With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more. version: v2 title: PureCloud Platform Agent Assistants Knowledge API termsOfService: https://help.genesys.cloud/articles/terms-and-conditions/ contact: name: PureCloud Developer Evangelists url: https://developer.genesys.cloud/ email: DeveloperEvangelists@genesys.com license: name: UNLICENSED url: https://help.genesys.cloud/articles/terms-and-conditions/ host: api.mypurecloud.com schemes: - https consumes: - application/json produces: - application/json tags: - name: Knowledge description: Knowledge administration and search paths: /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories: get: tags: - Knowledge summary: Get categories description: '' operationId: getKnowledgeKnowledgebaseCategories produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: before in: query description: The cursor that points to the start of the set of entities that has been returned. required: false type: string - name: after in: query description: The cursor that points to the end of the set of entities that has been returned. required: false type: string - name: pageSize in: query description: Number of entities to return. Maximum of 200. required: false type: string - name: parentId in: query description: If specified, retrieves the children categories by parent category ID. required: false type: string - name: isRoot in: query description: If specified, retrieves only the root categories. required: false type: boolean - name: name in: query description: Filter to return the categories that starts with the given category name. required: false type: string - name: sortBy in: query description: 'Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically' required: false type: string default: Name enum: - Name - Hierarchy - name: expand in: query description: 'The specified entity attribute will be filled. Supported value:"Ancestors": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors.' required: false type: string - name: includeDocumentCount in: query description: If specified, retrieves the number of documents related to category. required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/CategoryResponseListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:category:view x-purecloud-method-name: getKnowledgeKnowledgebaseCategories post: tags: - Knowledge summary: Create new category description: '' operationId: postKnowledgeKnowledgebaseCategories produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/CategoryCreateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/CategoryResponse' '201': description: Category created schema: $ref: '#/definitions/CategoryResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: parent.category.not.found: Parent category does not exist bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' limit.reached: Total number, maximum child or maximum depth limit has been reached. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. already.exists: Category with same name already exists '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:category:add x-purecloud-method-name: postKnowledgeKnowledgebaseCategories /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}: get: tags: - Knowledge summary: Get category description: '' operationId: getKnowledgeKnowledgebaseCategory produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: categoryId in: path description: Category ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CategoryResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:category:view x-purecloud-method-name: getKnowledgeKnowledgebaseCategory delete: tags: - Knowledge summary: Delete category description: '' operationId: deleteKnowledgeKnowledgebaseCategory produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: categoryId in: path description: Category ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CategoryResponse' '204': description: Category deleted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable constraint.validation: Input parameters do not match the required criteria '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:category:delete x-purecloud-method-name: deleteKnowledgeKnowledgebaseCategory patch: tags: - Knowledge summary: Update category description: '' operationId: patchKnowledgeKnowledgebaseCategory produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: categoryId in: path description: Category ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/CategoryUpdateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/CategoryResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.parent.category: Subcategory cannot be the parent category. parent.category.not.found: Parent category does not exist bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' limit.reached: Maximum child or maximum depth limit has been reached. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. already.exists: Category with same name already exists '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:category:edit x-purecloud-method-name: patchKnowledgeKnowledgebaseCategory /api/v2/knowledge/integrations/{integrationId}/options: get: tags: - Knowledge summary: Get sync options available for a knowledge-connect integration description: '' operationId: getKnowledgeIntegrationOptions produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string - name: knowledgeBaseIds in: query description: Narrowing down filtering option results by knowledge base. required: false type: array items: type: string collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeIntegrationOptionsResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Input parameters do not match the required criteria. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable third.party.unknown.host: 'Request to third party service failed: unknown host.' invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] invalid.integration: The provided integration is not active. constraint.validation: '%s' third.party.invalid.credentials: 'Request to third party service failed: invalid credentials.' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Integration or Credential not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: third.party.unexpected.error: 'Request to third party service failed: unexpected error.' internal.dependency.error: Internal dependency error. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:integrationOptions:view x-purecloud-method-name: getKnowledgeIntegrationOptions /api/v2/knowledge/knowledgebases/{knowledgeBaseId}: get: tags: - Knowledge summary: Get knowledge base description: '' operationId: getKnowledgeKnowledgebase produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeBase' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' input.validations: Input paramaters do not match the required criteria invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. kb.not.found: Knowledge Base does not exist '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:knowledgebase:view x-purecloud-method-name: getKnowledgeKnowledgebase delete: tags: - Knowledge summary: Delete knowledge base description: '' operationId: deleteKnowledgeKnowledgebase produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeBase' '204': description: Knowledge base deleted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable input.validations: Input paramaters do not match the required criteria '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledgebase not found not.found: The requested resource was not found. kb.not.found: Knowledge Base does not exist '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. knowledgebase.in.use: knowledgebase in use by bot flow '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '424': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.bot.flow.status.unknown: Knowledgebase bot flow status unknown security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:knowledgebase:delete x-purecloud-method-name: deleteKnowledgeKnowledgebase patch: tags: - Knowledge summary: Update knowledge base description: '' operationId: patchKnowledgeKnowledgebase produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/KnowledgeBaseUpdateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeBase' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. input.validations: Input paramaters do not match the required criteria invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. kb.not.found: Knowledge Base does not exist '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:knowledgebase:edit x-purecloud-method-name: patchKnowledgeKnowledgebase /api/v2/knowledge/knowledgebases: get: tags: - Knowledge summary: Get knowledge bases description: '' operationId: getKnowledgeKnowledgebases produces: - application/json parameters: - name: before in: query description: The cursor that points to the start of the set of entities that has been returned. required: false type: string - name: after in: query description: The cursor that points to the end of the set of entities that has been returned. required: false type: string - name: limit in: query description: Number of entities to return. Maximum of 100. Deprecated in favour of pageSize required: false type: string - name: pageSize in: query description: Number of entities to return. Maximum of 100. required: false type: string - name: name in: query description: Filter by Name. required: false type: string - name: coreLanguage in: query description: Filter by core language. required: false type: string enum: - en-US - en-UK - en-AU - en-CA - en-HK - en-IN - en-IE - en-NZ - en-PH - en-SG - en-ZA - de-DE - de-AT - de-CH - es-AR - es-CO - es-MX - es-US - es-ES - fr-FR - fr-BE - fr-CA - fr-CH - pt-BR - pt-PT - nl-NL - nl-BE - it-IT - ca-ES - tr-TR - sv-SE - fi-FI - nb-NO - da-DK - ja-JP - ar-AE - zh-CN - zh-TW - zh-HK - ko-KR - pl-PL - hi-IN - th-TH - hu-HU - vi-VN - uk-UA - cs-CZ - fil-PH - ms-MY - he-IL - el-GR - name: published in: query description: Filter by published status. required: false type: boolean - name: sortBy in: query description: Sort by. required: false type: string enum: - Name - Date - name: sortOrder in: query description: Sort Order. required: false type: string enum: - ASC - ascending - DESC - descending responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeBaseListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' input.validations: Input parameters do not match the required criteria invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:knowledgebase:view x-purecloud-method-name: getKnowledgeKnowledgebases post: tags: - Knowledge summary: Create new knowledge base description: '' operationId: postKnowledgeKnowledgebases produces: - application/json parameters: - in: body name: body required: true schema: $ref: '#/definitions/KnowledgeBaseCreateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeBase' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: kb.limitexceeded: Knowledge Base count exceeded bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. input.validations: Input parameters do not match the required criteria invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:knowledgebase:add x-purecloud-method-name: postKnowledgeKnowledgebases /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups: get: tags: - Knowledge summary: Get knowledge base unanswered groups description: '' operationId: getKnowledgeKnowledgebaseUnansweredGroups produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: app in: query description: The app value to be used for filtering phrases. required: false type: string enum: - SupportCenter - MessengerKnowledgeApp - BotFlow - Assistant - SmartAdvisor - name: dateStart in: query description: 'The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: false type: string format: date - name: dateEnd in: query description: 'The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: false type: string format: date responses: '200': description: successful operation schema: $ref: '#/definitions/UnansweredGroups' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:groups:view x-purecloud-method-name: getKnowledgeKnowledgebaseUnansweredGroups /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}: get: tags: - Knowledge summary: Get knowledge base unanswered group for a particular groupId description: '' operationId: getKnowledgeKnowledgebaseUnansweredGroup produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: groupId in: path description: The ID of the group to be retrieved. required: true type: string - name: app in: query description: The app value to be used for filtering phrases. required: false type: string enum: - SupportCenter - MessengerKnowledgeApp - BotFlow - Assistant - SmartAdvisor - name: dateStart in: query description: 'The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: false type: string format: date - name: dateEnd in: query description: 'The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: false type: string format: date responses: '200': description: successful operation schema: $ref: '#/definitions/UnansweredGroup' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:groups:view x-purecloud-method-name: getKnowledgeKnowledgebaseUnansweredGroup /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}: get: tags: - Knowledge summary: Get knowledge base unanswered phrase group for a particular phraseGroupId description: '' operationId: getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: groupId in: path description: The ID of the group to be retrieved. required: true type: string - name: phraseGroupId in: path description: The ID of the phraseGroup to be retrieved. required: true type: string - name: app in: query description: The app value to be used for filtering phrases. required: false type: string enum: - SupportCenter - MessengerKnowledgeApp - BotFlow - Assistant - SmartAdvisor - name: dateStart in: query description: 'The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: false type: string format: date - name: dateEnd in: query description: 'The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: false type: string format: date responses: '200': description: successful operation schema: $ref: '#/definitions/UnansweredPhraseGroup' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:groups:view x-purecloud-method-name: getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup patch: tags: - Knowledge summary: Update a Knowledge base unanswered phrase group description: '' operationId: patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: groupId in: path description: The ID of the group to be updated. required: true type: string - name: phraseGroupId in: path description: The ID of the phraseGroup to be updated. required: true type: string - in: body name: body description: Request body of the update unanswered group endpoint. required: true schema: $ref: '#/definitions/UnansweredPhraseGroupPatchRequestBody' responses: '200': description: successful operation schema: $ref: '#/definitions/UnansweredPhraseGroupUpdateResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:groups:edit - knowledge:document:edit x-purecloud-method-name: patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}: get: tags: - Knowledge summary: Get label description: '' operationId: getKnowledgeKnowledgebaseLabel produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: labelId in: path description: Label ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/LabelResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:label:view x-purecloud-method-name: getKnowledgeKnowledgebaseLabel delete: tags: - Knowledge summary: Delete label description: '' operationId: deleteKnowledgeKnowledgebaseLabel produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: labelId in: path description: Label ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/LabelResponse' '204': description: Label deleted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable constraint.validation: Input parameters do not match the required criteria '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:label:delete x-purecloud-method-name: deleteKnowledgeKnowledgebaseLabel patch: tags: - Knowledge summary: Update label description: '' operationId: patchKnowledgeKnowledgebaseLabel produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: labelId in: path description: Label ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/LabelUpdateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/LabelResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. already.exists: Label with the new name already exists '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:label:edit x-purecloud-method-name: patchKnowledgeKnowledgebaseLabel /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels: get: tags: - Knowledge summary: Get labels description: '' operationId: getKnowledgeKnowledgebaseLabels produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: before in: query description: The cursor that points to the start of the set of entities that has been returned. required: false type: string - name: after in: query description: The cursor that points to the end of the set of entities that has been returned. required: false type: string - name: pageSize in: query description: Number of entities to return. Maximum of 200. required: false type: string - name: name in: query description: Filter to return the labels that contains the given phrase in the name. required: false type: string - name: includeDocumentCount in: query description: If specified, retrieves the number of documents related to label. required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/LabelListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:label:view x-purecloud-method-name: getKnowledgeKnowledgebaseLabels post: tags: - Knowledge summary: Create new label description: '' operationId: postKnowledgeKnowledgebaseLabels produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/LabelCreateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/LabelResponse' '201': description: Label created schema: $ref: '#/definitions/LabelResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' limit.reached: The limit for the number of labels has been reached. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. already.exists: Label with same name already exists '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:label:add x-purecloud-method-name: postKnowledgeKnowledgebaseLabels /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources: get: tags: - Knowledge summary: Get Knowledge integration sources description: '' operationId: getKnowledgeKnowledgebaseSources produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: type in: query description: If specified, retrieves integration sources with specified integration type. required: false type: string enum: - Salesforce - ServiceNow - name: expand in: query description: The specified entity attributes will be filled. Comma separated values expected. required: false type: array items: type: string enum: - lastsync collectionFormat: multi - name: ids in: query description: If specified, retrieves integration sources with specified IDs. required: false type: array items: type: string collectionFormat: multi responses: '200': description: successful operation schema: type: array items: $ref: '#/definitions/SourceBaseResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Input parameters do not match the required criteria. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.dependency.error: Internal dependency error. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:integrationSource:view x-purecloud-method-name: getKnowledgeKnowledgebaseSources /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}: get: tags: - Knowledge summary: Get Salesforce Knowledge integration source description: '' operationId: getKnowledgeKnowledgebaseSourcesSalesforceSourceId produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: sourceId in: path description: Source ID required: true type: string - name: expand in: query description: The specified entity attributes will be filled. Comma separated values expected. required: false type: array items: type: string enum: - lastsync collectionFormat: multi responses: '200': description: Get Salesforce Knowledge integration source schema: $ref: '#/definitions/SalesforceSourceResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Input parameters do not match the required criteria. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Salesforce source not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.dependency.error: Internal dependency error. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:integrationSource:view x-purecloud-method-name: getKnowledgeKnowledgebaseSourcesSalesforceSourceId put: tags: - Knowledge summary: Update Salesforce Knowledge integration source description: '' operationId: putKnowledgeKnowledgebaseSourcesSalesforceSourceId produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: sourceId in: path description: Source ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/SalesforceSourceRequest' responses: '200': description: Salesforce Knowledge integration source updated schema: $ref: '#/definitions/SalesforceSourceResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Input parameters do not match the required criteria. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] invalid.integration: The provided integration is not active. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Source or Integration not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.dependency.error: Internal dependency error. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:integrationSource:edit x-purecloud-method-name: putKnowledgeKnowledgebaseSourcesSalesforceSourceId delete: tags: - Knowledge summary: Delete Salesforce Knowledge integration source description: '' operationId: deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: sourceId in: path description: Source ID required: true type: string responses: '204': description: Salesforce Knowledge integration source deleted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Input parameters do not match the required criteria. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Source not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.dependency.error: Internal dependency error. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:integrationSource:delete x-purecloud-method-name: deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}/sync: post: tags: - Knowledge summary: Start sync on Salesforce Knowledge integration source description: '' operationId: postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: sourceId in: path description: Source ID required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/KnowledgeSyncRequest' responses: '202': description: Synchronization on Salesforce Knowledge integration source started schema: $ref: '#/definitions/SourceSyncResponse' '200': description: Another synchronization is already running for this source schema: $ref: '#/definitions/SourceSyncResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Input parameters do not match the required criteria response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] invalid.integration: The provided integration is not active. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' limit.reached: Manual synchronization limit exceeded. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Source or Integration not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.dependency.error: Internal dependency error. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:integrationSource:edit x-purecloud-method-name: postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce: post: tags: - Knowledge summary: Create Salesforce Knowledge integration source description: '' operationId: postKnowledgeKnowledgebaseSourcesSalesforce produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/SalesforceSourceRequest' responses: '200': description: Salesforce Knowledge integration source created schema: $ref: '#/definitions/KnowledgeSyncJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Input parameters do not match the required criteria. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] invalid.integration: The provided integration is not active. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' limit.reached: Number of sources limit exceeded. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Integration or KnowledgeBase not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.dependency.error: Internal dependency error. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:integrationSource:add x-purecloud-method-name: postKnowledgeKnowledgebaseSourcesSalesforce /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}: get: tags: - Knowledge summary: Get ServiceNow Knowledge integration source description: '' operationId: getKnowledgeKnowledgebaseSourcesServicenowSourceId produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: sourceId in: path description: Source ID required: true type: string - name: expand in: query description: The specified entity attributes will be filled. Comma separated values expected. required: false type: array items: type: string enum: - lastsync collectionFormat: multi responses: '200': description: Get ServiceNow Knowledge integration source schema: $ref: '#/definitions/ServiceNowSourceResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Input parameters do not match the required criteria. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: ServiceNow source not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.dependency.error: Internal dependency error. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:integrationSource:view x-purecloud-method-name: getKnowledgeKnowledgebaseSourcesServicenowSourceId put: tags: - Knowledge summary: Update ServiceNow Knowledge integration source description: '' operationId: putKnowledgeKnowledgebaseSourcesServicenowSourceId produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: sourceId in: path description: Source ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/ServiceNowSourceRequest' responses: '200': description: ServiceNow Knowledge integration source updated schema: $ref: '#/definitions/ServiceNowSourceResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Input parameters do not match the required criteria. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] invalid.integration: The provided integration is not active. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Source or Integration not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.dependency.error: Internal dependency error. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:integrationSource:edit x-purecloud-method-name: putKnowledgeKnowledgebaseSourcesServicenowSourceId delete: tags: - Knowledge summary: Delete ServiceNow Knowledge integration source description: '' operationId: deleteKnowledgeKnowledgebaseSourcesServicenowSourceId produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: sourceId in: path description: Source ID required: true type: string responses: '204': description: ServiceNow Knowledge integration source deleted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Input parameters do not match the required criteria. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Source not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.dependency.error: Internal dependency error. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:integrationSource:delete x-purecloud-method-name: deleteKnowledgeKnowledgebaseSourcesServicenowSourceId /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}/sync: post: tags: - Knowledge summary: Start synchronization on ServiceNow Knowledge integration source description: '' operationId: postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: sourceId in: path description: Source ID required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/KnowledgeSyncRequest' responses: '202': description: Synchronization on ServiceNow Knowledge integration source started schema: $ref: '#/definitions/SourceSyncResponse' '200': description: Another sync is already running for this source schema: $ref: '#/definitions/SourceSyncResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Input parameters do not match the required criteria. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] invalid.integration: The provided integration is not active. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' limit.reached: Manual synchronization limit exceeded. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Source or Integration not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.dependency.error: Internal dependency error. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:integrationSource:edit x-purecloud-method-name: postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow: post: tags: - Knowledge summary: Create ServiceNow Knowledge integration source description: '' operationId: postKnowledgeKnowledgebaseSourcesServicenow produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/ServiceNowSourceRequest' responses: '200': description: ServiceNow Knowledge integration source created schema: $ref: '#/definitions/KnowledgeSyncJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Input parameters do not match the required criteria. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] invalid.integration: The provided integration is not active. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' limit.reached: Number of sources limit exceeded. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Integration or KnowledgeBase not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.dependency.error: Internal dependency error. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:integrationSource:add x-purecloud-method-name: postKnowledgeKnowledgebaseSourcesServicenow /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs/{jobId}: get: tags: - Knowledge summary: Get content upload from URL job status description: '' operationId: getKnowledgeKnowledgebaseUploadsUrlsJob produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: jobId in: path description: Upload job ID required: true type: string responses: '200': description: Content upload job status schema: $ref: '#/definitions/GetUploadSourceUrlJobStatusResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:uploadSourceUrlJob:view x-purecloud-method-name: getKnowledgeKnowledgebaseUploadsUrlsJob /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs: post: tags: - Knowledge summary: Create content upload from URL job description: '' operationId: postKnowledgeKnowledgebaseUploadsUrlsJobs produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - in: body name: body description: uploadRequest required: true schema: $ref: '#/definitions/CreateUploadSourceUrlJobRequest' responses: '202': description: Content upload in progress schema: $ref: '#/definitions/CreateUploadSourceUrlJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. limit.reached: Daily or monthly limit reached '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:uploadSourceUrlJob:add x-purecloud-method-name: postKnowledgeKnowledgebaseUploadsUrlsJobs /api/v2/knowledge/documentuploads: post: tags: - Knowledge summary: Creates a presigned URL for uploading a knowledge import file with a set of documents description: '' operationId: postKnowledgeDocumentuploads produces: - application/json parameters: - in: body name: body description: query required: true schema: $ref: '#/definitions/UploadUrlRequest' responses: '200': description: Presigned URL successfully created. schema: $ref: '#/definitions/UploadUrlResponse' '409': description: Daily or monthly upload limit exceeded. x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - upload x-inin-requires-permissions: type: ALL permissions: - knowledge:document:upload x-purecloud-method-name: postKnowledgeDocumentuploads /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/answers: post: tags: - Knowledge summary: Answer documents. description: '' operationId: postKnowledgeKnowledgebaseDocumentsAnswers produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/KnowledgeDocumentsAnswerFilter' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeAnswerDocumentsResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:document:view - knowledge:documentAnswer:view x-purecloud-method-name: postKnowledgeKnowledgebaseDocumentsAnswers /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/chunks/search/{searchId}: patch: tags: - Knowledge summary: Register chunk search result. description: '' operationId: patchKnowledgeKnowledgebaseChunksSearchSearchId consumes: - application/json produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge Base ID required: true type: string - name: searchId in: path description: Unique identifier of search request required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/ChunkSearchRegisterRequest' responses: '204': description: Search registered successfully. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:knowledgebase:search x-purecloud-method-name: patchKnowledgeKnowledgebaseChunksSearchSearchId /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/chunks/search: post: tags: - Knowledge summary: Search for chunks in a knowledge base description: '' operationId: postKnowledgeKnowledgebaseChunksSearch produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge Base ID required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/KnowledgeDocumentChunkRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeDocumentChunkResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: The minimum characters for the query is 3. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:knowledgebase:search x-purecloud-method-name: postKnowledgeKnowledgebaseChunksSearch /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}: get: tags: - Knowledge summary: Get document. description: '' operationId: getKnowledgeKnowledgebaseDocument produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID. required: true type: string - name: documentId in: path description: Document ID. required: true type: string - name: expand in: query description: The specified entity attributes will be filled. Comma separated values expected. Max No. of variations that can be returned on expand is 20. required: false type: array items: type: string enum: - category - labels - variations collectionFormat: multi - name: state in: query description: '"when state is "Draft", draft version of the document is returned,otherwise by default published version is returned in the response.' required: false type: string enum: - Draft - Published responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeDocumentResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:document:view x-purecloud-method-name: getKnowledgeKnowledgebaseDocument delete: tags: - Knowledge summary: Delete document. description: '' operationId: deleteKnowledgeKnowledgebaseDocument produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID. required: true type: string - name: documentId in: path description: Document ID. required: true type: string responses: '204': description: Document deleted. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:document:delete x-purecloud-method-name: deleteKnowledgeKnowledgebaseDocument patch: tags: - Knowledge summary: Update document. description: '' operationId: patchKnowledgeKnowledgebaseDocument produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID. required: true type: string - name: documentId in: path description: Document ID. required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/KnowledgeDocumentReq' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeDocumentResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:document:edit x-purecloud-method-name: patchKnowledgeKnowledgebaseDocument /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}: get: tags: - Knowledge summary: Get document version. description: '' operationId: getKnowledgeKnowledgebaseDocumentVersion produces: - application/json parameters: - name: knowledgeBaseId in: path description: Globally unique identifier for the knowledge base. required: true type: string - name: documentId in: path description: Globally unique identifier for the document. required: true type: string - name: versionId in: path description: Globally unique identifier for the document version. required: true type: string - name: expand in: query description: The specified entity attributes will be filled. Comma separated values expected. required: false type: array items: type: string enum: - category - labels collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeDocumentVersion' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:documentVersion:view x-purecloud-method-name: getKnowledgeKnowledgebaseDocumentVersion /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions: get: tags: - Knowledge summary: Get document versions. description: '' operationId: getKnowledgeKnowledgebaseDocumentVersions produces: - application/json parameters: - name: knowledgeBaseId in: path description: Globally unique identifier for the knowledge base. required: true type: string - name: documentId in: path description: Globally unique identifier for the document. required: true type: string - name: before in: query description: The cursor that points to the start of the set of entities that has been returned. required: false type: string - name: after in: query description: The cursor that points to the end of the set of entities that has been returned. required: false type: string - name: pageSize in: query description: Number of entities to return. Maximum of 200. required: false type: string - name: expand in: query description: The specified entity attributes will be filled. Comma separated values expected. required: false type: array items: type: string enum: - category - labels collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeDocumentVersionListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:documentVersion:view x-purecloud-method-name: getKnowledgeKnowledgebaseDocumentVersions post: tags: - Knowledge summary: Creates or restores a document version. description: '' operationId: postKnowledgeKnowledgebaseDocumentVersions produces: - application/json parameters: - name: knowledgeBaseId in: path description: Globally unique identifier for the knowledge base. required: true type: string - name: documentId in: path description: Globally unique identifier for the document. required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/KnowledgeDocumentVersion' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeDocumentVersion' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:documentVersion:add x-purecloud-method-name: postKnowledgeKnowledgebaseDocumentVersions /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents: get: tags: - Knowledge summary: Get documents. description: '' operationId: getKnowledgeKnowledgebaseDocuments produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: before in: query description: The cursor that points to the start of the set of entities that has been returned. required: false type: string - name: after in: query description: The cursor that points to the end of the set of entities that has been returned. required: false type: string - name: pageSize in: query description: Number of entities to return. Maximum of 200. required: false type: string - name: interval in: query description: 'Retrieves the documents modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ' required: false type: string format: interval - name: documentId in: query description: Retrieves the specified documents, comma separated values expected. required: false type: array items: type: string collectionFormat: multi - name: categoryId in: query description: If specified, retrieves documents associated with category ids, comma separated values expected. required: false type: array items: type: string collectionFormat: multi - name: includeSubcategories in: query description: Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories. required: false type: boolean - name: includeDrafts in: query description: If includeDrafts is true, Documents in the draft state are also returned in the response. required: false type: boolean - name: labelIds in: query description: If specified, retrieves documents associated with label ids, comma separated values expected. required: false type: array items: type: string collectionFormat: multi - name: expand in: query description: The specified entity attributes will be filled. Comma separated values expected. required: false type: array items: type: string enum: - category - labels collectionFormat: multi - name: externalIds in: query description: If specified, retrieves documents associated with external ids, comma separated values expected. required: false type: array items: type: string collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeDocumentResponseListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:document:view x-purecloud-method-name: getKnowledgeKnowledgebaseDocuments post: tags: - Knowledge summary: Create document. description: '' operationId: postKnowledgeKnowledgebaseDocuments produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/KnowledgeDocumentReq' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeDocumentResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. already.exists: Document already exists '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:document:add x-purecloud-method-name: postKnowledgeKnowledgebaseDocuments /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/remove: post: tags: - Knowledge summary: Bulk remove documents. description: '' operationId: postKnowledgeKnowledgebaseDocumentsBulkRemove produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/KnowledgeDocumentBulkRemoveRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BulkResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:document:delete x-purecloud-method-name: postKnowledgeKnowledgebaseDocumentsBulkRemove /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/update: post: tags: - Knowledge summary: Bulk update documents. description: '' operationId: postKnowledgeKnowledgebaseDocumentsBulkUpdate produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/KnowledgeDocumentBulkUpdateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BulkResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:document:edit x-purecloud-method-name: postKnowledgeKnowledgebaseDocumentsBulkUpdate /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/versions/bulk/add: post: tags: - Knowledge summary: Bulk add document versions. description: '' operationId: postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/KnowledgeDocumentBulkVersionAddRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BulkResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:documentVersion:add x-purecloud-method-name: postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}: get: tags: - Knowledge summary: Get a variation for a document. description: '' operationId: getKnowledgeKnowledgebaseDocumentVariation produces: - application/json parameters: - name: documentVariationId in: path description: Globally unique identifier for a document variation. required: true type: string - name: documentId in: path description: Globally unique identifier for a document. required: true type: string - name: knowledgeBaseId in: path description: Globally unique identifier for a knowledge base. required: true type: string - name: documentState in: query description: The state of the document. required: false type: string enum: - Draft - Published - name: expand in: query description: The specified entity attributes will be filled. Comma separated values expected. required: false type: array items: type: string enum: - contentUrl collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/DocumentVariationResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:document:view x-purecloud-method-name: getKnowledgeKnowledgebaseDocumentVariation delete: tags: - Knowledge summary: Delete a variation for a document. description: '' operationId: deleteKnowledgeKnowledgebaseDocumentVariation produces: - application/json parameters: - name: documentVariationId in: path description: Globally unique identifier for a document variation. required: true type: string - name: documentId in: path description: Globally unique identifier for a document. required: true type: string - name: knowledgeBaseId in: path description: Globally unique identifier for a knowledge base. required: true type: string responses: '204': description: Document variation deleted. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ANY permissions: - knowledge:document:delete - knowledge:document:edit x-purecloud-method-name: deleteKnowledgeKnowledgebaseDocumentVariation patch: tags: - Knowledge summary: Update a variation for a document. description: '' operationId: patchKnowledgeKnowledgebaseDocumentVariation produces: - application/json parameters: - name: documentVariationId in: path description: Globally unique identifier for a document variation. required: true type: string - name: documentId in: path description: Globally unique identifier for a document. required: true type: string - name: knowledgeBaseId in: path description: Globally unique identifier for a knowledge base. required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/DocumentVariationRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/DocumentVariationResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Body should have a value. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Submitted variation is either null or contains a null field. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' knowledge.variation.empty.request: The request for knowledge variation was empty. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:document:edit x-purecloud-method-name: patchKnowledgeKnowledgebaseDocumentVariation /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations: get: tags: - Knowledge summary: Get variations for a document. description: '' operationId: getKnowledgeKnowledgebaseDocumentVariations produces: - application/json parameters: - name: knowledgeBaseId in: path description: Globally unique identifier for the knowledge base. required: true type: string - name: documentId in: path description: Globally unique identifier for the document. required: true type: string - name: before in: query description: The cursor that points to the start of the set of entities that has been returned. required: false type: string - name: after in: query description: The cursor that points to the end of the set of entities that has been returned. required: false type: string - name: pageSize in: query description: Number of entities to return. Maximum of 200. required: false type: string - name: documentState in: query description: The state of the document. required: false type: string enum: - Draft - Published - name: expand in: query description: The specified entity attributes will be filled. Comma separated values expected. required: false type: array items: type: string enum: - contentUrl collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/DocumentVariationResponseListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:document:view x-purecloud-method-name: getKnowledgeKnowledgebaseDocumentVariations post: tags: - Knowledge summary: Create a variation for a document. description: '' operationId: postKnowledgeKnowledgebaseDocumentVariations produces: - application/json parameters: - name: knowledgeBaseId in: path description: Globally unique identifier for the knowledge base. required: true type: string - name: documentId in: path description: Globally unique identifier for the document. required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/DocumentVariationRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/DocumentVariationResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Body should have a value. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] already.exists: Variation already exists constraint.validation: Submitted variation is either null or contains a null field. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' knowledge.variation.empty.request: The request for knowledge variation was empty. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ANY permissions: - knowledge:document:add - knowledge:document:edit x-purecloud-method-name: postKnowledgeKnowledgebaseDocumentVariations /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId}: get: tags: - Knowledge summary: Get variation for the given document version. description: '' operationId: getKnowledgeKnowledgebaseDocumentVersionVariation produces: - application/json parameters: - name: knowledgeBaseId in: path description: Globally unique identifier for the knowledge base. required: true type: string - name: documentId in: path description: Globally unique identifier for the document. required: true type: string - name: versionId in: path description: Globally unique identifier for the document version. required: true type: string - name: variationId in: path description: Globally unique identifier for the document version variation. required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeDocumentVersionVariation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:documentVersion:view x-purecloud-method-name: getKnowledgeKnowledgebaseDocumentVersionVariation /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations: get: tags: - Knowledge summary: Get variations for the given document version. description: '' operationId: getKnowledgeKnowledgebaseDocumentVersionVariations produces: - application/json parameters: - name: knowledgeBaseId in: path description: Globally unique identifier for the knowledge base. required: true type: string - name: documentId in: path description: Globally unique identifier for the document. required: true type: string - name: versionId in: path description: Globally unique identifier for the document version. required: true type: string - name: before in: query description: The cursor that points to the start of the set of entities that has been returned. required: false type: string - name: after in: query description: The cursor that points to the end of the set of entities that has been returned. required: false type: string - name: pageSize in: query description: Number of entities to return. Maximum of 200. required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeDocumentVersionVariationListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:documentVersion:view x-purecloud-method-name: getKnowledgeKnowledgebaseDocumentVersionVariations /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/copies: post: tags: - Knowledge summary: Indicate that the document was copied by the user. description: '' operationId: postKnowledgeKnowledgebaseDocumentCopies produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID. required: true type: string - name: documentId in: path description: Document ID. required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/KnowledgeDocumentCopy' responses: '204': description: Operation was successful '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Document not found. document.variation.not.found: Document variation not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:documentCopy:add x-purecloud-method-name: postKnowledgeKnowledgebaseDocumentCopies /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/presentations: post: tags: - Knowledge summary: Indicate that documents were presented to the user. description: '' operationId: postKnowledgeKnowledgebaseDocumentsPresentations produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID. required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/KnowledgeDocumentPresentation' responses: '204': description: Operation was successful '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Document not found. document.variation.not.found: Document variation not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:documentPresentation:add x-purecloud-method-name: postKnowledgeKnowledgebaseDocumentsPresentations /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/feedback: get: tags: - Knowledge summary: Get a list of feedback records given on documents in a knowledge base description: '' operationId: getKnowledgeKnowledgebaseDocumentsFeedback produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID. required: true type: string - name: before in: query description: The cursor that points to the start of the set of entities that has been returned. required: false type: string - name: after in: query description: The cursor that points to the end of the set of entities that has been returned. required: false type: string - name: pageSize in: query description: Number of entities to return. Maximum of 200. required: false type: string - name: onlyCommented in: query description: 'If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false.' required: false type: boolean - name: documentVersionId in: query description: Document version ID to filter by. Supported only if onlyCommented=true is set. required: false type: string - name: documentVariationId in: query description: Document variation ID to filter by. Supported only if onlyCommented=true is set. required: false type: string - name: appType in: query description: Application type to filter by. Supported only if onlyCommented=true is set. required: false type: string enum: - Assistant - BotFlow - MessengerKnowledgeApp - SmartAdvisor - SupportCenter - name: queryType in: query description: Query type to filter by. Supported only if onlyCommented=true is set. required: false type: string enum: - Unknown - Article - AutoSearch - Category - ManualSearch - Recommendation - Suggestion - ExpandedArticle - name: userId in: query description: The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set. required: false type: string - name: queueId in: query description: Queue ID to filter by. Supported only if onlyCommented=true is set. required: false type: string - name: state in: query description: 'State to filter by. Supported only if onlyCommented=true is set. Default: Final' required: false type: string enum: - All - Draft - Final responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeDocumentFeedbackResponseListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Knowledge base not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ANY permissions: - knowledge:feedback:view x-purecloud-method-name: getKnowledgeKnowledgebaseDocumentsFeedback /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}: get: tags: - Knowledge summary: Get a single feedback record given on a document description: '' operationId: getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID. required: true type: string - name: documentId in: path description: Document ID. required: true type: string - name: feedbackId in: path description: Feedback ID. required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeDocumentFeedbackResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Feedback not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ANY permissions: - knowledge:feedback:view x-purecloud-method-name: getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId patch: tags: - Knowledge summary: Update feedback on a document description: '' operationId: patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID. required: true type: string - name: documentId in: path description: Document ID. required: true type: string - name: feedbackId in: path description: Feedback ID. required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/KnowledgeDocumentFeedbackUpdateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeDocumentFeedbackResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Feedback not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ANY permissions: - knowledge:feedback:edit x-purecloud-method-name: patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback: get: tags: - Knowledge summary: Get a list of feedback records given on a document description: '' operationId: getKnowledgeKnowledgebaseDocumentFeedback produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID. required: true type: string - name: documentId in: path description: Document ID. required: true type: string - name: before in: query description: The cursor that points to the start of the set of entities that has been returned. required: false type: string - name: after in: query description: The cursor that points to the end of the set of entities that has been returned. required: false type: string - name: pageSize in: query description: Number of entities to return. Maximum of 200. required: false type: string - name: onlyCommented in: query description: 'If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false.' required: false type: boolean - name: documentVersionId in: query description: Document version ID to filter by. Supported only if onlyCommented=true is set. required: false type: string - name: documentVariationId in: query description: Document variation ID to filter by. Supported only if onlyCommented=true is set. required: false type: string - name: appType in: query description: Application type to filter by. Supported only if onlyCommented=true is set. required: false type: string enum: - Assistant - BotFlow - MessengerKnowledgeApp - SmartAdvisor - SupportCenter - name: queryType in: query description: Query type to filter by. Supported only if onlyCommented=true is set. required: false type: string enum: - Unknown - Article - AutoSearch - Category - ManualSearch - Recommendation - Suggestion - ExpandedArticle - name: userId in: query description: The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set. required: false type: string - name: queueId in: query description: Queue ID to filter by. Supported only if onlyCommented=true is set. required: false type: string - name: state in: query description: 'State to filter by. Supported only if onlyCommented=true is set. Default: Final' required: false type: string enum: - All - Draft - Final responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeDocumentFeedbackResponseListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Document not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ANY permissions: - knowledge:feedback:view x-purecloud-method-name: getKnowledgeKnowledgebaseDocumentFeedback post: tags: - Knowledge summary: Give feedback on a document description: '' operationId: postKnowledgeKnowledgebaseDocumentFeedback produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID. required: true type: string - name: documentId in: path description: Document ID. required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/KnowledgeDocumentFeedback' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeDocumentFeedbackResponse' '201': description: Created schema: $ref: '#/definitions/KnowledgeDocumentFeedbackResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Document version or variation not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ANY permissions: - knowledge:feedback:create x-purecloud-method-name: postKnowledgeKnowledgebaseDocumentFeedback /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/query: post: tags: - Knowledge summary: Query for knowledge documents. description: '' operationId: postKnowledgeKnowledgebaseDocumentsQuery produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge Base ID required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/KnowledgeDocumentQuery' - name: expand in: query description: Fields, if any, to expand for each document in the search result matching the query. required: false type: array items: type: string enum: - documentVariations - documentAlternatives - knowledgeBaseLanguageCode - variationChunks collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeDocumentQueryResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:document:view x-purecloud-method-name: postKnowledgeKnowledgebaseDocumentsQuery /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}: get: tags: - Knowledge summary: Get export job report description: '' operationId: getKnowledgeKnowledgebaseExportJob produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: exportJobId in: path description: Export job ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeExportJobResponse' '202': description: Export job in progress schema: $ref: '#/definitions/KnowledgeExportJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:exportJob:view x-purecloud-method-name: getKnowledgeKnowledgebaseExportJob delete: tags: - Knowledge summary: Delete export job description: '' operationId: deleteKnowledgeKnowledgebaseExportJob produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: exportJobId in: path description: Export job ID required: true type: string responses: '204': description: Export job deleted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable constraint.validation: Input parameters do not match the required criteria '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:exportJob:delete x-purecloud-method-name: deleteKnowledgeKnowledgebaseExportJob /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs: post: tags: - Knowledge summary: Create export job description: '' operationId: postKnowledgeKnowledgebaseExportJobs produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/KnowledgeExportJobRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeExportJobResponse' '202': description: Export job in progress schema: $ref: '#/definitions/KnowledgeExportJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. limit.reached: Daily or monthly limit reached '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:exportJob:add x-purecloud-method-name: postKnowledgeKnowledgebaseExportJobs /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}: get: tags: - Knowledge summary: Get import job report description: '' operationId: getKnowledgeKnowledgebaseImportJob produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: importJobId in: path description: Import job ID required: true type: string - name: expand in: query description: If expand contains 'urls' downloadURL and failedEntitiesURL will be filled. required: false type: array items: type: string enum: - urls collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeImportJobResponse' '202': description: Import job in progress schema: $ref: '#/definitions/KnowledgeImportJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:importJob:view x-purecloud-method-name: getKnowledgeKnowledgebaseImportJob delete: tags: - Knowledge summary: Delete import job description: '' operationId: deleteKnowledgeKnowledgebaseImportJob produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: importJobId in: path description: Import job ID required: true type: string responses: '204': description: Import job deleted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable constraint.validation: Input parameters do not match the required criteria '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:importJob:delete x-purecloud-method-name: deleteKnowledgeKnowledgebaseImportJob patch: tags: - Knowledge summary: Start import job description: '' operationId: patchKnowledgeKnowledgebaseImportJob produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: importJobId in: path description: Import job ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/ImportStatusRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeImportJobResponse' '202': description: Import job in progress schema: $ref: '#/definitions/KnowledgeImportJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:importJob:edit x-purecloud-method-name: patchKnowledgeKnowledgebaseImportJob /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs: post: tags: - Knowledge summary: Create import job description: '' operationId: postKnowledgeKnowledgebaseImportJobs produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/KnowledgeImportJobRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeImportJobResponse' '202': description: Import job in progress schema: $ref: '#/definitions/KnowledgeImportJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:importJob:add x-purecloud-method-name: postKnowledgeKnowledgebaseImportJobs /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs/{syncJobId}: get: tags: - Knowledge summary: Get synchronization job report description: '' operationId: getKnowledgeKnowledgebaseSynchronizeJob produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: syncJobId in: path description: Synchronization job ID required: true type: string responses: '200': description: Get synchronization job schema: $ref: '#/definitions/KnowledgeSyncJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:syncJob:view x-purecloud-method-name: getKnowledgeKnowledgebaseSynchronizeJob delete: tags: - Knowledge summary: Delete synchronization job description: '' operationId: deleteKnowledgeKnowledgebaseSynchronizeJob produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: syncJobId in: path description: Synchronization job ID required: true type: string responses: '204': description: Synchronization job deleted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable constraint.validation: Input parameters do not match the required criteria '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:syncJob:delete x-purecloud-method-name: deleteKnowledgeKnowledgebaseSynchronizeJob patch: tags: - Knowledge summary: Update synchronization job description: '' operationId: patchKnowledgeKnowledgebaseSynchronizeJob produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: syncJobId in: path description: Synchronization job ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/SyncStatusRequest' responses: '202': description: Synchronization job updated schema: $ref: '#/definitions/KnowledgeSyncJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:syncJob:edit x-purecloud-method-name: patchKnowledgeKnowledgebaseSynchronizeJob /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs: post: tags: - Knowledge summary: Create synchronization job description: '' operationId: postKnowledgeKnowledgebaseSynchronizeJobs produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/KnowledgeSyncJobRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeSyncJobResponse' '202': description: Synchronization job in progress schema: $ref: '#/definitions/KnowledgeSyncJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. limit.reached: Daily or monthly limit reached '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:syncJob:add x-purecloud-method-name: postKnowledgeKnowledgebaseSynchronizeJobs /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations: get: tags: - Knowledge summary: Get operations description: '' operationId: getKnowledgeKnowledgebaseOperations produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: before in: query description: The cursor that points to the start of the set of entities that has been returned. required: false type: string - name: after in: query description: The cursor that points to the end of the set of entities that has been returned. required: false type: string - name: pageSize in: query description: Number of entities to return. Maximum of 200. required: false type: string - name: userId in: query description: If specified, retrieves operations associated with user ids, comma separated values expected. required: false type: array items: type: string collectionFormat: multi - name: type in: query description: If specified, retrieves operations with specified operation type, comma separated values expected. required: false type: array items: type: string enum: - Export - Import - Parse - Sync collectionFormat: multi - name: status in: query description: If specified, retrieves operations with specified operation status, comma separated values expected. required: false type: array items: type: string collectionFormat: multi - name: interval in: query description: 'Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ' required: false type: string format: interval - name: sourceId in: query description: If specified, retrieves operations associated with source ids, comma separated values expected. required: false type: array items: type: string collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/OperationListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:importExportOperationsList:view x-purecloud-method-name: getKnowledgeKnowledgebaseOperations /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations/users/query: get: tags: - Knowledge summary: Get ids of operation creator users and oauth clients description: '' operationId: getKnowledgeKnowledgebaseOperationsUsersQuery produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/OperationCreatorUserResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:importExportOperationsList:view x-purecloud-method-name: getKnowledgeKnowledgebaseOperationsUsersQuery /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}: get: tags: - Knowledge summary: Get parse job report description: '' operationId: getKnowledgeKnowledgebaseParseJob produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: parseJobId in: path description: Parse job ID required: true type: string - name: expand in: query description: If expand contains 'urls' downloadURL and failedEntitiesURL will be filled. required: false type: array items: type: string enum: - urls collectionFormat: multi responses: '200': description: Parse job is done schema: $ref: '#/definitions/KnowledgeParseJobResponse' '202': description: Parse job in progress schema: $ref: '#/definitions/KnowledgeParseJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:importJob:view x-purecloud-method-name: getKnowledgeKnowledgebaseParseJob patch: tags: - Knowledge summary: Send update to the parse operation description: '' operationId: patchKnowledgeKnowledgebaseParseJob produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: parseJobId in: path description: Parse job ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/KnowledgeParseJobRequestPatch' responses: '204': description: Override saved '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:importJob:edit x-purecloud-method-name: patchKnowledgeKnowledgebaseParseJob /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}/import: post: tags: - Knowledge summary: Import the parsed articles description: '' operationId: postKnowledgeKnowledgebaseParseJobImport produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - name: parseJobId in: path description: Parse job ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/KnowledgeParseJobRequestImport' responses: '204': description: Parsed import job in progress '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:importJob:edit x-purecloud-method-name: postKnowledgeKnowledgebaseParseJobImport /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs: post: tags: - Knowledge summary: Create parse job description: '' operationId: postKnowledgeKnowledgebaseParseJobs produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/KnowledgeParseJobRequest' responses: '202': description: Parse job in progress schema: $ref: '#/definitions/KnowledgeParseJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:importJob:add x-purecloud-method-name: postKnowledgeKnowledgebaseParseJobs /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}: patch: tags: - Knowledge summary: Update search result. description: '' operationId: patchKnowledgeKnowledgebaseDocumentsSearchSearchId produces: - application/json parameters: - name: knowledgeBaseId in: path description: The ID of knowledge base containing the documents to query. required: true type: string - name: searchId in: path description: Search Result ID required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/SearchUpdateRequest' responses: '204': description: Search updated successfully. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:search:edit x-purecloud-method-name: patchKnowledgeKnowledgebaseDocumentsSearchSearchId /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions: post: tags: - Knowledge summary: Query the knowledge documents to provide suggestions for auto completion. description: '' operationId: postKnowledgeKnowledgebaseDocumentsSearchSuggestions produces: - application/json parameters: - name: knowledgeBaseId in: path description: The ID of knowledge base containing the documents to query. required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/KnowledgeDocumentSuggestionRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeDocumentSuggestion' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] min.length.expected: The minimum length was not reached. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:knowledgebase:search x-purecloud-method-name: postKnowledgeKnowledgebaseDocumentsSearchSuggestions /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search: post: tags: - Knowledge summary: Search the documents in a knowledge base. description: '' operationId: postKnowledgeKnowledgebaseDocumentsSearch produces: - application/json parameters: - name: knowledgeBaseId in: path description: The ID of knowledge base containing the documents to query. required: true type: string - name: expand in: query description: Fields, if any, to expand for each document in the search result matching the query. required: false type: array items: type: string enum: - documentVariations - documentAlternatives - knowledgeBaseLanguageCode - variationChunks collectionFormat: multi - in: body name: body required: false schema: $ref: '#/definitions/KnowledgeDocumentSearchRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeDocumentSearch' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: The minimum characters for the query is 3. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:knowledgebase:search x-purecloud-method-name: postKnowledgeKnowledgebaseDocumentsSearch /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/views: post: tags: - Knowledge summary: Create view for a document. description: '' operationId: postKnowledgeKnowledgebaseDocumentViews produces: - application/json parameters: - name: knowledgeBaseId in: path description: Knowledge base ID. required: true type: string - name: documentId in: path description: Document ID. required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/KnowledgeDocumentView' responses: '204': description: Operation was successful '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Document not found. document.variation.not.found: Document variation not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:documentView:add x-purecloud-method-name: postKnowledgeKnowledgebaseDocumentViews /api/v2/knowledge/connections/{connectionId}/options: get: tags: - Knowledge summary: Get connection options description: '' operationId: getKnowledgeConnectionOptions produces: - application/json parameters: - name: connectionId in: path description: Connection ID required: true type: string - name: after in: query description: The cursor that points to the end of the set of entities that has been returned. required: false type: string - name: pageSize in: query description: 'Number of results per page. Minimum: 25, Maximum: 500.' required: false type: string default: '200' - name: parentId in: query description: The id of the parent option whose children to be listed. required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ConnectionOptionListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Connection or connection option does not exist '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:connectionOptions:view x-purecloud-method-name: getKnowledgeConnectionOptions /api/v2/knowledge/connections/{connectionId}: get: tags: - Knowledge summary: Get connection description: '' operationId: getKnowledgeConnection produces: - application/json parameters: - name: connectionId in: path description: Connection ID required: true type: string - name: expand in: query description: The specified entity attributes will be filled. Comma separated values expected. required: false type: array items: type: string enum: - authenticationProperties collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/ConnectionResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] invalid.integration: Integration not configured correctly. constraint.validation: Input parameters do not match the required criteria. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Connection or integration does not exist. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:connection:view x-purecloud-method-name: getKnowledgeConnection delete: tags: - Knowledge summary: Delete connection description: '' operationId: deleteKnowledgeConnection produces: - application/json parameters: - name: connectionId in: path description: Connection ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ConnectionResponse' '204': description: Connection deleted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Connection does not exist. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. in.use: Connection is in use by one or more sources. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:connection:delete x-purecloud-method-name: deleteKnowledgeConnection patch: tags: - Knowledge summary: Update connection description: '' operationId: patchKnowledgeConnection produces: - application/json parameters: - name: connectionId in: path description: Connection ID required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/ConnectionUpdateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ConnectionResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: connection.authentication.error: Failed to update connection bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] invalid.integration: Integration not configured correctly. constraint.validation: Input parameters do not match the required criteria. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Connection or integration does not exist. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:connection:edit x-purecloud-method-name: patchKnowledgeConnection /api/v2/knowledge/connections: get: tags: - Knowledge summary: Get connections description: '' operationId: getKnowledgeConnections produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/ConnectionListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:connection:view x-purecloud-method-name: getKnowledgeConnections post: tags: - Knowledge summary: Create new connection description: '' operationId: postKnowledgeConnections produces: - application/json parameters: - in: body name: body required: true schema: $ref: '#/definitions/ConnectionCreateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ConnectionCreateResponse' '201': description: Connection created schema: $ref: '#/definitions/ConnectionCreateResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: limit.reached.in.region: The limit for the number of connections has been reached in the region. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] not.found: Integration not found. invalid.integration: Integration not configured correctly. constraint.validation: Input parameters do not match the required criteria. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' limit.reached: The limit for the number of connections has been reached. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:connection:add x-purecloud-method-name: postKnowledgeConnections /api/v2/knowledge/settings/{knowledgeSettingId}: get: tags: - Knowledge summary: Get Knowledge setting. description: '' operationId: getKnowledgeSetting produces: - application/json parameters: - name: knowledgeSettingId in: path description: Knowledge Setting ID. required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeSettingsResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:knowledgeSetting:view x-purecloud-method-name: getKnowledgeSetting delete: tags: - Knowledge summary: Delete Knowledge setting. description: '' operationId: deleteKnowledgeSetting produces: - application/json parameters: - name: knowledgeSettingId in: path description: Knowledge Setting ID. required: true type: string responses: '204': description: Knowledge setting deleted. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:knowledgeSetting:delete x-purecloud-method-name: deleteKnowledgeSetting patch: tags: - Knowledge summary: Update Knowledge setting. description: '' operationId: patchKnowledgeSetting produces: - application/json parameters: - name: knowledgeSettingId in: path description: Knowledge Setting ID. required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/KnowledgeSettingsRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeSettingsResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:knowledgeSetting:edit x-purecloud-method-name: patchKnowledgeSetting /api/v2/knowledge/settings: get: tags: - Knowledge summary: Get Knowledge settings. description: '' operationId: getKnowledgeSettings produces: - application/json parameters: - name: before in: query description: The cursor that points to the start of the set of entities that has been returned. required: false type: string - name: after in: query description: The cursor that points to the end of the set of entities that has been returned. required: false type: string - name: pageSize in: query description: Number of entities to return. Maximum of 200. required: false type: string - name: name in: query description: Knowledge setting name to search upon. required: false type: string - name: sourceId in: query description: Source ID to filter knowledge settings by. required: false type: string - name: sortBy in: query description: Field to sort the knowledge settings on. required: false type: string enum: - dateModified - name - name: sortOrder in: query description: Sorting order for knowledge settings. required: false type: string enum: - Asc - Desc responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeSettingListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:knowledgeSetting:view x-purecloud-method-name: getKnowledgeSettings post: tags: - Knowledge summary: Create Knowledge setting. description: '' operationId: postKnowledgeSettings produces: - application/json parameters: - in: body name: body required: false schema: $ref: '#/definitions/KnowledgeSettingsRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeSettingsResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:knowledgeSetting:add x-purecloud-method-name: postKnowledgeSettings /api/v2/knowledge/search/preview: post: tags: - Knowledge summary: Get Knowledge Search Preview description: '' operationId: postKnowledgeSearchPreview produces: - application/json parameters: - in: body name: body required: false schema: $ref: '#/definitions/KnowledgeSearchPreviewRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeSearchPreviewResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:knowledgeSetting:searchPreview x-purecloud-method-name: postKnowledgeSearchPreview /api/v2/knowledge/search: post: tags: - Knowledge summary: Get Knowledge Search description: '' operationId: postKnowledgeSearch produces: - application/json parameters: - in: body name: body required: false schema: $ref: '#/definitions/KnowledgeSourcesSearchRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeSourcesSearchResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:knowledgeSetting:search x-purecloud-method-name: postKnowledgeSearch /api/v2/knowledge/sources/{sourceId}: get: tags: - Knowledge summary: Get source description: '' operationId: getKnowledgeSource produces: - application/json parameters: - name: sourceId in: path description: Source ID required: true type: string - name: expand in: query description: Optional fields to expand for the Source. required: false type: array items: type: string enum: - lastSync - filterDetails - connection collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/V3SourceExpandableResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Input parameters do not match the required criteria. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Source not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:source:view x-purecloud-method-name: getKnowledgeSource put: tags: - Knowledge summary: Update the source description: '' operationId: putKnowledgeSource produces: - application/json parameters: - name: sourceId in: path description: Source ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/V3SourceUpdateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/V3SourceDetailedResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Input parameters do not match the required criteria. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Source not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. in.use: A sync is running on the source and cannot be updated. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:source:edit x-purecloud-method-name: putKnowledgeSource delete: tags: - Knowledge summary: Delete source description: '' operationId: deleteKnowledgeSource produces: - application/json parameters: - name: sourceId in: path description: Source ID required: true type: string responses: '204': description: Source deleted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Input parameters do not match the required criteria. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Source not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. in.use: The Source is in use by a knowledge setting. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:source:delete x-purecloud-method-name: deleteKnowledgeSource /api/v2/knowledge/sources: get: tags: - Knowledge summary: List sources description: '' operationId: getKnowledgeSources produces: - application/json parameters: - name: expand in: query description: Optional fields to expand for the Source. required: false type: array items: type: string enum: - lastSync - connection collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/V3SourceExpandableListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:source:view x-purecloud-method-name: getKnowledgeSources post: tags: - Knowledge summary: Create a new source description: '' operationId: postKnowledgeSources produces: - application/json parameters: - in: body name: body required: true schema: $ref: '#/definitions/V3SourceCreateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/V3SourceDetailedResponse' '201': description: Source created schema: $ref: '#/definitions/V3SourceDetailedResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: limit.reached.in.region: Source limit reached in the region. connection.authentication.error: The connection is in an invalid state. bad.request: Input parameters do not match the required criteria. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] not.found: Connection not found. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' limit.reached: Source limit reached. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:source:add x-purecloud-method-name: postKnowledgeSources /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/deletions/{fileId}: get: tags: - Knowledge summary: Get a deletion entry associated with the synchronization description: '' operationId: getKnowledgeSourceSynchronizationDeletion produces: - application/json parameters: - name: sourceId in: path description: Source ID required: true type: string - name: synchronizationId in: path description: Synchronization ID required: true type: string - name: fileId in: path description: File ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/V3SynchronizationDeletion' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:synchronizationFileDeletion:view x-purecloud-method-name: getKnowledgeSourceSynchronizationDeletion delete: tags: - Knowledge summary: Remove a deletion entry associated with the synchronization description: '' operationId: deleteKnowledgeSourceSynchronizationDeletion produces: - application/json parameters: - name: sourceId in: path description: Source ID required: true type: string - name: synchronizationId in: path description: Synchronization ID required: true type: string - name: fileId in: path description: File ID required: true type: string responses: '204': description: Deletion entry removed '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Input parameters do not match the required criteria. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Deletion entry not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:synchronizationFileDeletion:delete x-purecloud-method-name: deleteKnowledgeSourceSynchronizationDeletion /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/deletions: get: tags: - Knowledge summary: Get deletion entries associated with the synchronization. description: '' operationId: getKnowledgeSourceSynchronizationDeletions produces: - application/json parameters: - name: sourceId in: path description: Source ID required: true type: string - name: synchronizationId in: path description: Synchronization ID required: true type: string - name: before in: query description: The cursor that points to the start of the set of entities that has been returned. required: false type: string - name: after in: query description: The cursor that points to the end of the set of entities that has been returned. required: false type: string - name: pageSize in: query description: Number of entities to return. Maximum of 200. required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/V3SynchronizationDeletionListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:synchronizationFileDeletion:view x-purecloud-method-name: getKnowledgeSourceSynchronizationDeletions post: tags: - Knowledge summary: Mark a previously synced file for deletion in the synchronization. description: '' operationId: postKnowledgeSourceSynchronizationDeletions consumes: - application/json produces: - application/json parameters: - name: sourceId in: path description: Source ID required: true type: string - name: synchronizationId in: path description: Synchronization ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/V3SynchronizationFileDeletionRequest' responses: '201': description: File marked for deletion. schema: $ref: '#/definitions/V3SynchronizationDeletion' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Provide either id or fileName, but not both. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. conflict: Invalid source type or sync status for this operation. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:synchronization:deleteFile x-purecloud-method-name: postKnowledgeSourceSynchronizationDeletions /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}: get: tags: - Knowledge summary: Get a specific synchronization of a source. description: '' operationId: getKnowledgeSourceSynchronization produces: - application/json parameters: - name: sourceId in: path description: Source ID required: true type: string - name: synchronizationId in: path description: Synchronization ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/V3Synchronization' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:synchronization:view x-purecloud-method-name: getKnowledgeSourceSynchronization patch: tags: - Knowledge summary: Update synchronization. description: '' operationId: patchKnowledgeSourceSynchronization consumes: - application/json produces: - application/json parameters: - name: sourceId in: path description: Source ID required: true type: string - name: synchronizationId in: path description: Synchronization ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/V3SynchronizationUpdateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/V3Synchronization' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. conflict: Invalid source type or sync status for this operation. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:synchronization:edit x-purecloud-method-name: patchKnowledgeSourceSynchronization /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/uploads/{fileId}: get: tags: - Knowledge summary: Get a file upload entry associated with the synchronization description: '' operationId: getKnowledgeSourceSynchronizationUpload produces: - application/json parameters: - name: sourceId in: path description: Source ID required: true type: string - name: synchronizationId in: path description: Synchronization ID required: true type: string - name: fileId in: path description: File ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/V3SynchronizationUpload' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:synchronizationFileUpload:view x-purecloud-method-name: getKnowledgeSourceSynchronizationUpload delete: tags: - Knowledge summary: Remove a file upload entry associated with the synchronization description: '' operationId: deleteKnowledgeSourceSynchronizationUpload produces: - application/json parameters: - name: sourceId in: path description: Source ID required: true type: string - name: synchronizationId in: path description: Synchronization ID required: true type: string - name: fileId in: path description: File ID required: true type: string responses: '204': description: File upload entry removed '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Input parameters do not match the required criteria. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: File upload entry not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:synchronizationFileUpload:delete x-purecloud-method-name: deleteKnowledgeSourceSynchronizationUpload /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/uploads: get: tags: - Knowledge summary: Get file upload entries associated with the synchronization description: '' operationId: getKnowledgeSourceSynchronizationUploads produces: - application/json parameters: - name: sourceId in: path description: Source ID required: true type: string - name: synchronizationId in: path description: Synchronization ID required: true type: string - name: before in: query description: The cursor that points to the start of the set of entities that has been returned. required: false type: string - name: after in: query description: The cursor that points to the end of the set of entities that has been returned. required: false type: string - name: pageSize in: query description: Number of entities to return. Maximum of 200. required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/V3SynchronizationUploadListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:synchronizationFileUpload:view x-purecloud-method-name: getKnowledgeSourceSynchronizationUploads post: tags: - Knowledge summary: Create presigned URL for uploading a file in the synchronization. description: '' operationId: postKnowledgeSourceSynchronizationUploads consumes: - application/json produces: - application/json parameters: - name: sourceId in: path description: Source ID required: true type: string - name: synchronizationId in: path description: Synchronization ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/V3SynchronizationUploadUrlRequest' responses: '201': description: Presigned url created. schema: $ref: '#/definitions/V3SynchronizationUploadUrlResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. conflict: Invalid source type or sync status for this operation. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:synchronization:upload x-purecloud-method-name: postKnowledgeSourceSynchronizationUploads /api/v2/knowledge/sources/{sourceId}/synchronizations: get: tags: - Knowledge summary: Get synchronizations of a source. description: '' operationId: getKnowledgeSourceSynchronizations produces: - application/json parameters: - name: sourceId in: path description: Source ID required: true type: string - name: before in: query description: The cursor that points to the start of the set of entities that has been returned. required: false type: string - name: after in: query description: The cursor that points to the end of the set of entities that has been returned. required: false type: string - name: pageSize in: query description: Number of entities to return. Maximum of 200. required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/V3SynchronizationListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:synchronization:view x-purecloud-method-name: getKnowledgeSourceSynchronizations post: tags: - Knowledge summary: Start a manual synchronization from a source. description: '' operationId: postKnowledgeSourceSynchronizations produces: - application/json parameters: - name: sourceId in: path description: Source ID required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/V3StartManualSyncRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/V3Synchronization' '202': description: Accepted schema: $ref: '#/definitions/V3Synchronization' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. in.use: A sync is already running on the source. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge x-inin-requires-permissions: type: ALL permissions: - knowledge:synchronization:add x-purecloud-method-name: postKnowledgeSourceSynchronizations /api/v2/knowledge/sources/synchronizations: get: tags: - Knowledge summary: Get synchronizations of all sources of the organization. description: '' operationId: getKnowledgeSourcesSynchronizations produces: - application/json parameters: - name: before in: query description: The cursor that points to the start of the set of entities that has been returned. required: false type: string - name: after in: query description: The cursor that points to the end of the set of entities that has been returned. required: false type: string - name: pageSize in: query description: Number of entities to return. Maximum of 200. required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/V3SynchronizationListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - knowledge - knowledge:readonly x-inin-requires-permissions: type: ALL permissions: - knowledge:synchronization:view x-purecloud-method-name: getKnowledgeSourcesSynchronizations /api/v2/knowledge/guest/sessions/{sessionId}/documents/answers: post: tags: - Knowledge summary: Answer documents. description: '' operationId: postKnowledgeGuestSessionDocumentsAnswers produces: - application/json parameters: - name: sessionId in: path description: Knowledge guest session ID. required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/KnowledgeDocumentsAnswerFilter' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeGuestAnswerDocumentsResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: session.not.found: Session not found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. x-purecloud-method-name: postKnowledgeGuestSessionDocumentsAnswers /api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/feedback: post: tags: - Knowledge summary: Give feedback on a document description: '' operationId: postKnowledgeGuestSessionDocumentFeedback produces: - application/json parameters: - name: sessionId in: path description: Knowledge guest session ID. required: true type: string - name: documentId in: path description: Document ID. required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/KnowledgeGuestDocumentFeedback' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeGuestDocumentFeedback' '201': description: Created schema: $ref: '#/definitions/KnowledgeGuestDocumentFeedback' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: session.not.found: Session not found. not.found: Document version or variation not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. x-purecloud-method-name: postKnowledgeGuestSessionDocumentFeedback /api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}: get: tags: - Knowledge summary: Get a knowledge document by ID. description: '' operationId: getKnowledgeGuestSessionDocument produces: - application/json parameters: - name: sessionId in: path description: Knowledge guest session ID. required: true type: string - name: documentId in: path description: Document ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeGuestDocumentResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: session.not.found: Session not found. not.found: Document not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. x-purecloud-method-name: getKnowledgeGuestSessionDocument /api/v2/knowledge/guest/sessions/{sessionId}/documents: get: tags: - Knowledge summary: Get documents. description: '' operationId: getKnowledgeGuestSessionDocuments produces: - application/json parameters: - name: sessionId in: path description: Knowledge guest session ID. required: true type: string - name: categoryId in: query description: If specified, retrieves documents associated with category ids, comma separated values expected. required: false type: array items: type: string collectionFormat: multi - name: pageSize in: query description: Number of entities to return. Maximum of 200. required: false type: integer format: int32 responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeGuestDocumentResponseListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: session.not.found: Session not found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. x-purecloud-method-name: getKnowledgeGuestSessionDocuments /api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/copies: post: tags: - Knowledge summary: Indicate that the document was copied by the user. description: '' operationId: postKnowledgeGuestSessionDocumentCopies produces: - application/json parameters: - name: sessionId in: path description: Knowledge guest session ID. required: true type: string - name: documentId in: path description: Document ID required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/KnowledgeGuestDocumentCopy' responses: '204': description: Operation was successful '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: session.not.found: Session not found. not.found: Document not found. document.variation.not.found: Document variation not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. x-purecloud-method-name: postKnowledgeGuestSessionDocumentCopies /api/v2/knowledge/guest/sessions/{sessionId}/documents/presentations: post: tags: - Knowledge summary: Indicate that documents were presented to the user. description: '' operationId: postKnowledgeGuestSessionDocumentsPresentations produces: - application/json parameters: - name: sessionId in: path description: Knowledge guest session ID. required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/KnowledgeGuestDocumentPresentation' responses: '204': description: Operation was successful '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: session.not.found: Session not found. not.found: Document not found document.variation.not.found: Document variation not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. x-purecloud-method-name: postKnowledgeGuestSessionDocumentsPresentations /api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/views: post: tags: - Knowledge summary: Create view event for a document. description: '' operationId: postKnowledgeGuestSessionDocumentViews produces: - application/json parameters: - name: sessionId in: path description: Knowledge guest session ID. required: true type: string - name: documentId in: path description: Document ID required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/KnowledgeGuestDocumentView' responses: '204': description: Operation was successful '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: session.not.found: Session not found. not.found: Document not found. document.variation.not.found: Document variation not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. x-purecloud-method-name: postKnowledgeGuestSessionDocumentViews /api/v2/knowledge/guest/sessions/{sessionId}/categories: get: tags: - Knowledge summary: Get categories description: '' operationId: getKnowledgeGuestSessionCategories produces: - application/json parameters: - name: sessionId in: path description: Knowledge guest session ID. required: true type: string - name: before in: query description: The cursor that points to the start of the set of entities that has been returned. required: false type: string - name: after in: query description: The cursor that points to the end of the set of entities that has been returned. required: false type: string - name: pageSize in: query description: Number of entities to return. Maximum of 200. required: false type: string - name: parentId in: query description: If specified, retrieves the children categories by parent category ID. required: false type: string - name: isRoot in: query description: If specified, retrieves only the root categories. required: false type: boolean - name: name in: query description: Filter to return the categories that starts with the given category name. required: false type: string - name: sortBy in: query description: 'Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically' required: false type: string default: Name enum: - Name - Hierarchy - name: expand in: query description: 'The specified entity attribute will be filled. Supported value:"Ancestors": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors.' required: false type: string - name: includeDocumentCount in: query description: If specified, retrieves the number of documents related to category. required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/GuestCategoryResponseListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: Input parameters do not match the required criteria invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: knowledgebase.not.found: Knowledge Base does not exist session.not.found: Session not found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. x-purecloud-method-name: getKnowledgeGuestSessionCategories /api/v2/knowledge/guest/sessions/{sessionId}/documents/search: post: tags: - Knowledge summary: Search the documents in a guest session. description: '' operationId: postKnowledgeGuestSessionDocumentsSearch produces: - application/json parameters: - name: sessionId in: path description: Knowledge guest session ID. required: true type: string - name: expand in: query description: Fields, if any, to expand for each document in the search result matching the query. required: false type: array items: type: string enum: - documentVariations - documentAlternatives - knowledgeBaseLanguageCode collectionFormat: multi - in: body name: body required: false schema: $ref: '#/definitions/KnowledgeDocumentGuestSearchRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeDocumentGuestSearch' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: The minimum characters for the query is 3. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: session.not.found: Session not found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. x-purecloud-method-name: postKnowledgeGuestSessionDocumentsSearch /api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions: post: tags: - Knowledge summary: Query the knowledge documents to provide suggestions for auto completion. description: '' operationId: postKnowledgeGuestSessionDocumentsSearchSuggestions produces: - application/json parameters: - name: sessionId in: path description: Knowledge guest session ID. required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/KnowledgeGuestDocumentSuggestionRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeGuestDocumentSuggestion' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: session.not.found: Session not found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. x-purecloud-method-name: postKnowledgeGuestSessionDocumentsSearchSuggestions /api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId}: patch: tags: - Knowledge summary: Update search result. description: '' operationId: patchKnowledgeGuestSessionDocumentsSearchSearchId produces: - application/json parameters: - name: sessionId in: path description: Knowledge guest session ID. required: true type: string - name: searchId in: path description: Search Result ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/SearchUpdateRequest' responses: '204': description: Search updated successfully. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: Invalid document Id. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: session.not.found: Session not found. not.found: Search not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. x-purecloud-method-name: patchKnowledgeGuestSessionDocumentsSearchSearchId /api/v2/knowledge/guest/sessions: post: tags: - Knowledge summary: Create guest session description: '' operationId: postKnowledgeGuestSessions produces: - application/json parameters: - in: body name: body required: true schema: $ref: '#/definitions/KnowledgeGuestSession' responses: '200': description: successful operation schema: $ref: '#/definitions/KnowledgeGuestSession' '201': description: Created schema: $ref: '#/definitions/KnowledgeGuestSession' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: support.center.knowledge.base.id.not.set: Knowledge base id is not set in support center configuration (when app.type is SupportCenter). bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] messenger.knowledge.base.not.enabled: The knowledge base app is not enabled in the messenger deployment (when app.type is MessengerKnowledgeApp). invalid.context.specified: The context not found in the knowledgebase. messenger.knowledge.base.id.not.set: The knowledge base id is not set in the messenger deployment (when app.type is MessengerKnowledgeApp). constraint.validation: '%s' app.not.found: The app not found by deploymentId. knowledge.base.not.found: The knowledge base specified in the deployment configuration was not found. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' support.center.not.enabled: Support center is not enabled in the deployment (when app.type is SupportCenter). '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. x-purecloud-method-name: postKnowledgeGuestSessions definitions: V3SourceFilter: type: object required: - folders - site properties: site: type: string description: The site from which to sync data. folders: type: array description: The folders from which to sync data. items: type: string KnowledgeSearchPreviewRequest: type: object required: - generationSetting - query - sources properties: query: type: string description: Query to search content in the knowledge sources. sources: type: array description: Source information to search upon. items: $ref: '#/definitions/V3SourceRef' generationSetting: description: Setting for answer generation. $ref: '#/definitions/KnowledgeGenerationSetting' stateful: type: boolean description: Indicates if stateful search and generation is enabled for the knowledge setting. conversationTurns: type: array description: List of conversation turns to use for stateful search. items: $ref: '#/definitions/KnowledgeConversationTurn' filter: description: Composite tag filter applied to the search preview. $ref: '#/definitions/V3SourceTagFilter' application: description: The touchpoint application to simulate for the preview. $ref: '#/definitions/V3KnowledgeSearchPreviewClientApplication' conversationContext: description: The channel context to simulate for the preview. $ref: '#/definitions/KnowledgeV3PreviewConversationContext' AddressableEntityRef: type: object properties: id: type: string selfUri: type: string format: uri KnowledgeImportJobSettings: type: object properties: importAsNew: type: boolean description: If enabled import creates a new document even if update is available. visible: type: boolean description: If specified, import will override the visibility of the imported documents. categoryId: type: string description: If specified, import will override the category of the imported documents. labelIds: type: array description: If specified, import will add this labels to the imported documents. items: type: string V3SynchronizationUploadMetadata: type: object properties: originUri: type: string description: The origin URI of the file to upload tags: type: array description: List of tags that is used for filtering items: $ref: '#/definitions/FabricTag' DocumentTextProperties: type: object properties: fontSize: type: string description: The font size for the text. The valid values in 'em'. enum: - XxSmall - XSmall - Small - Medium - Large - XLarge - XxLarge - XxxLarge textColor: type: string description: 'The text color for the text. The valid values in hex color code representation. For example black color - #000000' backgroundColor: type: string description: 'The background color for the text. The valid values in hex color code representation. For example black color - #000000' KnowledgeDocumentVersion: type: object required: - restoreFromVersionId properties: id: type: string description: Globally unique identifier for the document version. readOnly: true datePublished: type: string format: date-time description: 'Published date of document version. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true document: description: The document which is versioned. readOnly: true $ref: '#/definitions/KnowledgeDocumentResponse' restoreFromVersionId: type: string description: The globally unique identifier for the document version. If the value is provided, the document is restored to the given version. If not, it publishes the draft changes as a new version of the document. versionNumber: type: integer format: int32 description: Version Number of the document. readOnly: true dateExpires: type: string format: date-time description: 'Expiry date of document version, applicable only to the ''Archived'' version of the document. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true DocumentListContentBlock: type: object required: - type properties: type: type: string description: The type of the list block. enum: - Text - Image - OrderedList - UnorderedList - Video text: description: Text. It must contain a value if the type of the block is Text. $ref: '#/definitions/DocumentText' image: description: Image. It must contain a value if the type of the block is Image. $ref: '#/definitions/DocumentBodyImage' video: description: Video. It must contain a value if the type of the block is Video. $ref: '#/definitions/DocumentBodyVideo' list: description: List. It must contain a value if the type of the block is UnorderedList or OrderedList. $ref: '#/definitions/DocumentBodyList' KnowledgeBaseListing: type: object properties: entities: type: array items: $ref: '#/definitions/KnowledgeBase' nextUri: type: string selfUri: type: string previousUri: type: string SyncStatusRequest: type: object required: - status properties: status: type: string description: New status for an existing sync operation enum: - Created - ValidationInProgress - ValidationCompleted - ValidationFailed - Started - InProgress - Completed - PartialCompleted - Failed - AbortRequested - Aborted DocumentContentBlockWithHighlight: type: object required: - type properties: type: type: string description: The type of the paragraph block. enum: - Text - Image - Video text: description: Text. It must contain a value if the type of the block is Text. $ref: '#/definitions/DocumentText' image: description: Image. It must contain a value if the type of the block is Image. $ref: '#/definitions/DocumentBodyImage' video: description: Video. It must contain a value if the type of the block is Video. $ref: '#/definitions/DocumentBodyVideo' answerHighlight: description: The block highlight data. $ref: '#/definitions/DocumentContentHighlightIndex' UnansweredPhrase: type: object properties: id: type: string description: Id of an unanswered phrase text: type: string description: Phrase text of an unanswered phrase unlinkedPhraseHitCount: type: integer format: int32 description: Hit count of an unlinked phrase SourceBaseResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: Name of the source. dateCreated: type: string format: date-time description: 'Source creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Source last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' type: type: string description: The source type. enum: - Salesforce - ServiceNow integration: description: The reference to the integration associated with the source. $ref: '#/definitions/KnowledgeIntegrationReference' schedulePeriod: type: integer format: int32 description: The schedule period of the source in hours. lastSync: description: Additional information about the last synchronization of the source. $ref: '#/definitions/SourceLastSync' selfUri: type: string format: uri description: The URI for this object readOnly: true GuestCategoryReference: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeGuestDocumentVariation: type: object required: - contexts properties: id: type: string description: The globally unique identifier for the variation. readOnly: true dateCreated: type: string format: date-time description: 'The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true documentVersion: description: The version of the document. $ref: '#/definitions/AddressableEntityRef' contexts: type: array description: The context values associated with the variation. items: $ref: '#/definitions/KnowledgeGuestDocumentVariationContext' document: description: The reference to document to which the variation is associated. readOnly: true $ref: '#/definitions/AddressableEntityRef' body: description: The content for the variation. $ref: '#/definitions/DocumentBody' selfUri: type: string format: uri description: The URI for this object readOnly: true DocumentBodyTableRowBlockWithHighlight: type: object required: - cells properties: properties: description: The properties for the table rows. $ref: '#/definitions/DocumentBodyTableRowBlockProperties' cells: type: array description: The list of cells for the table. items: $ref: '#/definitions/DocumentBodyTableCellBlockWithHighlight' KnowledgeOperationSource: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true type: type: string description: The source type. enum: - Salesforce - ServiceNow selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeDocumentFeedbackResponse: type: object required: - documentVariation - rating properties: id: type: string description: The globally unique identifier for the object. readOnly: true documentVariation: description: The variation of the document on which feedback was given. $ref: '#/definitions/EntityReference' rating: type: string description: Feedback rating. enum: - Negative - Positive reason: type: string description: Feedback reason. enum: - DocumentContent - SearchResults comment: type: string description: 'Free-text comment of the feedback. Maximum length: 2000 characters.' minLength: 0 maxLength: 2000 search: description: The search that surfaced the document on which feedback was given. $ref: '#/definitions/EntityReference' sessionId: type: string description: Knowledge guest session ID. readOnly: true dateCreated: type: string format: date-time description: 'The date and time of the feedback. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true queryType: type: string description: The type of the query that surfaced the document on which the feedback was given. enum: - Unknown - Article - AutoSearch - Category - ManualSearch - Recommendation - Suggestion - ExpandedArticle surfacingMethod: type: string description: 'The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown.' enum: - Unknown - Article - Snippet - Highlight - Generative state: type: string description: The state of the feedback. enum: - Draft - Final document: description: The document on which feedback was given. $ref: '#/definitions/KnowledgeDocumentVersionReference' application: description: The client application from which feedback was given. $ref: '#/definitions/KnowledgeSearchClientApplication' conversationContext: description: Conversation context information if the feedback is given in the context of a conversation. $ref: '#/definitions/KnowledgeConversationContextResponse' user: description: The user who created the feedback. readOnly: true $ref: '#/definitions/AddressableEntityRef' selfUri: type: string format: uri description: The URI for this object readOnly: true CreateUploadSourceUrlJobResponse: type: object properties: id: type: string description: Id of the upload from URL job. selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeDocumentReq: type: object required: - title properties: id: type: string description: The globally unique identifier for the object. readOnly: true title: type: string description: Document title. visible: type: boolean description: Indicates if the knowledge document should be included in search results. alternatives: type: array description: List of alternate phrases related to the title which improves search results. items: $ref: '#/definitions/KnowledgeDocumentAlternative' categoryId: type: string description: The category associated with the document. labelIds: type: array description: The ids of labels associated with the document. items: type: string externalId: type: string description: The external id associated with the document. externalUrl: type: string description: The URL to external document. selfUri: type: string format: uri description: The URI for this object readOnly: true ConnectionOptionListing: type: object properties: entities: type: array items: $ref: '#/definitions/ConnectionOption' nextUri: type: string selfUri: type: string previousUri: type: string KnowledgeDocumentChunkRequest: type: object required: - query properties: query: type: string description: Query to search chunks in the knowledge base. minLength: 3 maxLength: 2147483647 pageSize: type: integer format: int32 description: Page size of the returned results. pageNumber: type: integer format: int32 description: Page number of the returned results. filter: description: Filter for the document chunks. $ref: '#/definitions/DocumentQuery' queryType: type: string description: The type of the query that initiates the chunks search. enum: - AutoSearch - ManualSearch - Suggestion preprocessQuery: type: boolean description: Indicates whether the chunks search query should be preprocessed. includeDraftDocuments: type: boolean description: Indicates whether the chunk results would also include draft documents. application: description: The client application details from which chunks request was sent. $ref: '#/definitions/KnowledgeSearchClientApplication' conversationContext: description: Conversation context information if the chunks search is initiated in the context of a conversation. $ref: '#/definitions/KnowledgeConversationContext' confidenceThreshold: type: number format: float description: The confidence threshold for the chunk results. If applied, the returned results will have an equal or higher confidence than the threshold. The value should be between 0 to 1. KnowledgeSearchClientApplication: type: object required: - type properties: type: type: string description: Application type. enum: - Assistant - BotFlow - MessengerKnowledgeApp - SmartAdvisor - SupportCenter deployment: description: Application details when type is MessengerKnowledgeApp or SupportCenter. $ref: '#/definitions/AddressableEntityRef' botFlow: description: Application details when type is BotFlow. $ref: '#/definitions/AddressableEntityRef' assistant: description: Application details when type is Assistant. $ref: '#/definitions/AddressableEntityRef' V3SourceScheduleSettings: type: object required: - dateStart - period properties: dateStart: type: string format: date-time description: 'The date-time value of the first sync run. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' period: type: integer format: int32 description: The time between syncs, in hours, until a new sync is run. LabelResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the label. color: type: string description: The color of the label. dateCreated: type: string format: date-time description: 'The creation date and time of the label. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'The last modification date and time of the label. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' documentCount: type: integer format: int32 description: Number of documents assigned to this label. externalId: type: string description: The external id associated with the label. selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeGuestDocumentVariationAnswer: type: object required: - contexts properties: id: type: string description: The globally unique identifier for the variation. readOnly: true dateCreated: type: string format: date-time description: 'The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true documentVersion: description: The version of the document. $ref: '#/definitions/AddressableEntityRef' contexts: type: array description: The context values associated with the variation. items: $ref: '#/definitions/KnowledgeGuestDocumentVariationContext' document: description: The reference to document to which the variation is associated. readOnly: true $ref: '#/definitions/AddressableEntityRef' body: description: The content for the variation. $ref: '#/definitions/DocumentBodyWithHighlight' selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeDocumentSearchVariation: type: object required: - contexts properties: id: type: string description: The globally unique identifier for the variation. readOnly: true dateCreated: type: string format: date-time description: 'The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true documentVersion: description: The version of the document. $ref: '#/definitions/AddressableEntityRef' contexts: type: array description: The context values associated with the variation. items: $ref: '#/definitions/DocumentVariationContext' document: description: The reference to document to which the variation is associated. readOnly: true $ref: '#/definitions/KnowledgeDocumentReference' priority: type: integer format: int32 description: The priority of the variation. name: type: string description: The name of the variation. body: description: The content for the variation. $ref: '#/definitions/DocumentBodyWithHighlight' chunks: type: array description: The chunk blocks associated with the variation. items: $ref: '#/definitions/DocumentVariationSearchChunkBlock' selfUri: type: string format: uri description: The URI for this object readOnly: true V3KnowledgeSearchPreviewClientApplication: type: object required: - type properties: type: type: string description: The application type to simulate for the preview. enum: - BotFlow - SmartAdvisor SourceLastSync: type: object properties: state: type: string description: State of the last synchronization. enum: - Success - Failed - InProgress - Unknown dateStarted: type: string format: date-time description: 'Last synchronization start-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateEnded: type: string format: date-time description: 'Last synchronization end-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' error: description: Optional error message of the last synchronization. $ref: '#/definitions/ErrorBody' KnowledgeDocumentResponseListing: type: object properties: entities: type: array items: $ref: '#/definitions/KnowledgeDocumentResponse' nextUri: type: string selfUri: type: string previousUri: type: string DocumentBodyBlockWithHighlight: type: object required: - type properties: type: type: string description: The type of the block for the body. This determines which body block object (paragraph, list, video, image or table) would have a value. enum: - Paragraph - Image - Video - OrderedList - UnorderedList - Table image: description: Image. It must contain a value if the type of the block is Image. $ref: '#/definitions/DocumentBodyImage' video: description: Video. It must contain a value if the type of the block is Video. $ref: '#/definitions/DocumentBodyVideo' paragraph: description: Paragraph. It must contain a value if the type of the block is Paragraph. $ref: '#/definitions/DocumentBodyParagraphWithHighlight' list: description: List. It must contain a value if the type of the block is UnorderedList or OrderedList. $ref: '#/definitions/DocumentBodyListWithHighlight' table: description: Table. It must contain a value if type of the block is Table. $ref: '#/definitions/DocumentBodyTableWithHighlight' DocumentVariationResponse: type: object required: - contexts properties: id: type: string description: The globally unique identifier for the variation. readOnly: true dateCreated: type: string format: date-time description: 'The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true documentVersion: description: The version of the document. $ref: '#/definitions/AddressableEntityRef' contexts: type: array description: The context values associated with the variation. items: $ref: '#/definitions/DocumentVariationContext' document: description: The reference to document to which the variation is associated. readOnly: true $ref: '#/definitions/KnowledgeDocumentReference' priority: type: integer format: int32 description: The priority of the variation. name: type: string description: The name of the variation. body: description: The content for the variation. $ref: '#/definitions/DocumentBody' selfUri: type: string format: uri description: The URI for this object readOnly: true ConnectionResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the connection. type: type: string description: Type of the connection. enum: - Sharepoint integration: description: The reference to the integration associated with the connection. $ref: '#/definitions/KnowledgeIntegrationReference' authenticationProperties: description: Authentication properties which can be used to initiate authentication of a user. $ref: '#/definitions/AuthenticationProperties' createdBy: description: Reference of the creator. $ref: '#/definitions/UserReference' modifiedBy: description: Reference of the user whom modified the connection. $ref: '#/definitions/UserReference' dateCreated: type: string format: date-time description: 'Date of the creation of connection. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Date of the last modification made to the connection. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' status: type: string description: Current status of the connection. enum: - Created - Connected - Expired - Failed error: description: Optional error message of the connection. $ref: '#/definitions/ErrorBody' dateExpiry: type: string format: date-time description: 'Expiry date of the authentication credentials. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' selfUri: type: string format: uri description: The URI for this object readOnly: true DocumentListContentBlockWithHighlight: type: object required: - type properties: type: type: string description: The type of the list block. enum: - Text - Image - OrderedList - UnorderedList - Video text: description: Text. It must contain a value if the type of the block is Text. $ref: '#/definitions/DocumentText' image: description: Image. It must contain a value if the type of the block is Image. $ref: '#/definitions/DocumentBodyImage' video: description: Video. It must contain a value if the type of the block is Video. $ref: '#/definitions/DocumentBodyVideo' list: description: List. It must contain a value if the type of the block is UnorderedList or OrderedList. $ref: '#/definitions/DocumentBodyListWithHighlight' answerHighlight: description: The block highlight data. $ref: '#/definitions/DocumentContentHighlightIndex' DocumentBodyTableCellBlock: type: object required: - blocks properties: properties: description: The properties for the table cell. $ref: '#/definitions/DocumentBodyTableCellBlockProperties' blocks: type: array description: The list of content blocks for the table. items: $ref: '#/definitions/DocumentTableContentBlock' KnowledgeDocumentQueryResult: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true title: type: string description: Document title, having a limit of 500 words. visible: type: boolean description: Indicates if the knowledge document should be included in search results. alternatives: type: array description: List of alternate phrases related to the title which improves search results. items: $ref: '#/definitions/KnowledgeDocumentAlternative' state: type: string description: State of the document. enum: - Draft - Published - Archived dateCreated: type: string format: date-time description: 'Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateImported: type: string format: date-time description: 'Document import date-time, or null if was not imported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' lastPublishedVersionNumber: type: integer format: int32 description: The last published version number of the document. datePublished: type: string format: date-time description: 'The date on which the document was last published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' createdBy: description: The user who created the document. readOnly: true $ref: '#/definitions/UserReference' modifiedBy: description: The user who modified the document. readOnly: true $ref: '#/definitions/UserReference' documentVersion: description: The version of the document. $ref: '#/definitions/AddressableEntityRef' category: description: The reference to category associated with the document. $ref: '#/definitions/CategoryResponse' labels: type: array description: The references to labels associated with the document. items: $ref: '#/definitions/LabelResponse' knowledgeBase: description: Knowledge base to which the document belongs to. $ref: '#/definitions/KnowledgeBaseReference' externalId: type: string description: The reference to external id associated with the document. externalUrl: type: string description: The URL to external document. source: description: The reference to source associated with the document. $ref: '#/definitions/AddressableEntityRef' readonly: type: boolean description: Whether the document is read-only. variations: type: array description: Variations of the document. items: $ref: '#/definitions/KnowledgeDocumentQueryVariation' selfUri: type: string format: uri description: The URI for this object readOnly: true CategoryReference: type: object required: - id properties: id: type: string description: The globally unique identifier for the category. name: type: string description: Category name. parentCategory: description: The reference to category to which this category belongs to. $ref: '#/definitions/CategoryReference' selfUri: type: string format: uri description: The URI for this object readOnly: true V3KnowledgeSearchClientApplication: type: object required: - type properties: type: type: string description: Application type. enum: - BotFlow - SmartAdvisor botFlow: description: Application details when type is BotFlow. $ref: '#/definitions/AddressableEntityRef' assistant: description: Application details when type is Assistant. $ref: '#/definitions/AddressableEntityRef' KnowledgeExportJobDocumentsFilter: type: object properties: interval: type: string format: interval description: 'Retrieves the documents modified in specified date and time range. Cannot be used together with entities filter. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss' entities: type: array description: Retrieves the documents with the given ids. Cannot be used together with internal filter. items: $ref: '#/definitions/Entity' maxItems: 100 minItems: 1 sourceId: type: string ChunkSearchRegisterRequest: type: object required: - answered properties: sessionId: type: string description: The unique identifier of this session answered: type: boolean description: Mark the chunks search as answered/unanswered selectedAnswers: type: array description: The search results selected as answers items: $ref: '#/definitions/SelectedAnswer' KnowledgeDocumentSearch: type: object required: - query properties: query: type: string description: Query to search content in the knowledge base. Maximum of 30 records per query can be fetched. minLength: 3 maxLength: 2147483647 pageSize: type: integer format: int32 description: Page size of the returned results. pageNumber: type: integer format: int32 description: Page number of the returned results. searchId: type: string description: The globally unique identifier for the search. readOnly: true total: type: integer format: int32 description: The total number of documents matching the query. readOnly: true pageCount: type: integer format: int32 description: Number of pages returned in the result calculated according to the pageSize and the total readOnly: true queryType: type: string description: The type of the query that initiates the search. enum: - AutoSearch - ManualSearch - Suggestion results: type: array description: Documents matching the search query. readOnly: true items: $ref: '#/definitions/KnowledgeDocumentSearchResult' application: description: The client application details from which search happened. $ref: '#/definitions/KnowledgeSearchClientApplication' conversationContext: description: Conversation context information if the search is initiated in the context of a conversation. $ref: '#/definitions/KnowledgeConversationContextResponse' confidenceThreshold: type: number format: float description: The confidence threshold for the search results. If applied, the returned results will have an equal or higher confidence than the threshold. answerGeneration: description: The results with AI-generated answer if the answerMode request property contains "AnswerGeneration". $ref: '#/definitions/KnowledgeAnswerGenerationResponse' preprocessQuery: type: boolean description: Indicates whether the search query should be preprocessed. WritableEntity: type: object properties: id: type: string description: The globally unique identifier for the object. KnowledgeBase: type: object required: - coreLanguage properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: type: string description: Knowledge base description coreLanguage: type: string example: en-US description: Core language for knowledge base in which initial content must be created, language codes [en-US, en-UK, en-AU, de-DE] are supported currently. However, the new DX knowledge will support all these language codes, along with 'early preview' language codes [ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA] which might have a lower accuracy. enum: - en-US - en-UK - en-AU - en-CA - en-HK - en-IN - en-IE - en-NZ - en-PH - en-SG - en-ZA - de-DE - de-AT - de-CH - es-AR - es-CO - es-MX - es-US - es-ES - fr-FR - fr-BE - fr-CA - fr-CH - pt-BR - pt-PT - nl-NL - nl-BE - it-IT - ca-ES - tr-TR - sv-SE - fi-FI - nb-NO - da-DK - ja-JP - ar-AE - zh-CN - zh-TW - zh-HK - ko-KR - pl-PL - hi-IN - th-TH - hu-HU - vi-VN - uk-UA - cs-CZ - fil-PH - ms-MY - he-IL - el-GR dateCreated: type: string format: date-time description: 'Knowledge base creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Knowledge base last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true faqCount: type: integer format: int32 description: The count representing the number of documents of type FAQ in the KnowledgeBase readOnly: true dateDocumentLastModified: type: string format: date-time description: 'The date representing when the last document is modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true articleCount: type: integer format: int32 description: The count representing the number of documents of type Article in the KnowledgeBase readOnly: true published: type: boolean description: Flag that indicates the knowledge base is published readOnly: true contentSearchEnabled: type: boolean description: Flag that indicates the search on content is enabled for the knowledge base. selfUri: type: string format: uri description: The URI for this object readOnly: true DocumentBodyTableCaptionBlock: type: object required: - blocks properties: blocks: type: array description: The list of building blocks for the caption property. items: $ref: '#/definitions/DocumentBodyTableCaptionItem' DocumentChunkReference: type: object required: - id properties: id: type: string description: The globally unique identifier for the document. title: type: string description: The title of the document. selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeSearchResult: type: object properties: generatedAnswer: type: string description: The generated answer for search query. retrievedReferences: type: array description: The retrieved references for the search query. items: $ref: '#/definitions/KnowledgeRetrievedReference' KnowledgeDocumentSuggestionResultDocument: type: object required: - id - knowledgeBase - title properties: id: type: string description: The globally unique identifier for the document. knowledgeBase: description: The knowledge base that the document belongs to. $ref: '#/definitions/KnowledgeBaseReference' title: type: string description: The title of the document. selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeGuestAnswerDocumentsResponse: type: object properties: results: type: array description: The results with answers. items: $ref: '#/definitions/KnowledgeGuestAnswerDocumentResponse' DocumentBodyListWithHighlight: type: object required: - blocks properties: properties: description: Properties for the UnorderedList or OrderedList. $ref: '#/definitions/DocumentBodyListBlockProperties' blocks: type: array description: The list of items for an OrderedList or an UnorderedList. items: $ref: '#/definitions/DocumentBodyListBlockWithHighlight' KnowledgeContextReference: type: object required: - id properties: id: type: string description: The globally unique identifier for the knowledge context. selfUri: type: string format: uri description: The URI for this object readOnly: true V3SourceFolderDetails: type: object properties: id: type: string description: The folder's id. name: type: string description: The folder's display name. fullPath: type: string description: The folder's full path from the root. LabelCreateRequest: type: object required: - color - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the label. color: type: string description: The color for the label. externalId: type: string description: The external id associated with the label. selfUri: type: string format: uri description: The URI for this object readOnly: true OperationResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true status: type: string description: Status of the operation. type: type: string description: Type of the operation. enum: - Import - Export - Parse - Sync createdBy: description: The user who created the operation. $ref: '#/definitions/UserReference' dateCreated: type: string format: date-time description: 'Operation creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Operation last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' source: description: Source of the operation. $ref: '#/definitions/KnowledgeOperationSource' selfUri: type: string format: uri description: The URI for this object readOnly: true UploadUrlResponse: type: object properties: url: type: string description: Presigned URL to PUT the file to readOnly: true uploadKey: type: string description: Key that identifies the file in the storage including the file name readOnly: true headers: type: object description: Required headers when uploading a file through PUT request to the URL readOnly: true additionalProperties: type: string KnowledgeIntegrationOptionsResponse: type: object properties: filters: type: array description: Filter setting options available for a knowledge source. items: $ref: '#/definitions/KnowledgeIntegrationFilter' DocumentBodyBlock: type: object required: - type properties: type: type: string description: The type of the block for the body. This determines which body block object (paragraph, list, video, image or table) would have a value. enum: - Paragraph - Image - Video - OrderedList - UnorderedList - Table image: description: Image. It must contain a value if the type of the block is Image. $ref: '#/definitions/DocumentBodyImage' video: description: Video. It must contain a value if the type of the block is Video. $ref: '#/definitions/DocumentBodyVideo' paragraph: description: Paragraph. It must contain a value if the type of the block is Paragraph. $ref: '#/definitions/DocumentBodyParagraph' list: description: List. It must contain a value if the type of the block is UnorderedList or OrderedList. $ref: '#/definitions/DocumentBodyList' table: description: Table. It must contain a value if type of the block is Table. $ref: '#/definitions/DocumentBodyTable' V3SynchronizationUploadUrlResponse: type: object properties: fileId: type: string description: The unique identifier for the upload object. fileName: type: string description: Name of the uploaded file. metadata: description: The metadata of the uploaded file $ref: '#/definitions/V3SynchronizationUploadMetadata' synchronization: description: The synchronization of the file upload. $ref: '#/definitions/V3SynchronizationRef' url: type: string description: Pre-signed URL to PUT the file to. headers: type: object description: Required headers when uploading a file through PUT request to the URL. additionalProperties: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeDocumentQuery: type: object required: - filter properties: pageSize: type: integer format: int32 description: Page size of the returned results. pageNumber: type: integer format: int32 description: Page number of the returned results. includeDraftDocuments: type: boolean description: Indicates whether the results would also include draft documents. interval: description: Retrieves the documents created/modified/published in specified date and time range. $ref: '#/definitions/DocumentQueryInterval' filter: description: Filter for the document query. $ref: '#/definitions/DocumentQuery' includeVariations: type: string description: 'Indicates which document variations to include in returned documents. All: all variations regardless of the filter expression; AllMatching: all variations that match the filter expression; SingleMostRelevant: single variation that matches the filter expression and has the highest priority. The default is All.' enum: - All - AllMatching - SingleMostRelevant sortOrder: type: string description: The sort order for results. enum: - Asc - Desc sortBy: type: string description: The field in the documents that you want to sort the results by. enum: - DateCreated - DateModified - CategoryName - LabelName - ViewCount KnowledgeImportJobReport: type: object properties: errors: type: array description: List of errors occurred during processing import. items: $ref: '#/definitions/KnowledgeImportJobError' statistics: description: Statistics related to the import job. $ref: '#/definitions/KnowledgeImportJobStatistics' KnowledgeAnswerGenerationResponse: type: object properties: answer: type: string description: The AI-generated answer. documents: type: array description: The documents used for answer generation. items: $ref: '#/definitions/AnswerGenerationDocument' DocumentBodyTableRowBlockProperties: type: object properties: rowType: type: string description: The type of the table row. enum: - Header - Footer - Body alignment: type: string description: The alignment for the table row. enum: - Center - Left - Right height: type: number format: float description: The height for the table row. borderStyle: type: string description: The border style for the table row. enum: - Solid - Dotted - Dashed - Double - Groove - Ridge - Inset - Outset - Hidden - None borderColor: type: string description: 'The border color for the table row. For example black color - #000000' backgroundColor: type: string description: 'The background color for the table row. For example black color - #000000' V3SourceTagFilter: type: object properties: allOf: type: array description: Tags that must all be present (AND). items: type: string anyOfGroups: type: array description: OR groups ANDed together; within each group at least one tag must match. items: type: array items: type: string noneOf: type: array description: Tags that must not be present on matching chunks. items: type: string KnowledgeDocumentPresentation: type: object required: - application - documents properties: documents: type: array description: The presented documents items: $ref: '#/definitions/PresentedKnowledgeDocument' searchId: type: string description: The search that surfaced the documents that were presented. queryType: type: string description: The type of the query that surfaced the documents. enum: - Unknown - Article - AutoSearch - Category - ManualSearch - Recommendation - Suggestion - ExpandedArticle surfacingMethod: type: string description: 'The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown.' enum: - Unknown - Article - Snippet - Highlight - Generative sessionId: type: string description: Knowledge session ID. readOnly: true conversationContext: description: Conversation context information if the documents were presented in the context of a conversation. $ref: '#/definitions/KnowledgeConversationContext' application: description: The client application in which the documents were presented. $ref: '#/definitions/KnowledgeSearchClientApplication' KnowledgeDocumentGuestSearchRequest: type: object required: - query properties: query: type: string description: Query to search content in the knowledge base. Maximum of 30 records per query can be fetched. minLength: 3 maxLength: 2147483647 pageSize: type: integer format: int32 description: Page size of the returned results. pageNumber: type: integer format: int32 description: Page number of the returned results. searchId: type: string description: The globally unique identifier for the search. readOnly: true total: type: integer format: int32 description: The total number of documents matching the query. readOnly: true pageCount: type: integer format: int32 description: Number of pages returned in the result calculated according to the pageSize and the total readOnly: true queryType: type: string description: The type of the query that initiates the search. enum: - AutoSearch - ManualSearch - Suggestion sessionId: type: string description: Session ID of the search. readOnly: true answerHighlightTopResults: type: integer format: int32 description: The number of articles to be sent for answer-highlighting. Can range from 1-5. minimum: 1 maximum: 5 includeDraftDocuments: type: boolean description: Indicates whether the search results would also include draft documents. KnowledgeDocumentFeedback: type: object required: - application - document - documentVariation - rating properties: id: type: string description: The globally unique identifier for the object. readOnly: true documentVariation: description: The variation of the document on which feedback was given. $ref: '#/definitions/EntityReference' rating: type: string description: Feedback rating. enum: - Negative - Positive reason: type: string description: Feedback reason. enum: - DocumentContent - SearchResults comment: type: string description: 'Free-text comment of the feedback. Maximum length: 2000 characters.' minLength: 0 maxLength: 2000 search: description: The search that surfaced the document on which feedback was given. $ref: '#/definitions/EntityReference' sessionId: type: string description: Knowledge guest session ID. readOnly: true dateCreated: type: string format: date-time description: 'The date and time of the feedback. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true queryType: type: string description: The type of the query that surfaced the document on which the feedback was given. enum: - Unknown - Article - AutoSearch - Category - ManualSearch - Recommendation - Suggestion - ExpandedArticle surfacingMethod: type: string description: 'The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown.' enum: - Unknown - Article - Snippet - Highlight - Generative state: type: string description: The state of the feedback. enum: - Draft - Final document: description: The document on which feedback was given. $ref: '#/definitions/KnowledgeDocumentVersionReference' application: description: The client application from which feedback was given. $ref: '#/definitions/KnowledgeSearchClientApplication' conversationContext: description: Conversation context information if the feedback is given in the context of a conversation. $ref: '#/definitions/KnowledgeConversationContext' userId: type: string description: The ID of the user who created the feedback. readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true LabelUpdateRequest: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the label. color: type: string description: The color for the label. externalId: type: string description: The external id associated with the label. selfUri: type: string format: uri description: The URI for this object readOnly: true SalesforceSourceRequest: type: object required: - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the integration source. integrationId: type: string description: The integration associated with the source. schedulePeriod: type: integer format: int32 description: The schedule period of the source in hours. Must be at least 6 and at most 48 hours. minimum: 6 maximum: 48 settings: description: The settings of the source. $ref: '#/definitions/SalesforceSettings' selfUri: type: string format: uri description: The URI for this object readOnly: true DocumentBodyTable: type: object required: - rows properties: properties: description: The properties for the table. $ref: '#/definitions/DocumentBodyTableProperties' rows: type: array description: The list of rows for the table. items: $ref: '#/definitions/DocumentBodyTableRowBlock' KnowledgeGuestSearchClientApplication: type: object required: - type properties: type: type: string description: Application type. enum: - Assistant - BotFlow - MessengerKnowledgeApp - SmartAdvisor - SupportCenter deployment: description: Application details when type is MessengerKnowledgeApp or SupportCenter. $ref: '#/definitions/EntityReference' botFlow: description: Application details when type is BotFlow. $ref: '#/definitions/EntityReference' assistant: description: Application details when type is Assistant. $ref: '#/definitions/EntityReference' KnowledgeAnswerDocumentResponse: type: object properties: id: type: string description: The document id. title: type: string description: The document title. answer: type: string description: The answer found inside a variationContent. variation: description: The variation with the answer's highlight data. $ref: '#/definitions/DocumentVariationAnswer' KnowledgeGuestDocumentSuggestionRequest: type: object required: - query properties: query: type: string description: Query to get autocomplete suggestions for the matching knowledge documents. pageSize: type: integer format: int32 description: Page size of the returned results. includeDraftDocuments: type: boolean description: Indicates whether the suggestion results would also include draft documents. KnowledgeDocumentFeedbackResponseListing: type: object properties: entities: type: array items: $ref: '#/definitions/KnowledgeDocumentFeedbackResponse' nextUri: type: string selfUri: type: string previousUri: type: string CreateUploadSourceUrlJobRequest: type: object required: - uploadUrl properties: uploadUrl: type: string description: The URL of the content to upload. KnowledgeConversationContextResponse: type: object required: - conversation properties: conversation: description: The conversation. $ref: '#/definitions/AddressableEntityRef' queue: description: The queue used to assign the interaction to the user. $ref: '#/definitions/AddressableEntityRef' externalContact: description: The end-user participant of the conversation. $ref: '#/definitions/AddressableEntityRef' mediaType: type: string description: The media type of the conversation. enum: - Unknown - Callback - Chat - Cobrowse - Email - Message - Screenshare - Video - Voice KnowledgeGuestDocumentSuggestion: type: object required: - query properties: query: type: string description: Query to get autocomplete suggestions for the matching knowledge documents. pageSize: type: integer format: int32 description: Page size of the returned results. sessionId: type: string description: Session ID of the guest suggestions. readOnly: true results: type: array description: Suggestions matching the query. readOnly: true items: $ref: '#/definitions/KnowledgeGuestDocumentSuggestionResult' KnowledgeV3PreviewConversationContext: type: object required: - mediaType properties: mediaType: type: string description: The media type to simulate for the preview. enum: - Voice - Message KnowledgeDocumentSuggestionRequest: type: object required: - query properties: query: type: string description: Query to get autocomplete suggestions for the matching knowledge documents. pageSize: type: integer format: int32 description: Page size of the returned results. includeDraftDocuments: type: boolean description: Indicates whether the suggestion results would also include draft documents. interval: description: Retrieves the documents created/modified/published in specified date and time range. $ref: '#/definitions/DocumentQueryInterval' filter: description: Filter for the document suggestions. $ref: '#/definitions/DocumentQuery' DocumentBodyList: type: object required: - blocks properties: properties: description: Properties for the UnorderedList or OrderedList. $ref: '#/definitions/DocumentBodyListBlockProperties' blocks: type: array description: The list of items for an OrderedList or an UnorderedList. items: $ref: '#/definitions/DocumentBodyListBlock' KnowledgeImportJobResponse: type: object required: - fileType - uploadKey properties: id: type: string description: Id of the import job readOnly: true downloadURL: type: string description: The URL of the location at which the caller can download the imported file. failedEntitiesURL: type: string description: The URL of the location at which the caller can download the entities in json format that failed during the import. uploadKey: type: string description: Upload key fileType: type: string description: File type of the document enum: - Json - Csv - Xlsx settings: description: Additional optional settings $ref: '#/definitions/KnowledgeImportJobSettings' status: type: string description: Status of the import job readOnly: true enum: - Created - ValidationInProgress - ValidationCompleted - ValidationFailed - Started - InProgress - Completed - PartialCompleted - Failed - AbortRequested - Aborted report: description: Report of the import job readOnly: true $ref: '#/definitions/KnowledgeImportJobReport' knowledgeBase: description: Knowledge base which document import does belong to readOnly: true $ref: '#/definitions/KnowledgeBase' createdBy: description: The user who created the operation readOnly: true $ref: '#/definitions/UserReference' dateCreated: type: string format: date-time description: 'Created date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true skipConfirmationStep: type: boolean description: If enabled pre-validation step will be skipped. selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeDocumentResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true title: type: string description: Document title, having a limit of 500 words. visible: type: boolean description: Indicates if the knowledge document should be included in search results. alternatives: type: array description: List of alternate phrases related to the title which improves search results. items: $ref: '#/definitions/KnowledgeDocumentAlternative' state: type: string description: State of the document. enum: - Draft - Published - Archived dateCreated: type: string format: date-time description: 'Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateImported: type: string format: date-time description: 'Document import date-time, or null if was not imported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' lastPublishedVersionNumber: type: integer format: int32 description: The last published version number of the document. datePublished: type: string format: date-time description: 'The date on which the document was last published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' createdBy: description: The user who created the document. readOnly: true $ref: '#/definitions/UserReference' modifiedBy: description: The user who modified the document. readOnly: true $ref: '#/definitions/UserReference' documentVersion: description: The version of the document. $ref: '#/definitions/AddressableEntityRef' category: description: The reference to category associated with the document. $ref: '#/definitions/CategoryResponse' labels: type: array description: The references to labels associated with the document. items: $ref: '#/definitions/LabelResponse' knowledgeBase: description: Knowledge base to which the document belongs to. $ref: '#/definitions/KnowledgeBaseReference' externalId: type: string description: The reference to external id associated with the document. externalUrl: type: string description: The URL to external document. source: description: The reference to source associated with the document. $ref: '#/definitions/AddressableEntityRef' readonly: type: boolean description: Whether the document is read-only. variations: type: array description: Variations of the document. items: $ref: '#/definitions/DocumentVariationResponse' selfUri: type: string format: uri description: The URI for this object readOnly: true ConnectionListing: type: object properties: entities: type: array items: $ref: '#/definitions/ConnectionResponse' GetUploadSourceUrlJobStatusResponse: type: object properties: id: type: string description: Id of the upload from URL job. status: type: string description: Status of the upload job enum: - Created - InProgress - Completed - Failed uploadKey: type: string description: Key that identifies the file in the storage including the file name errorInformation: description: Any error information, or null of the processing is not in failed state. $ref: '#/definitions/ErrorBody' selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeDocumentSearchResult: type: object properties: confidence: type: number format: double description: The confidence associated with a document with respect to a search query. document: description: Document that matched the query. $ref: '#/definitions/KnowledgeSearchDocumentResponse' DocumentBodyTableCellBlockWithHighlight: type: object required: - blocks properties: properties: description: The properties for the table cell. $ref: '#/definitions/DocumentBodyTableCellBlockProperties' blocks: type: array description: The list of content blocks for the table. items: $ref: '#/definitions/DocumentTableContentBlockWithHighlight' DocumentVariationRequest: type: object required: - contexts properties: id: type: string description: The globally unique identifier for the variation. readOnly: true dateCreated: type: string format: date-time description: 'The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true documentVersion: description: The version of the document. $ref: '#/definitions/AddressableEntityRef' contexts: type: array description: The context values associated with the variation. items: $ref: '#/definitions/DocumentVariationContext' document: description: The reference to document to which the variation is associated. readOnly: true $ref: '#/definitions/KnowledgeDocumentReference' priority: type: integer format: int32 description: The priority of the variation. name: type: string description: The name of the variation. body: description: The content for the variation. $ref: '#/definitions/DocumentBody' selfUri: type: string format: uri description: The URI for this object readOnly: true DocumentBodyVideoProperties: type: object properties: backgroundColor: type: string description: 'The background color for the video. The valid values in hex color code representation. For example black color - #000000' align: type: string description: The align type for the video. enum: - Center - Left - Right - Justify indentation: type: number format: float description: The indentation for the video. The valid values in 'em'. width: description: The width of the video in the specified unit. $ref: '#/definitions/DocumentElementLength' height: description: The height of the video in the specified unit. $ref: '#/definitions/DocumentElementLength' SharepointAuthenticationProperties: type: object properties: authenticationUrl: type: string description: The authentication URL for the connection. tenantId: type: string description: The tenant ID for the connection. clientId: type: string description: The client ID for the connection. redirectUrl: type: string description: The redirect URL for the connection. KnowledgeSyncJobStatistics: type: object properties: countDocumentImportActivityCreate: type: integer format: int32 description: Number of documents will be created by the sync. countDocumentImportActivityUpdate: type: integer format: int32 description: Number of documents will be updated by the sync. countDocumentStateDraft: type: integer format: int32 description: Number of documents will be imported as draft. countDocumentStatePublished: type: integer format: int32 description: Number of documents will be imported as published. countDocumentImportSuccess: type: integer format: int32 description: Number of imported documents. countDocumentImportFailure: type: integer format: int32 description: Number of documents failed to import. countCategoryImportSuccess: type: integer format: int32 description: Number of imported categories. countCategoryImportFailure: type: integer format: int32 description: Number of categories failed to import. countLabelImportSuccess: type: integer format: int32 description: Number of imported labels. countLabelImportFailure: type: integer format: int32 description: Number of labels failed to import. countDocumentDeleteSuccess: type: integer format: int32 description: Number of documents will be deleted by the sync. countDocumentDeleteFailure: type: integer format: int32 description: Number of documents failed to delete. countCategoryDeleteSuccess: type: integer format: int32 description: Number of successfully deleted categories. countCategoryDeleteFailure: type: integer format: int32 description: Number of categories failed to delete. countLabelDeleteSuccess: type: integer format: int32 description: Number of successfully deleted labels. countLabelDeleteFailure: type: integer format: int32 description: Number of labels failed to delete. OperationCreatorUserResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true type: type: string description: 'Type of the operation creator entity: User or OAuthClient' enum: - User - OAuthClient selfUri: type: string format: uri description: The URI for this object readOnly: true UnansweredPhraseGroup: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true label: type: string description: Knowledge base phrase group label phrases: type: array description: List of unanswered phrases in a phrase group items: $ref: '#/definitions/UnansweredPhrase' unlinkedPhraseHitCount: type: integer format: int32 description: Hit count of the unlinked phrase group unlinkedPhraseCount: type: integer format: int32 description: Unique phrase count of the unlinked phrase group selfUri: type: string format: uri description: The URI for this object readOnly: true DocumentBodyTableCaptionItem: type: object required: - type properties: type: type: string description: The type of the caption item. enum: - Text - Paragraph - Image - Video - OrderedList - UnorderedList text: description: Text. It must contain a value if the type of the block is Text. $ref: '#/definitions/DocumentText' paragraph: description: Paragraph. It must contain a value if the type of the block is Paragraph. $ref: '#/definitions/DocumentBodyParagraph' image: description: Image. It must contain a value if the type of the block is Image. $ref: '#/definitions/DocumentBodyImage' video: description: Video. It must contain a value if the type of the block is Video. $ref: '#/definitions/DocumentBodyVideo' list: description: List. It must contain a value if the type of the block is UnorderedList or OrderedList. $ref: '#/definitions/DocumentBodyList' CategoryResponseListing: type: object properties: entities: type: array items: $ref: '#/definitions/CategoryResponse' nextUri: type: string selfUri: type: string previousUri: type: string DocumentBodyTableProperties: type: object properties: width: type: number format: float description: The width of the table converted to em unit. widthWithUnit: description: The width of the table in the specified unit. $ref: '#/definitions/DocumentElementLength' height: type: number format: float description: The height for the table. cellSpacing: type: number format: float description: The cell spacing for the table. The valid values in 'em'. cellPadding: type: number format: float description: The cell padding for the table. The valid values in 'em'. borderWidth: type: number format: float description: The border width for the table. The valid values in 'em' alignment: type: string description: The alignment for the table. enum: - Center - Left - Right borderStyle: type: string description: The border style for the table. enum: - Solid - Dotted - Dashed - Double - Groove - Ridge - Inset - Outset - Hidden - None borderColor: type: string description: 'The border color for the table. The valid values in hex color code representation. For example black color - #000000' backgroundColor: type: string description: 'The background color for the table. The valid values in hex color code representation. For example black color - #000000' caption: description: 'The caption for the table. The valid values in hex color code representation. For example black color - #000000' $ref: '#/definitions/DocumentBodyTableCaptionBlock' DocumentBodyParagraph: type: object required: - blocks properties: blocks: type: array description: The list of blocks for the paragraph. items: $ref: '#/definitions/DocumentContentBlock' properties: description: The properties for the paragraph. $ref: '#/definitions/DocumentBodyParagraphProperties' KnowledgeConversationTurn: type: object properties: participant: type: string description: The participant type. enum: - External - Internal text: type: string description: The message text. KnowledgeGuestSessionContext: type: object required: - id - values properties: id: type: string description: The context id associated with the session. values: type: array description: The list of knowledge context values associated with the session. items: $ref: '#/definitions/Entity' V3SynchronizationUpdateRequest: type: object properties: status: type: string description: The status of the synchronization. enum: - Completed - Cancelled UnansweredGroups: type: object properties: entities: type: array items: $ref: '#/definitions/UnansweredGroup' KnowledgeParseJobRequestImport: type: object properties: edits: type: array description: Override of the result of the parse. items: $ref: '#/definitions/KnowledgeParseRecord' excludes: type: array description: Excluded results. items: type: string ServiceNowSourceResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: Name of the source. dateCreated: type: string format: date-time description: 'Source creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Source last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' type: type: string description: The source type. enum: - Salesforce - ServiceNow integration: description: The reference to the integration associated with the source. $ref: '#/definitions/KnowledgeIntegrationReference' schedulePeriod: type: integer format: int32 description: The schedule period of the source in hours. lastSync: description: Additional information about the last synchronization of the source. $ref: '#/definitions/SourceLastSync' settings: description: The settings of the source. $ref: '#/definitions/ServiceNowSettings' selfUri: type: string format: uri description: The URI for this object readOnly: true BulkResult: type: object properties: error: description: Error details if the operation failed. $ref: '#/definitions/BulkError' entity: type: object description: The result of the operation if it succeeded. V3SynchronizationDeletionListing: type: object properties: entities: type: array items: $ref: '#/definitions/V3SynchronizationDeletion' nextUri: type: string selfUri: type: string previousUri: type: string KnowledgeImportJobStatistics: type: object properties: countDocumentImportActivityCreate: type: integer format: int32 description: Number of documents will be created by the import. countDocumentImportActivityUpdate: type: integer format: int32 description: Number of documents will be updated by the import. countDocumentStateDraft: type: integer format: int32 description: Number of documents will be imported as draft. countDocumentStatePublished: type: integer format: int32 description: Number of documents will be imported as published. countDocumentValidationSuccess: type: integer format: int32 description: Number of documents that validated successfully for import. countDocumentValidationFailure: type: integer format: int32 description: Number of documents that failed validation for import. countDocumentImportSuccess: type: integer format: int32 description: Number of imported documents. countDocumentImportFailure: type: integer format: int32 description: Number of documents failed to import. countCategoryValidationSuccess: type: integer format: int32 description: Number of categories that validated successfully for import. countCategoryValidationFailure: type: integer format: int32 description: Number of categories that failed validation for import. countCategoryImportSuccess: type: integer format: int32 description: Number of imported categories. countCategoryImportFailure: type: integer format: int32 description: Number of categories failed to import. countLabelValidationSuccess: type: integer format: int32 description: Number of labels that validated successfully for import. countLabelValidationFailure: type: integer format: int32 description: Number of labels that failed validation for import. countLabelImportSuccess: type: integer format: int32 description: Number of imported labels. countLabelImportFailure: type: integer format: int32 description: Number of labels failed to import. migrationDetected: type: boolean description: Shows whether the import treated as migration or not. DocumentBodyListItemProperties: type: object properties: backgroundColor: type: string description: 'The background color for the list item. The valid values in hex color code representation. For example black color - #000000' align: type: string description: The align type for the list item. enum: - Center - Left - Right - Justify indentation: type: number format: float description: The indentation property for the list item. The valid values in 'em'. fontSize: type: string description: The font size for the list item. The valid values in 'em'. enum: - XxSmall - XSmall - Small - Medium - Large - XLarge - XxLarge - XxxLarge fontType: type: string description: The font type for the list item. enum: - Paragraph - Heading1 - Heading2 - Heading3 - Heading4 - Heading5 - Heading6 - Preformatted textColor: type: string description: 'The text color for the list item. The valid values in hex color code representation. For example black color - #000000' unorderedType: type: string description: The type of icon for the unordered list. enum: - Normal - Square - Circle - None orderedType: type: string description: The type of icon for the ordered list. enum: - Number - LowerAlpha - LowerGreek - LowerRoman - UpperAlpha - UpperRoman - None V3SynchronizationRef: type: object required: - id - source properties: id: type: string description: Synchronization Id. source: description: Source. $ref: '#/definitions/V3SourceRef' selfUri: type: string format: uri description: The URI for this object readOnly: true DocumentTableContentBlock: type: object required: - type properties: type: type: string description: The type of the block for the table cell. This determines which body block object (paragraph, list, video, image or table) would have a value. enum: - Paragraph - Text - Image - Video - OrderedList - UnorderedList - Table text: description: Text. It must contain a value if the type of the block is Text. $ref: '#/definitions/DocumentText' image: description: Image. It must contain a value if the type of the block is Image. $ref: '#/definitions/DocumentBodyImage' video: description: Video. It must contain a value if the type of the block is Video. $ref: '#/definitions/DocumentBodyVideo' paragraph: description: Paragraph. It must contain a value if the type of the block is Paragraph. $ref: '#/definitions/DocumentBodyParagraph' list: description: List. It must contain a value if the type of the block is UnorderedList or OrderedList. $ref: '#/definitions/DocumentBodyList' table: description: Table. It must contain a value if the type of the block is Table. $ref: '#/definitions/DocumentBodyTable' UploadUrlRequest: type: object properties: fileName: type: string description: 'Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \{^}%`]">[~<#|' contentMd5: type: string description: Content MD5 of the file to upload signedUrlTimeoutSeconds: type: integer format: int32 description: The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds contentType: type: string description: The content type of the file to upload. Allows all MIME types serverSideEncryption: type: string enum: - AES256 DocumentBodyVideo: type: object required: - url properties: url: type: string description: The URL for the video. properties: description: The properties for the video. $ref: '#/definitions/DocumentBodyVideoProperties' KnowledgeExportJobFilter: type: object required: - versionFilter properties: documentsFilter: description: Filters for narrowing down which documents to export. $ref: '#/definitions/KnowledgeExportJobDocumentsFilter' versionFilter: type: string description: Specifies what version should be exported. enum: - All - Latest exclude: type: array description: Reduce the size of the export file by excluding certain items. uniqueItems: true items: type: string enum: - Categories - Labels - Variations ConnectionCreateResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the connection. type: type: string description: Type of the connection. enum: - Sharepoint integration: description: The reference to the integration associated with the connection. $ref: '#/definitions/KnowledgeIntegrationReference' authenticationProperties: description: Authentication properties which can be used to initiate authentication of a user. $ref: '#/definitions/AuthenticationProperties' createdBy: description: Reference of the creator. $ref: '#/definitions/UserReference' modifiedBy: description: Reference of the user whom modified the connection. $ref: '#/definitions/UserReference' dateCreated: type: string format: date-time description: 'Date of the creation of connection. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Date of the last modification made to the connection. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' status: type: string description: Current status of the connection. enum: - Created - Connected - Expired - Failed selfUri: type: string format: uri description: The URI for this object readOnly: true CategoryResponse: type: object required: - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the category. description: type: string externalId: type: string dateCreated: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' parentCategory: description: The reference to category to which this category belongs to. $ref: '#/definitions/CategoryReference' documentCount: type: integer format: int32 description: Number of documents assigned to this category. knowledgeBase: description: The reference to knowledge base to which the category belongs to. $ref: '#/definitions/KnowledgeBaseReference' selfUri: type: string format: uri description: The URI for this object readOnly: true DocumentContentBlock: type: object required: - type properties: type: type: string description: The type of the paragraph block. enum: - Text - Image - Video text: description: Text. It must contain a value if the type of the block is Text. $ref: '#/definitions/DocumentText' image: description: Image. It must contain a value if the type of the block is Image. $ref: '#/definitions/DocumentBodyImage' video: description: Video. It must contain a value if the type of the block is Video. $ref: '#/definitions/DocumentBodyVideo' KnowledgeParseJobRequest: type: object required: - uploadKey properties: uploadKey: type: string description: Upload key hints: type: array description: Hinted titles for the parser. items: type: string PresentedKnowledgeDocument: type: object required: - documentId - documentVariationId - documentVersionId properties: documentId: type: string description: The ID of the document. documentVariationId: type: string description: The variation of the document. documentVersionId: type: string description: The version of the document. surfacingMethod: type: string description: 'The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown.' enum: - Unknown - Article - Snippet - Highlight - Generative KnowledgeGuestDocumentSuggestionResult: type: object properties: matchedPhrase: type: string description: Matched phrase to the autocomplete suggestions query. KnowledgeBaseUpdateRequest: type: object properties: name: type: string description: Knowledge base name description: type: string description: Knowledge base description KnowledgeRetrievedReference: type: object properties: confidence: type: number format: double description: The confidence associated with retrieved reference respect to a search query. text: type: string description: The matching text for search query. fileName: type: string description: The file name from which reference is retrieved url: type: string description: The url of the file. usedForGeneration: type: boolean description: Indicates whether a retrieved reference is used for answer generation Detail: type: object properties: errorCode: type: string fieldName: type: string entityId: type: string entityName: type: string KnowledgeDocumentVersionReference: type: object required: - knowledgeBase - versionId properties: id: type: string description: The globally unique identifier for the document. readOnly: true knowledgeBase: description: The knowledge base that the document belongs to. readOnly: true $ref: '#/definitions/KnowledgeBaseReference' versionId: type: string description: The globally unique identifier for the version of the document. selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeGuestDocumentCopy: type: object required: - documentVariationId - documentVersionId properties: documentVariationId: type: string description: The variation of the document whose content was copied. documentVersionId: type: string description: The version of the document whose content was copied. searchId: type: string description: The search that surfaced the document whose content was copied. queryType: type: string description: The type of the query that surfaced the document. enum: - Unknown - Article - AutoSearch - Category - ManualSearch - Recommendation - Suggestion - ExpandedArticle surfacingMethod: type: string description: 'The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown.' enum: - Unknown - Article - Snippet - Highlight - Generative sessionId: type: string description: Knowledge session ID. readOnly: true application: description: The client application in which the document content was copied. readOnly: true $ref: '#/definitions/KnowledgeGuestSearchClientApplication' KnowledgeDocumentSuggestionResult: type: object properties: matchedPhrase: type: string description: Matched phrase to the autocomplete suggestions query. document: $ref: '#/definitions/KnowledgeDocumentSuggestionResultDocument' KnowledgeDocumentAlternative: type: object required: - autocomplete - phrase properties: phrase: type: string description: Alternate phrasing to the document title, having a limit of 500 words. autocomplete: type: boolean description: Autocomplete enabled for the alternate phrase. SalesforceSettings: type: object properties: channel: type: string description: Filter source by channel. enum: - App - Pkb - Csp - Prm language: type: string description: Filter source by language. categories: type: array description: Filter source by categories. items: type: string baseUrl: type: string description: The base URL to resources. KnowledgeSyncJobResponse: type: object properties: id: type: string description: Id of the sync job. uploadKey: type: string status: type: string description: The status of the export job. enum: - Created - ValidationInProgress - ValidationCompleted - ValidationFailed - Started - InProgress - Completed - PartialCompleted - Failed - AbortRequested - Aborted report: description: Report of the sync job $ref: '#/definitions/KnowledgeSyncJobReport' knowledgeBase: description: Knowledge base which document export belongs to. $ref: '#/definitions/KnowledgeBaseReference' dateCreated: type: string format: date-time description: 'The timestamp of when the export began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'The timestamp of when the export stopped. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' createdBy: description: The user who created the operation $ref: '#/definitions/UserReference' downloadURL: type: string description: The URL of the location at which the caller can download the sync file, when available. failedEntitiesURL: type: string description: The URL of the location at which the caller can download the entities in json format that failed during the sync. source: description: Source of the sync job. $ref: '#/definitions/KnowledgeOperationSource' selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeIntegrationFilter: type: object properties: name: type: string description: Filter name, which is the name of a setting in a knowledge source. enum: - categories - channel - knowledgeBaseIds type: type: string description: Filter type. enum: - SingleSelect - MultiSelect action: type: string description: Filter action. enum: - None - FilterUpdate values: type: array description: Available options of the filter setting. items: $ref: '#/definitions/KnowledgeIntegrationFilterValue' DocumentVariationAnswer: type: object required: - contexts properties: id: type: string description: The globally unique identifier for the variation. readOnly: true dateCreated: type: string format: date-time description: 'The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true documentVersion: description: The version of the document. $ref: '#/definitions/AddressableEntityRef' contexts: type: array description: The context values associated with the variation. items: $ref: '#/definitions/DocumentVariationContext' document: description: The reference to document to which the variation is associated. readOnly: true $ref: '#/definitions/KnowledgeDocumentReference' priority: type: integer format: int32 description: The priority of the variation. name: type: string description: The name of the variation. body: description: The content for the variation. $ref: '#/definitions/DocumentBodyWithHighlight' selfUri: type: string format: uri description: The URI for this object readOnly: true SourceSyncResponse: type: object properties: state: type: string description: Sync state. enum: - Success - Failed - InProgress - Unknown error: description: Sync error. $ref: '#/definitions/ErrorBody' dateCreated: type: string format: date-time description: 'Synchronization creation date-time for this source. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Synchronization last modification date-time for this source. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' knowledgeBase: description: Knowledge base to which this synchronization belongs. $ref: '#/definitions/AddressableEntityRef' source: description: Source to which this synchronization belongs. $ref: '#/definitions/AddressableEntityRef' SalesforceSourceResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: Name of the source. dateCreated: type: string format: date-time description: 'Source creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Source last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' type: type: string description: The source type. enum: - Salesforce - ServiceNow integration: description: The reference to the integration associated with the source. $ref: '#/definitions/KnowledgeIntegrationReference' schedulePeriod: type: integer format: int32 description: The schedule period of the source in hours. lastSync: description: Additional information about the last synchronization of the source. $ref: '#/definitions/SourceLastSync' settings: description: The settings of the source. $ref: '#/definitions/SalesforceSettings' selfUri: type: string format: uri description: The URI for this object readOnly: true DocumentQuery: type: object required: - clauses - operator properties: clauses: type: array description: Documents filter clauses/criteria. Limit of 20 clauses. items: $ref: '#/definitions/DocumentQueryClause' operator: type: string description: Specifies how the filter clauses will be applied together. enum: - Or - And ImportStatusRequest: type: object required: - status properties: status: type: string description: New status for existing import operation KnowledgeExportJobRequest: type: object required: - exportFilter - fileType properties: exportFilter: description: What to export. $ref: '#/definitions/KnowledgeExportJobFilter' fileType: type: string description: File type of the document enum: - Json - Csv - Xlsx sourceId: type: string description: Knowledge integration source id. jsonFileVersion: type: integer format: int32 description: Requested version of the exported json file. Available versions are 2 and 3, default is 2 KnowledgeSettingListing: type: object properties: entities: type: array items: $ref: '#/definitions/KnowledgeSettingsResponse' nextUri: type: string selfUri: type: string previousUri: type: string KnowledgeDocumentCopy: type: object required: - application - documentVariationId - documentVersionId properties: documentVariationId: type: string description: The variation of the document whose content was copied. documentVersionId: type: string description: The version of the document whose content was copied. searchId: type: string description: The search that surfaced the document whose content was copied. queryType: type: string description: The type of the query that surfaced the document. enum: - Unknown - Article - AutoSearch - Category - ManualSearch - Recommendation - Suggestion - ExpandedArticle surfacingMethod: type: string description: 'The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown.' enum: - Unknown - Article - Snippet - Highlight - Generative sessionId: type: string description: Knowledge session ID. readOnly: true conversationContext: description: Conversation context information, if the document content is copied in the context of a conversation. $ref: '#/definitions/KnowledgeConversationContext' application: description: The client application in which the document content was copied. $ref: '#/definitions/KnowledgeSearchClientApplication' Entity: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true KnowledgeGuestDocumentView: type: object required: - documentVariationId - documentVersionId properties: documentVariationId: type: string description: The variation of the viewed document. documentVersionId: type: string description: The version of the viewed document. searchId: type: string description: The search that surfaced the viewed document. queryType: type: string description: The type of the query that surfaced the document. enum: - Unknown - Article - AutoSearch - Category - ManualSearch - Recommendation - Suggestion - ExpandedArticle surfacingMethod: type: string description: 'The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown.' enum: - Unknown - Article - Snippet - Highlight - Generative CategoryUpdateRequest: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the category. parentCategoryId: type: string description: The category to which this category belongs. description: type: string externalId: type: string description: The external id associated with the category. selfUri: type: string format: uri description: The URI for this object readOnly: true GuestCategoryResponseListing: type: object properties: entities: type: array items: $ref: '#/definitions/GuestResponseCategory' nextUri: type: string selfUri: type: string previousUri: type: string sessionId: type: string KnowledgeDocumentBulkUpdateRequest: type: object required: - entities properties: entities: type: array description: List of unique identifiers referencing documents that are to be updated items: $ref: '#/definitions/KnowledgeDocumentBulkUpdateEntity' maxItems: 100 minItems: 1 DocumentChunkBlock: type: object required: - id - text properties: id: type: string description: The globally unique identifier for the chunk. text: type: string description: The chunk text associated with the variation. confidence: type: number format: float description: The confidence associated with a chunk with respect to a search query. document: description: Reference to document associated with a chunk $ref: '#/definitions/DocumentChunkReference' DocumentVariationSearchChunkBlock: type: object required: - id - text properties: id: type: string description: The globally unique identifier for the chunk. text: type: string description: The chunk text associated with the variation. confidence: type: number format: float description: The confidence associated with a chunk with respect to a search query. DocumentContentHighlightIndex: type: object properties: startIndex: type: integer format: int32 description: Highlight text start index. endIndex: type: integer format: int32 description: Highlight text end index. LabelListing: type: object properties: entities: type: array items: $ref: '#/definitions/LabelResponse' nextUri: type: string selfUri: type: string previousUri: type: string KnowledgeExportJobResponse: type: object required: - fileType properties: id: type: string description: Id of the export job. downloadURL: type: string description: The URL of the location at which the caller can download the export file, when available. fileType: type: string description: File type of the document enum: - Json - Csv - Xlsx jsonFileVersion: type: integer format: int32 description: Requested version of the exported json file. countDocumentProcessed: type: integer format: int32 description: The current count of the number of records processed. exportFilter: description: Filters to narrow down what to export. $ref: '#/definitions/KnowledgeExportJobFilter' status: type: string description: The status of the export job. enum: - Created - ValidationInProgress - ValidationCompleted - ValidationFailed - Started - InProgress - Completed - PartialCompleted - Failed - AbortRequested - Aborted knowledgeBase: description: Knowledge base which document export belongs to. $ref: '#/definitions/KnowledgeBase' createdBy: description: The user who created the operation $ref: '#/definitions/UserReference' dateCreated: type: string format: date-time description: 'The timestamp of when the export began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'The timestamp of when the export stopped. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' errorInformation: description: Any error information, or null of the processing is not in failed state. $ref: '#/definitions/ErrorBody' source: description: Source of the export job. $ref: '#/definitions/KnowledgeOperationSource' selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeDocumentView: type: object required: - application - documentVariationId - documentVersionId properties: documentVariationId: type: string description: The variation of the viewed document. documentVersionId: type: string description: The version of the viewed document. searchId: type: string description: The search that surfaced the viewed document. queryType: type: string description: The type of the query that surfaced the document. enum: - Unknown - Article - AutoSearch - Category - ManualSearch - Recommendation - Suggestion - ExpandedArticle surfacingMethod: type: string description: 'The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown.' enum: - Unknown - Article - Snippet - Highlight - Generative application: description: The client application from which the document was viewed. $ref: '#/definitions/KnowledgeSearchClientApplication' sessionId: type: string description: The unique identifier of the knowledge session in which the document was viewed. conversationContext: description: Conversation context information if the document was viewed in the context of a conversation. $ref: '#/definitions/KnowledgeConversationContext' KnowledgeDocumentBulkRemoveRequest: type: object required: - entities properties: entities: type: array description: List of unique identifiers referencing documents that are to be deleted items: $ref: '#/definitions/WritableEntity' maxItems: 100 minItems: 1 ServiceNowSettings: type: object properties: knowledgeBaseIds: type: array description: Filter source by knowledge base ids. items: type: string language: type: string description: Filter source by language. categories: type: array description: Filter source by categories. items: type: string baseUrl: type: string description: The base URL to resources. KnowledgeDocumentSuggestion: type: object required: - query properties: query: type: string description: Query to get autocomplete suggestions for the matching knowledge documents. pageSize: type: integer format: int32 description: Page size of the returned results. results: type: array description: Documents matching to the autocomplete suggestions query. readOnly: true items: $ref: '#/definitions/KnowledgeDocumentSuggestionResult' SearchUpdateRequest: type: object required: - answered properties: sessionId: type: string description: The unique identifier of this session readOnly: true answered: type: boolean description: Mark the search as answered/unanswered selectedAnswer: description: The selected search result chosen as the answer. $ref: '#/definitions/SelectedAnswer' selectedAnswers: type: array description: The search results selected as answers items: $ref: '#/definitions/SelectedAnswer' V3SynchronizationStatistics: type: object properties: synchronizedItemCount: type: integer format: int32 description: The total number of items added, updated or removed in the synchronization. failedItemCount: type: integer format: int32 description: The number of source items that failed to synchronize. DocumentBodyParagraphWithHighlight: type: object required: - blocks properties: blocks: type: array description: The list of blocks for the paragraph. items: $ref: '#/definitions/DocumentContentBlockWithHighlight' properties: description: The properties for the paragraph. $ref: '#/definitions/DocumentBodyParagraphProperties' KnowledgeDocumentBulkUpdateEntity: type: object properties: id: type: string description: The globally unique identifier for the object. categoryId: type: string description: The category associated with the document. labelIds: type: array description: The ids of labels associated with the document. items: type: string KnowledgeGuestDocumentPresentation: type: object required: - documents properties: documents: type: array description: The presented documents items: $ref: '#/definitions/PresentedKnowledgeDocument' searchId: type: string description: The search that surfaced the documents that were presented. queryType: type: string description: The type of the query that surfaced the documents. enum: - Unknown - Article - AutoSearch - Category - ManualSearch - Recommendation - Suggestion - ExpandedArticle surfacingMethod: type: string description: 'The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown.' enum: - Unknown - Article - Snippet - Highlight - Generative sessionId: type: string description: Knowledge session ID. readOnly: true application: description: The client application in which the documents were presented. readOnly: true $ref: '#/definitions/KnowledgeGuestSearchClientApplication' KnowledgeGuestDocumentVariationContext: type: object required: - context - values properties: context: description: The knowledge context associated with the variation. $ref: '#/definitions/AddressableEntityRef' values: type: array description: The list of knowledge context values associated with the variation. items: $ref: '#/definitions/AddressableEntityRef' KnowledgeGuestDocumentResponseListing: type: object properties: entities: type: array items: $ref: '#/definitions/KnowledgeGuestDocumentResponse' nextUri: type: string selfUri: type: string previousUri: type: string DocumentBodyListBlockProperties: type: object properties: unorderedType: type: string description: The type of icon for the unordered list. enum: - Normal - Square - Circle - None orderedType: type: string description: The type of icon for the ordered list. enum: - Number - LowerAlpha - LowerGreek - LowerRoman - UpperAlpha - UpperRoman - None DocumentBodyWithHighlight: type: object required: - blocks properties: blocks: type: array description: The list of building blocks for the document body. items: $ref: '#/definitions/DocumentBodyBlockWithHighlight' KnowledgeGuestSearchDocumentResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true title: type: string description: Document title, having a limit of 500 words. visible: type: boolean description: Indicates if the knowledge document should be included in search results. alternatives: type: array description: List of alternate phrases related to the title which improves search results. items: $ref: '#/definitions/KnowledgeDocumentAlternative' state: type: string description: State of the document. enum: - Draft - Published - Archived dateCreated: type: string format: date-time description: 'Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateImported: type: string format: date-time description: 'Document import date-time, or null if was not imported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' lastPublishedVersionNumber: type: integer format: int32 description: The last published version number of the document. datePublished: type: string format: date-time description: 'The date on which the document was last published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' createdBy: description: The user who created the document. readOnly: true $ref: '#/definitions/UserReference' modifiedBy: description: The user who modified the document. readOnly: true $ref: '#/definitions/UserReference' documentVersion: description: The version of the document. $ref: '#/definitions/AddressableEntityRef' sessionId: type: string description: ID of the guest session. readOnly: true category: description: The reference to category associated with the document. readOnly: true $ref: '#/definitions/GuestCategoryReference' variations: type: array description: Variations of the document. items: $ref: '#/definitions/KnowledgeGuestDocumentVariationAnswer' answer: type: string description: The answer to the query. selfUri: type: string format: uri description: The URI for this object readOnly: true DocumentBodyImage: type: object required: - url properties: url: type: string description: The URL for the image. hyperlink: type: string description: The URL of the page OR an email OR the reference to the knowledge article that the hyperlink goes to. Possible URL value types are https:// | mailto: | grn:knowledge:::documentVariation/// | grn:knowledge:::document// | grn:knowledge:::category// | grn:knowledge:::label// properties: description: The properties for the image. $ref: '#/definitions/DocumentBodyImageProperties' FabricTag: type: object properties: name: type: string description: The name of the tag KnowledgeImportJobRequest: type: object required: - fileType - uploadKey properties: uploadKey: type: string description: Upload key fileType: type: string description: File type of the document enum: - Json - Csv - Xlsx settings: description: Additional optional settings $ref: '#/definitions/KnowledgeImportJobSettings' skipConfirmationStep: type: boolean description: If enabled pre-validation step will be skipped. KnowledgeSourcesSearchResponse: type: object properties: query: type: string description: Query to search content in the knowledge base. searchId: type: string description: The globally unique identifier for the search. readOnly: true sessionId: type: string description: The sessionId for search request. readOnly: true result: description: Content matching the search query. readOnly: true $ref: '#/definitions/KnowledgeSearchResult' knowledgeSettingId: type: string description: Knowledge Setting Id used for the search request. readOnly: true conversationContext: description: Conversation context information if the search is initiated in the context of a conversation. readOnly: true $ref: '#/definitions/KnowledgeV3ConversationContextResponse' application: description: The client application details from which search happened. readOnly: true $ref: '#/definitions/V3KnowledgeSearchClientApplication' queryType: type: string description: The type of the query that initiates the search. readOnly: true enum: - AutoSearch - ManualSearch generationLanguage: type: string description: The language used for answer generation. readOnly: true enum: - ar-AE - cs-CZ - da-DK - de-AT - de-CH - de-DE - en-AU - en-CA - en-GB - en-HK - en-IE - en-IN - en-NZ - en-PH - en-SG - en-US - en-ZA - es-AR - es-CO - es-ES - es-MX - es-US - fi-FI - fr-BE - fr-CA - fr-CH - fr-FR - hi-IN - hu-HU - it-IT - ja-JP - ko-KR - nb-NO - nl-BE - nl-NL - pt-BR - pt-PT - sv-SE - tr-TR - el-GR - fil-PH - he-IL - ms-MY - pl-PL - th-TH answerGeneration: type: boolean description: Indicates if answer generation was enabled for the setting. readOnly: true KnowledgeV3ConversationContextResponse: type: object required: - conversation properties: conversation: description: The conversation. $ref: '#/definitions/AddressableEntityRef' queue: description: The queue used to assign the interaction to the user. $ref: '#/definitions/AddressableEntityRef' externalContact: description: The end-user participant of the conversation. $ref: '#/definitions/AddressableEntityRef' mediaType: type: string description: The media type of the conversation. enum: - Call - Chat - Email - Message - Voice Limit: type: object properties: key: type: string namespace: type: string enum: - web.deployments - web.messaging - agent.assistant - agentic.virtual.agents - analytics.agents - analytics.alerting - analytics.data.extraction - analytics - analytics.realtime - analytics.reporting.settings - anomaly.detection - architect - audiohook - audiohook.monitor - audit - auth.api - authorization - automation.testing - bots - bots.voice - business.rules - callback - case.management - cobrowse - content.management - conversation - copilot - dataactions - datatables - directory - dsar - email - employee.engagement - event.orchestration - external.contacts - external.events.data.ingestion - gamification - gcv - gdpr - groups - guides - historical.adherence - infrastructureascode - integrations - intent.miner - internal.messaging - journey - knowledge - language.understanding - learning - limit.registry - marketplace - mcp.analytics.aggregates - mcp - media.communications - messaging - micro.frontend - multi.org - notifications - onboarding - outbound - platform.api - predictive.routing - presence - quality - recording - response.management - routing - scim - screen.monitoring - search - secondary.automation.testing - skills - social.media - speech.and.text.analytics - speech.integration - supportability - task.management - telephony.configuration - usage - users - users.rules - voice.transcription - webchat - webhooks - workforce.management.adherence - workforce.management.agent.availability - workforce.management.forecast - workforce.management - workforce.management.scheduling.preferences - workforce.management.self.schedule - workforce.management.shift.trading - system value: type: integer format: int64 DocumentTableContentBlockWithHighlight: type: object required: - type properties: type: type: string description: The type of the block for the table cell. This determines which body block object (paragraph, list, video, image or table) would have a value. enum: - Paragraph - Text - Image - Video - OrderedList - UnorderedList - Table text: description: Text. It must contain a value if the type of the block is Text. $ref: '#/definitions/DocumentText' image: description: Image. It must contain a value if the type of the block is Image. $ref: '#/definitions/DocumentBodyImage' video: description: Video. It must contain a value if the type of the block is Video. $ref: '#/definitions/DocumentBodyVideo' paragraph: description: Paragraph. It must contain a value if the type of the block is Paragraph. $ref: '#/definitions/DocumentBodyParagraphWithHighlight' list: description: List. It must contain a value if the type of the block is UnorderedList or OrderedList. $ref: '#/definitions/DocumentBodyListWithHighlight' table: description: Table. It must contain a value if the type of the block is Table. $ref: '#/definitions/DocumentBodyTableWithHighlight' answerHighlight: description: The block highlight data. $ref: '#/definitions/DocumentContentHighlightIndex' KnowledgeSyncRequest: type: object properties: {} PhraseAssociations: type: object required: - documentId - phraseId properties: phraseId: type: string description: Id of the phrase to be linked documentId: type: string description: Id of the document to be linked KnowledgeGuestDocumentFeedback: type: object required: - document - documentVariation - rating properties: id: type: string description: The globally unique identifier for the object. readOnly: true documentVariation: description: The variation of the document on which feedback was given. $ref: '#/definitions/EntityReference' rating: type: string description: Feedback rating. enum: - Negative - Positive reason: type: string description: Feedback reason. enum: - DocumentContent - SearchResults comment: type: string description: 'Free-text comment of the feedback. Maximum length: 2000 characters.' minLength: 0 maxLength: 2000 search: description: The search that surfaced the document on which feedback was given. $ref: '#/definitions/EntityReference' sessionId: type: string description: Knowledge guest session ID. readOnly: true dateCreated: type: string format: date-time description: 'The date and time of the feedback. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true queryType: type: string description: The type of the query that surfaced the document on which the feedback was given. enum: - Unknown - Article - AutoSearch - Category - ManualSearch - Recommendation - Suggestion - ExpandedArticle surfacingMethod: type: string description: 'The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown.' enum: - Unknown - Article - Snippet - Highlight - Generative state: type: string description: The state of the feedback. enum: - Draft - Final document: description: The document on which feedback was given. $ref: '#/definitions/KnowledgeGuestDocumentVersionReference' application: description: The client application from which feedback was given. readOnly: true $ref: '#/definitions/KnowledgeGuestSearchClientApplication' KnowledgeDocumentBulkVersionAddEntity: type: object properties: id: type: string description: The globally unique identifier for the object. restoreFromVersionId: type: string description: The globally unique identifier for the document version. If the value is provided, the document is restored to the given version. restorePrevious: type: boolean description: Indicates if the document's previous version will be restored DocumentQueryPredicate: type: object required: - fields - type - values properties: fields: type: array description: Specifies the document fields to be matched against. items: type: string enum: - alternatives - categoryId - categoryName - contextId - contextName - contextValueId - contextValueName - documentId - labelId - labelName - title - variationId - visible - state - chunkId values: type: array description: Specifies the values of the fields to be matched against. items: type: string type: type: string description: Specifies the matching criteria between the fields and values. enum: - Equals - NotEquals - Contains - MatchAll - MatchAny GuestResponseCategory: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: type: string externalId: type: string dateCreated: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' parentCategory: description: The reference to category to which this category belongs. readOnly: true $ref: '#/definitions/GuestCategoryReference' selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeGroupStatistics: type: object properties: unlinkedPhraseCount: type: integer format: int32 description: Knowledge Group unique phrase count unlinkedPhraseHitCount: type: integer format: int32 description: Knowledge Group unlinked phrases hit count totalPhraseHitCount: type: integer format: int32 description: Total number of phrase hit counts of an unanswered group V3SourceFilterDetails: type: object properties: site: description: Details about the site associated with the Fabric Source. $ref: '#/definitions/V3SourceSiteDetails' folders: type: array description: Details about the folders associated with the Fabric Source. items: $ref: '#/definitions/V3SourceFolderDetails' KnowledgeV3ConversationContext: type: object required: - conversationId properties: conversationId: type: string description: The unique identifier of the conversation. mediaType: type: string description: The media type of the conversation. enum: - Call - Chat - Email - Message - Voice messageType: type: string description: The message type of the conversation. enum: - Unknown - Phone - SMS - GenesysChatWidget - FacebookMessenger - WeChat - Whatsapp - AppleBusinessChat - Telegram - Slack - Signal - Line - Discord - TwitterDirectMessage - Other - Open - Instagram - Apple queueId: type: string description: The unique identifier of the queue used to assign the interaction to the user. externalContactId: type: string description: The external contact identifier of the end-user participant. KnowledgeSyncJobRequest: type: object required: - uploadKey properties: uploadKey: type: string description: Upload key sourceId: type: string description: Knowledge integration source id. KnowledgeDocumentVersionVariation: type: object required: - contexts properties: id: type: string description: The globally unique identifier for the variation. readOnly: true dateCreated: type: string format: date-time description: 'The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true contexts: type: array description: The context values associated with the variation. items: $ref: '#/definitions/DocumentVariationContext' priority: type: integer format: int32 description: The priority of the variation. name: type: string description: The name of the variation. body: description: The content for the variation. $ref: '#/definitions/DocumentBody' selfUri: type: string format: uri description: The URI for this object readOnly: true documentVersion: description: Reference to the document version to which the variation is associated with. readOnly: true $ref: '#/definitions/AddressableEntityRef' CategoryCreateRequest: type: object required: - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the category. parentCategoryId: type: string description: type: string description: The description for the category. externalId: type: string description: The external id associated with the category. selfUri: type: string format: uri description: The URI for this object readOnly: true ConnectionUpdateRequest: type: object required: - code properties: code: type: string description: Unique code that allows to be connected error: type: string description: Name of the received error errorDescription: type: string description: Detailed description of the error V3SynchronizationListing: type: object properties: entities: type: array items: $ref: '#/definitions/V3Synchronization' nextUri: type: string selfUri: type: string previousUri: type: string EntityReference: type: object required: - id properties: id: type: string description: The globally unique identifier for the object. DocumentBodyImageProperties: type: object properties: backgroundColor: type: string description: 'The background color property for the image. The valid values in hex color code representation. For example black color - #000000' align: type: string description: The align property for the image. enum: - Center - Left - Right - Justify indentation: type: number format: float description: The indentation property for the image. The valid values in 'em'. width: type: number format: float description: The width of the image converted to em unit. widthWithUnit: description: The width of the image in the specified unit. $ref: '#/definitions/DocumentElementLength' altText: type: string description: Alternate text for the image for accessibility and when the image can't be loaded. KnowledgeSourcesSearchRequest: type: object required: - knowledgeSettingId - query properties: query: type: string description: Input query to search content on the knowledge setting. knowledgeSettingId: type: string description: Knowledge Setting Id to use for search request. application: description: The client application details from which search requested. $ref: '#/definitions/V3KnowledgeSearchClientApplication' conversationContext: description: Conversation context information if the search is initiated in the context of a conversation. $ref: '#/definitions/KnowledgeV3ConversationContext' sessionId: type: string description: The session id for search request. queryType: type: string description: The type of the query that initiates the search. enum: - AutoSearch - ManualSearch generationLanguage: type: string description: The language to use for answer generation. enum: - ar-AE - cs-CZ - da-DK - de-AT - de-CH - de-DE - en-AU - en-CA - en-GB - en-HK - en-IE - en-IN - en-NZ - en-PH - en-SG - en-US - en-ZA - es-AR - es-CO - es-ES - es-MX - es-US - fi-FI - fr-BE - fr-CA - fr-CH - fr-FR - hi-IN - hu-HU - it-IT - ja-JP - ko-KR - nb-NO - nl-BE - nl-NL - pt-BR - pt-PT - sv-SE - tr-TR - el-GR - fil-PH - he-IL - ms-MY - pl-PL - th-TH conversationTurns: type: array description: List of conversation turns to use for stateful search. items: $ref: '#/definitions/KnowledgeConversationTurn' KnowledgeConversationContext: type: object required: - conversationId properties: conversationId: type: string description: The unique identifier of the conversation. mediaType: type: string description: The media type of the conversation. enum: - Unknown - Callback - Chat - Cobrowse - Email - Message - Screenshare - Video - Voice messageType: type: string description: The message type of the conversation. enum: - Unknown - Phone - SMS - GenesysChatWidget - FacebookMessenger - WeChat - Whatsapp - AppleBusinessChat - Telegram - Slack - Signal - Line - Discord - TwitterDirectMessage - Other - Open - Instagram - Apple queueId: type: string description: The unique identifier of the queue used to assign the interaction to the user. externalContactId: type: string description: The external contact identifier of the end-user participant. KnowledgeIntegrationFilterValue: type: object properties: key: type: string description: The key that can be used as a value of a filter setting in a knowledge source. value: type: string description: The display label of the filter value. KnowledgeDocumentGuestSearch: type: object required: - query properties: query: type: string description: Query to search content in the knowledge base. Maximum of 30 records per query can be fetched. minLength: 3 maxLength: 2147483647 pageSize: type: integer format: int32 description: Page size of the returned results. pageNumber: type: integer format: int32 description: Page number of the returned results. searchId: type: string description: The globally unique identifier for the search. readOnly: true total: type: integer format: int32 description: The total number of documents matching the query. readOnly: true pageCount: type: integer format: int32 description: Number of pages returned in the result calculated according to the pageSize and the total readOnly: true queryType: type: string description: The type of the query that initiates the search. enum: - AutoSearch - ManualSearch - Suggestion sessionId: type: string description: Session ID of the search. readOnly: true results: type: array description: Documents that matched the search query. readOnly: true items: $ref: '#/definitions/KnowledgeDocumentGuestSearchResult' ConnectionOption: type: object properties: id: type: string description: The id of the connection option. name: type: string description: The name of the connection option. KnowledgeSettingsRequest: type: object required: - name - sources properties: name: type: string description: Knowledge setting name. description: type: string description: Knowledge setting description. sources: type: array description: Knowledge source information to search upon. items: $ref: '#/definitions/V3SourceRef' generationSetting: description: Setting for answer generation. $ref: '#/definitions/KnowledgeGenerationSetting' stateful: type: boolean description: Indicates if stateful search and generation is enabled for the knowledge setting. filter: description: Composite tag filter of search results. $ref: '#/definitions/V3SourceTagFilter' DocumentBodyTableCellBlockProperties: type: object properties: cellType: type: string description: The type of the table cell. enum: - Cell - HeaderCell width: type: number format: float description: The width of the table cell converted to em unit. widthWithUnit: description: The width of the table cell in the specified unit. $ref: '#/definitions/DocumentElementLength' height: type: number format: float description: The height for the table cell. horizontalAlign: type: string description: The horizontal alignment for the table cell. enum: - Center - Left - Right verticalAlign: type: string description: The vertical alignment for the table cell. enum: - Top - Middle - Bottom borderWidth: type: number format: float description: The border width for the table cell. The valid values in 'em' borderStyle: type: string description: The border style for the table cell. enum: - Solid - Dotted - Dashed - Double - Groove - Ridge - Inset - Outset - Hidden - None borderColor: type: string description: 'The border color for the table cell. For example black color - #000000' backgroundColor: type: string description: 'The background color for the table cell. For example black color - #000000' scope: type: string description: The scope for the table cell. enum: - Row - Column - RowGroup - ColumnGroup - None colSpan: type: integer format: int32 description: The colSpan for the table cell. rowSpan: type: integer format: int32 description: The rowSpan for the table cell. DocumentBody: type: object required: - blocks properties: blocks: type: array description: The list of building blocks for the document body. items: $ref: '#/definitions/DocumentBodyBlock' ConnectionCreateRequest: type: object required: - integrationId - redirectUrl properties: name: type: string description: The name of the Connection integrationId: type: string description: Integration ID of the Connection redirectUrl: type: string description: Redirect Url for the Oauth flow V3Synchronization: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true type: type: string description: The type of the synchronization. enum: - Incremental - Full createdBy: description: The user who started the synchronization if the source is manually synchronized or the user who created the source for scheduled synchronization. $ref: '#/definitions/UserReference' source: description: The source of the synchronization. $ref: '#/definitions/V3SourceRef' dateStart: type: string format: date-time description: 'The start time of the synchronization. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateEnd: type: string format: date-time description: 'The end time of the synchronization. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateSourceIntervalStart: type: string format: date-time description: 'The start time of the interval to be synchronized from the source. Source item changes during that interval are included in this synchronization. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateSourceIntervalEnd: type: string format: date-time description: 'The end time of the interval to be synchronized from the source. Source item changes during that interval are included in this synchronization. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' triggerType: type: string description: The trigger type of the synchronization. enum: - Scheduled - Manual - Unknown status: type: string description: The status of the synchronization. enum: - InQueue - InProgress - PostProcessing - Completed - Failed - Unknown - Cancelled statistics: description: Statistics of the synchronization. $ref: '#/definitions/V3SynchronizationStatistics' error: description: The error that occurred during the synchronization. $ref: '#/definitions/ErrorBody' ingestionStatus: type: string description: The status of the ingestion. enum: - Unknown - InQueue - Starting - InProgress - Complete - Failed - Stopping - Stopped selfUri: type: string format: uri description: The URI for this object readOnly: true V3SourceExpandableListResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the source. connectionId: type: string description: The connectionId of the source. type: type: string description: The type of the source. enum: - Sharepoint - FileUpload triggerType: type: string description: The trigger type of the source. enum: - Scheduled - Manual status: type: string description: The current status of the source. enum: - Active - Errored - Deleted createdBy: description: The user who created the source. $ref: '#/definitions/UserReference' modifiedBy: description: The user who modified the document. $ref: '#/definitions/UserReference' dateCreated: type: string format: date-time description: 'Source creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Source last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' lastSync: description: The last synchronization of the source. $ref: '#/definitions/V3SourceLastSynchronization' connection: description: The connection associated with the source. Needs to be expanded. $ref: '#/definitions/ConnectionResponse' error: description: Optional error details of an errored source. $ref: '#/definitions/ErrorBody' selfUri: type: string format: uri description: The URI for this object readOnly: true V3SourceSiteDetails: type: object properties: id: type: string description: The site's id. name: type: string description: The site's display name. KnowledgeImportJobError: type: object properties: message: type: string code: type: string status: type: integer format: int32 entityId: type: string entityName: type: string messageWithParams: type: string messageParams: type: object additionalProperties: type: string contextId: type: string details: type: array items: $ref: '#/definitions/Detail' errors: type: array items: $ref: '#/definitions/ErrorBody' limit: $ref: '#/definitions/Limit' documentIndex: type: integer format: int32 description: Index of the faulty document. KnowledgeContextValueReference: type: object required: - id properties: id: type: string description: The globally unique identifier for the knowledge context value. selfUri: type: string format: uri description: The URI for this object readOnly: true V3StartManualSyncRequest: type: object properties: type: type: string description: ' Optional field that specifies the synchronization type. For SharePoint only Full synchronization is supported, therefore that is the default. For FileUpload both Full and Incremental is supported, default is Incremental.' enum: - Incremental - Full KnowledgeSettingsResponse: type: object properties: id: type: string description: Knowledge Setting Id. name: type: string description: Knowledge Setting Name. description: type: string description: Knowledge setting description. sources: type: array description: Knowledge source information searched upon. items: $ref: '#/definitions/V3SourceRef' generationSetting: description: Settings for answer generation. $ref: '#/definitions/KnowledgeGenerationSetting' stateful: type: boolean description: Indicates if stateful search and generation is enabled for the knowledge setting. filter: description: Composite tag filter of search results. $ref: '#/definitions/V3SourceTagFilter' dateCreated: type: string format: date-time description: 'Knowledge setting created date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Knowledge setting last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' modifiedBy: description: The user who modified the knowledge setting. $ref: '#/definitions/UserReference' selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeGuestDocumentResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true title: type: string description: Document title, having a limit of 500 words. visible: type: boolean description: Indicates if the knowledge document should be included in search results. alternatives: type: array description: List of alternate phrases related to the title which improves search results. items: $ref: '#/definitions/KnowledgeDocumentAlternative' state: type: string description: State of the document. enum: - Draft - Published - Archived dateCreated: type: string format: date-time description: 'Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateImported: type: string format: date-time description: 'Document import date-time, or null if was not imported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' lastPublishedVersionNumber: type: integer format: int32 description: The last published version number of the document. datePublished: type: string format: date-time description: 'The date on which the document was last published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' createdBy: description: The user who created the document. readOnly: true $ref: '#/definitions/UserReference' modifiedBy: description: The user who modified the document. readOnly: true $ref: '#/definitions/UserReference' documentVersion: description: The version of the document. $ref: '#/definitions/AddressableEntityRef' sessionId: type: string description: ID of the guest session. readOnly: true category: description: The reference to category associated with the document. readOnly: true $ref: '#/definitions/GuestCategoryReference' variations: type: array description: Variations of the document. items: $ref: '#/definitions/KnowledgeGuestDocumentVariation' selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeGuestSessionApp: type: object required: - deploymentId - type properties: deploymentId: type: string description: App deployment ID. type: type: string description: App type. enum: - MessengerKnowledgeApp - SupportCenter DocumentElementLength: type: object required: - unit - value properties: value: type: number format: float description: The length value of the element in the selected unit. unit: type: string description: The unit of length. enum: - Em - Percentage - Px UserReference: type: object properties: id: type: string description: The globally unique identifier for the object. selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeDocumentVersionVariationListing: type: object properties: entities: type: array items: $ref: '#/definitions/KnowledgeDocumentVersionVariation' nextUri: type: string selfUri: type: string previousUri: type: string KnowledgeGenerationSetting: type: object required: - answerGeneration properties: answerGeneration: type: boolean description: Indicates if answer generation is enabled for the setting. generationLanguage: type: string description: Answer generation language. enum: - ar-AE - cs-CZ - da-DK - de-AT - de-CH - de-DE - en-AU - en-CA - en-GB - en-HK - en-IE - en-IN - en-NZ - en-PH - en-SG - en-US - en-ZA - es-AR - es-CO - es-ES - es-MX - es-US - fi-FI - fr-BE - fr-CA - fr-CH - fr-FR - hi-IN - hu-HU - it-IT - ja-JP - ko-KR - nb-NO - nl-BE - nl-NL - pt-BR - pt-PT - sv-SE - tr-TR - el-GR - fil-PH - he-IL - ms-MY - pl-PL - th-TH KnowledgeSearchDocumentResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true title: type: string description: Document title, having a limit of 500 words. visible: type: boolean description: Indicates if the knowledge document should be included in search results. alternatives: type: array description: List of alternate phrases related to the title which improves search results. items: $ref: '#/definitions/KnowledgeDocumentAlternative' state: type: string description: State of the document. enum: - Draft - Published - Archived dateCreated: type: string format: date-time description: 'Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateImported: type: string format: date-time description: 'Document import date-time, or null if was not imported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' lastPublishedVersionNumber: type: integer format: int32 description: The last published version number of the document. datePublished: type: string format: date-time description: 'The date on which the document was last published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' createdBy: description: The user who created the document. readOnly: true $ref: '#/definitions/UserReference' modifiedBy: description: The user who modified the document. readOnly: true $ref: '#/definitions/UserReference' documentVersion: description: The version of the document. $ref: '#/definitions/AddressableEntityRef' category: description: The reference to category associated with the document. $ref: '#/definitions/CategoryResponse' labels: type: array description: The references to labels associated with the document. items: $ref: '#/definitions/LabelResponse' knowledgeBase: description: Knowledge base to which the document belongs to. $ref: '#/definitions/KnowledgeBaseReference' externalId: type: string description: The reference to external id associated with the document. externalUrl: type: string description: The URL to external document. source: description: The reference to source associated with the document. $ref: '#/definitions/AddressableEntityRef' readonly: type: boolean description: Whether the document is read-only. variations: type: array description: Variations of the document. items: $ref: '#/definitions/KnowledgeDocumentSearchVariation' answer: type: string description: The answer to the query. selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeParseJobResponse: type: object properties: id: type: string description: Id of the parse job readOnly: true downloadURL: type: string description: The URL of the location at which the caller can download the original html file. hints: type: array description: Hinted titles for the parser. items: type: string status: type: string description: Status of the parse job readOnly: true enum: - ReadyToParse - ParseInProgress - ParseCompleted - ReadyToImport - ImportInProgress - ImportCompleted - ImportPartialCompleted - ImportFailed parseResults: type: array description: Results of the parse readOnly: true items: $ref: '#/definitions/KnowledgeParseRecord' importResult: description: Result of the import phase readOnly: true $ref: '#/definitions/KnowledgeParseImportResult' createdBy: description: The user who created the operation $ref: '#/definitions/UserReference' dateCreated: type: string format: date-time description: 'Created date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true UnansweredGroupSuggestedDocument: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeDocumentQueryResponse: type: object properties: pageSize: type: integer format: int32 description: Page size of the returned results. pageNumber: type: integer format: int32 description: Page number of the returned results. total: type: integer format: int64 description: The total number of documents matching the query. readOnly: true pageCount: type: integer format: int32 description: The total number of pages of results, calculated according to the pageSize and the total matching documents. readOnly: true results: type: array description: Documents matching the query. items: $ref: '#/definitions/KnowledgeDocumentQueryResult' KnowledgeDocumentBulkVersionAddRequest: type: object required: - entities properties: entities: type: array description: List of unique identifiers referencing documents that are to be versioned items: $ref: '#/definitions/KnowledgeDocumentBulkVersionAddEntity' maxItems: 100 minItems: 1 KnowledgeDocumentVersionListing: type: object properties: entities: type: array items: $ref: '#/definitions/KnowledgeDocumentVersion' nextUri: type: string selfUri: type: string previousUri: type: string KnowledgeParseImportResult: type: object required: - failure - success properties: success: type: integer format: int32 description: Number of imported articles. failure: type: integer format: int32 description: Number of articles failed to import. errors: type: array description: Error information about the failures. items: $ref: '#/definitions/ErrorBody' KnowledgeSearchPreviewResponse: type: object properties: query: type: string description: Query to search content in the knowledge base. searchId: type: string description: The globally unique identifier for the search. readOnly: true sessionId: type: string description: The sessionId for search request. readOnly: true result: description: Content matching the search query. readOnly: true $ref: '#/definitions/KnowledgeSearchResult' application: description: The touchpoint application used for the preview. $ref: '#/definitions/V3KnowledgeSearchPreviewClientApplication' conversationContext: description: The channel context used for the preview. $ref: '#/definitions/KnowledgeV3PreviewConversationContext' KnowledgeBaseReference: type: object required: - id properties: id: type: string description: The globally unique identifier for the knowledge base. languageCode: type: string description: Language of the knowledge base enum: - en-US - en-UK - en-AU - en-CA - en-HK - en-IN - en-IE - en-NZ - en-PH - en-SG - en-ZA - de-DE - de-AT - de-CH - es-AR - es-CO - es-MX - es-US - es-ES - fr-FR - fr-BE - fr-CA - fr-CH - pt-BR - pt-PT - nl-NL - nl-BE - it-IT - ca-ES - tr-TR - sv-SE - fi-FI - nb-NO - da-DK - ja-JP - ar-AE - zh-CN - zh-TW - zh-HK - ko-KR - pl-PL - hi-IN - th-TH - hu-HU - vi-VN - uk-UA - cs-CZ - fil-PH - ms-MY - he-IL - el-GR contentSearchEnabled: type: boolean description: Flag that indicates the search on content is enabled for the knowledge base. selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeDocumentsAnswerFilter: type: object required: - variationIds properties: query: type: string description: The search query. language: type: string description: The language of the documents. enum: - en-US - en-UK - en-AU - en-CA - en-HK - en-IN - en-IE - en-NZ - en-PH - en-SG - en-ZA - de-DE - de-AT - de-CH - es-AR - es-CO - es-MX - es-US - es-ES - fr-FR - fr-BE - fr-CA - fr-CH - pt-BR - pt-PT - nl-NL - nl-BE - it-IT - ca-ES - tr-TR - sv-SE - fi-FI - nb-NO - da-DK - ja-JP - ar-AE - zh-CN - zh-TW - zh-HK - ko-KR - pl-PL - hi-IN - th-TH - hu-HU - vi-VN - uk-UA - cs-CZ - fil-PH - ms-MY - he-IL - el-GR appType: type: string description: The appType enum: - Assistant - BotFlow - MessengerKnowledgeApp - SmartAdvisor - SupportCenter queryType: type: string description: The query type enum: - Unknown - Article - AutoSearch - Category - ManualSearch - Recommendation - Suggestion - ExpandedArticle searchId: type: string description: The search id. insertHighlightIntoVariationContent: type: boolean description: If specified - insert highlight data into the variation content. answerMode: type: array description: 'Allows extracted answers from an article (AnswerHighlight) and/or AI-generated answers (AnswerGeneration). Default mode: AnswerHighlight' items: type: string enum: - AnswerHighlight - AnswerGeneration variationIds: type: array description: The variation Ids to answer. items: type: string maxItems: 10 minItems: 1 KnowledgeDocumentFeedbackUpdateRequest: type: object required: - rating properties: rating: type: string description: Feedback rating. enum: - Negative - Positive reason: type: string description: Feedback reason enum: - DocumentContent - SearchResults comment: type: string description: Feedback comment state: type: string description: Feedback state enum: - Draft - Final DocumentVariationContext: type: object required: - context - values properties: context: description: The knowledge context associated with the variation. $ref: '#/definitions/KnowledgeContextReference' values: type: array description: The list of knowledge context values associated with the variation. items: $ref: '#/definitions/KnowledgeContextValueReference' ErrorBody: type: object properties: message: type: string code: type: string status: type: integer format: int32 entityId: type: string entityName: type: string messageWithParams: type: string messageParams: type: object additionalProperties: type: string contextId: type: string details: type: array items: $ref: '#/definitions/Detail' errors: type: array items: $ref: '#/definitions/ErrorBody' limit: $ref: '#/definitions/Limit' KnowledgeGuestDocumentVersionReference: type: object required: - versionId properties: id: type: string description: The globally unique identifier for the document. readOnly: true versionId: type: string description: The globally unique identifier for the version of the document. KnowledgeDocumentSearchRequest: type: object required: - query properties: query: type: string description: Query to search content in the knowledge base. Maximum of 30 records per query can be fetched. minLength: 3 maxLength: 2147483647 pageSize: type: integer format: int32 description: Page size of the returned results. pageNumber: type: integer format: int32 description: Page number of the returned results. searchId: type: string description: The globally unique identifier for the search. readOnly: true total: type: integer format: int32 description: The total number of documents matching the query. readOnly: true pageCount: type: integer format: int32 description: Number of pages returned in the result calculated according to the pageSize and the total readOnly: true queryType: type: string description: The type of the query that initiates the search. enum: - AutoSearch - ManualSearch - Suggestion includeDraftDocuments: type: boolean description: Indicates whether the search results would also include draft documents. interval: description: Retrieves the documents created/modified/published in specified date and time range. $ref: '#/definitions/DocumentQueryInterval' filter: description: Filter for the document search. $ref: '#/definitions/DocumentQuery' sortOrder: type: string description: The sort order for search results. enum: - Asc - Desc sortBy: type: string description: The field in the documents that you want to sort the search results by. enum: - ConfidenceScore - DateCreated - DateModified - CategoryName - LabelName application: description: The client application details from which search request was sent. $ref: '#/definitions/KnowledgeSearchClientApplication' conversationContext: description: Conversation context information if the search is initiated in the context of a conversation. $ref: '#/definitions/KnowledgeConversationContext' confidenceThreshold: type: number format: float description: The confidence threshold for the search results. If applied, the returned results will have an equal or higher confidence than the threshold. The value should be between 0 to 1. answerHighlightTopResults: type: integer format: int32 description: The number of articles to be sent for answer-highlighting. Can range from 1-5. minimum: 1 maximum: 5 answerMode: type: array description: 'Allows extracted answers from an article (AnswerHighlight) and/or AI-generated answers (AnswerGeneration). Default mode: AnswerHighlight. Use this property with answerHighlightTopResults.' items: type: string enum: - AnswerHighlight - AnswerGeneration preprocessQuery: type: boolean description: Indicates whether the search query should be preprocessed. V3SourceExpandableResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the source. connectionId: type: string description: The connectionId of the source. type: type: string description: The type of the source. enum: - Sharepoint - FileUpload triggerType: type: string description: The trigger type of the source. enum: - Scheduled - Manual status: type: string description: The current status of the source. enum: - Active - Errored - Deleted createdBy: description: The user who created the source. $ref: '#/definitions/UserReference' modifiedBy: description: The user who modified the document. $ref: '#/definitions/UserReference' dateCreated: type: string format: date-time description: 'Source creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Source last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' lastSync: description: The last synchronization of the source. $ref: '#/definitions/V3SourceLastSynchronization' scheduleSettings: description: Settings that determine when the source starts a sync. $ref: '#/definitions/V3SourceScheduleSettings' filters: description: Filters that determine what documents are synced. $ref: '#/definitions/V3SourceFilter' filterDetails: description: Additional details to the source's filters. $ref: '#/definitions/V3SourceFilterDetails' connection: description: The connection associated with the source. Needs to be expanded. $ref: '#/definitions/ConnectionResponse' error: description: Optional error details of an errored source. $ref: '#/definitions/ErrorBody' selfUri: type: string format: uri description: The URI for this object readOnly: true UnansweredPhraseGroupUpdateResponse: type: object properties: phraseAssociations: type: array description: List of phrases and documents linked in the patch request items: $ref: '#/definitions/PhraseAssociations' group: description: Knowledge base unanswered group response $ref: '#/definitions/UnansweredGroup' UnansweredGroup: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true label: type: string description: Knowledge base unanswered group label phraseGroups: type: array description: Represents a list of phrase groups inside an unanswered group items: $ref: '#/definitions/UnansweredPhraseGroup' suggestedDocuments: type: array description: Represents a list of documents that may be linked to an unanswered group items: $ref: '#/definitions/UnansweredGroupSuggestedDocument' statistics: description: Statistics object containing the various hit counts for an unanswered group $ref: '#/definitions/KnowledgeGroupStatistics' selfUri: type: string format: uri description: The URI for this object readOnly: true AuthenticationProperties: type: object properties: sharepoint: $ref: '#/definitions/SharepointAuthenticationProperties' KnowledgeDocumentGuestSearchResult: type: object properties: confidence: type: number format: double description: The confidence associated with a document with respect to a search query. document: description: Document that matched the query. $ref: '#/definitions/KnowledgeGuestSearchDocumentResponse' SelectedAnswer: type: object required: - document properties: document: description: The search result document chosen as the answer. $ref: '#/definitions/AddressableEntityRef' V3SourceLastSynchronization: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true dateStart: type: string format: date-time description: 'The start time of the synchronization. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateEnd: type: string format: date-time description: 'The end time of the synchronization. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateSourceIntervalStart: type: string format: date-time description: 'The start time of the interval to be synchronized from the source. Source item changes during that interval are included in this synchronization. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateSourceIntervalEnd: type: string format: date-time description: 'The end time of the interval to be synchronized from the source. Source item changes during that interval are included in this synchronization. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' triggerType: type: string description: The trigger type of the synchronization. enum: - Scheduled - Manual - Unknown status: type: string description: The status of the synchronization. enum: - InQueue - InProgress - PostProcessing - Completed - Failed - Unknown - Cancelled statistics: description: Statistics of the synchronization. $ref: '#/definitions/V3SynchronizationStatistics' error: description: The error that occurred during the synchronization. $ref: '#/definitions/ErrorBody' ingestionStatus: type: string description: The status of the ingestion. enum: - Unknown - InQueue - Starting - InProgress - Complete - Failed - Stopping - Stopped selfUri: type: string format: uri description: The URI for this object readOnly: true BulkResponse: type: object properties: results: type: array description: A list of the results from the bulk operation. items: $ref: '#/definitions/BulkResult' errorCount: type: integer format: int32 description: The number of errors from the bulk operation. errorIndexes: type: array description: An index of where the errors are in the listing. items: type: integer format: int32 DocumentBodyListBlock: type: object required: - blocks - type properties: type: type: string description: The type of the list block. enum: - ListItem properties: description: The properties for the list block. $ref: '#/definitions/DocumentBodyListItemProperties' blocks: type: array description: The list of items for an OrderedList or an UnorderedList. items: $ref: '#/definitions/DocumentListContentBlock' V3SourceUpdateRequest: type: object required: - name - triggerType properties: name: type: string description: The name of the source. triggerType: type: string description: The trigger type of the source. enum: - Scheduled - Manual scheduleSettings: description: Settings that determine when the source starts a sync. $ref: '#/definitions/V3SourceScheduleSettings' V3SourceDetailedResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the source. connectionId: type: string description: The connectionId of the source. type: type: string description: The type of the source. enum: - Sharepoint - FileUpload triggerType: type: string description: The trigger type of the source. enum: - Scheduled - Manual status: type: string description: The current status of the source. enum: - Active - Errored - Deleted createdBy: description: The user who created the source. $ref: '#/definitions/UserReference' modifiedBy: description: The user who modified the document. $ref: '#/definitions/UserReference' dateCreated: type: string format: date-time description: 'Source creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Source last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' lastSync: description: The last synchronization of the source. $ref: '#/definitions/V3SourceLastSynchronization' scheduleSettings: description: Settings that determine when the source starts a sync. $ref: '#/definitions/V3SourceScheduleSettings' filters: description: Filters that determine what documents are synced. $ref: '#/definitions/V3SourceFilter' filterDetails: description: Additional details to the source's filters. $ref: '#/definitions/V3SourceFilterDetails' selfUri: type: string format: uri description: The URI for this object readOnly: true V3SourceCreateRequest: type: object required: - name properties: name: type: string description: The name of the source. type: type: string description: The type of the source. Required if connectionId is not specified, inherits the connection type otherwise. enum: - Sharepoint - FileUpload connectionId: type: string description: The id of the connection related to the source. Required if type is Sharepoint. triggerType: type: string description: The trigger type of the source. Default is Manual. enum: - Scheduled - Manual scheduleSettings: description: Settings that determine when the source starts a sync. Required if triggerType is Scheduled. $ref: '#/definitions/V3SourceScheduleSettings' filters: description: Filters that determine what documents are synced. $ref: '#/definitions/V3SourceFilter' V3SynchronizationFileDeletionRequest: type: object properties: fileId: type: string description: The identifier of the file to mark for deletion. Mutually exclusive with fileName. fileName: type: string description: 'Name of the file to mark for deletion. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \{^}%`]">[~<#|. Mutually exclusive with fileId.' DocumentText: type: object required: - text properties: text: type: string description: Text. marks: type: array description: The unique list of marks (whether it is bold and/or underlined etc.) for the text. uniqueItems: true items: type: string enum: - Bold - Italic - Underline - Strikethrough - Subscript - Superscript hyperlink: type: string description: The URL of the page OR an email OR the reference to the knowledge article that the hyperlink goes to. Possible URL value types are https:// | mailto: | grn:knowledge:::documentVariation/// | grn:knowledge:::document// | grn:knowledge:::category// | grn:knowledge:::label// properties: description: The properties for the text. $ref: '#/definitions/DocumentTextProperties' DocumentVariationQueryChunkBlock: type: object required: - id - text properties: id: type: string description: The globally unique identifier for the chunk. text: type: string description: The chunk text associated with the variation. OperationListing: type: object properties: entities: type: array items: $ref: '#/definitions/OperationResponse' nextUri: type: string selfUri: type: string previousUri: type: string V3SynchronizationUpload: type: object properties: fileId: type: string description: The unique identifier for the upload object. fileName: type: string description: Name of the uploaded file. metadata: description: The metadata of the uploaded file $ref: '#/definitions/V3SynchronizationUploadMetadata' synchronization: description: The synchronization of the file upload. $ref: '#/definitions/V3SynchronizationRef' selfUri: type: string format: uri description: The URI for this object readOnly: true V3SourceRef: type: object required: - id properties: id: type: string description: Source Id. selfUri: type: string format: uri description: The URI for this object readOnly: true V3SourceExpandableListing: type: object properties: entities: type: array items: $ref: '#/definitions/V3SourceExpandableListResponse' KnowledgeDocumentQueryVariation: type: object required: - contexts properties: id: type: string description: The globally unique identifier for the variation. readOnly: true dateCreated: type: string format: date-time description: 'The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true documentVersion: description: The version of the document. $ref: '#/definitions/AddressableEntityRef' contexts: type: array description: The context values associated with the variation. items: $ref: '#/definitions/DocumentVariationContext' document: description: The reference to document to which the variation is associated. readOnly: true $ref: '#/definitions/KnowledgeDocumentReference' priority: type: integer format: int32 description: The priority of the variation. name: type: string description: The name of the variation. body: description: The content for the variation. $ref: '#/definitions/DocumentBody' chunks: type: array description: The chunk blocks associated with the variation. items: $ref: '#/definitions/DocumentVariationQueryChunkBlock' selfUri: type: string format: uri description: The URI for this object readOnly: true UnansweredPhraseGroupPatchRequestBody: type: object required: - phraseAssociations properties: phraseAssociations: type: array description: List of phrases and documents to be linked items: $ref: '#/definitions/PhraseAssociations' dateStart: type: string format: date description: 'The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' dateEnd: type: string format: date description: 'The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' DocumentBodyTableWithHighlight: type: object required: - rows properties: properties: description: The properties for the table. $ref: '#/definitions/DocumentBodyTableProperties' rows: type: array description: The list of rows for the table. items: $ref: '#/definitions/DocumentBodyTableRowBlockWithHighlight' KnowledgeParseRecord: type: object properties: id: type: string description: Unique id for the parsed data. title: type: string description: Parsed article title. body: description: Parsed article content. $ref: '#/definitions/DocumentBody' DocumentBodyParagraphProperties: type: object properties: fontSize: type: string description: The font size for the paragraph. The valid values in 'em'. enum: - XxSmall - XSmall - Small - Medium - Large - XLarge - XxLarge - XxxLarge fontType: type: string description: The font type for the paragraph. enum: - Paragraph - Heading1 - Heading2 - Heading3 - Heading4 - Heading5 - Heading6 - Preformatted textColor: type: string description: 'The text color for the paragraph. The valid values in hex color code representation. For example black color - #000000' backgroundColor: type: string description: 'The background color for the paragraph. The valid values in hex color code representation. For example black color - #000000' align: type: string description: The align type for the paragraph. enum: - Center - Left - Right - Justify indentation: type: number format: float description: The indentation color for the paragraph. The valid values in 'em'. DocumentBodyTableRowBlock: type: object required: - cells properties: properties: description: The properties for the table rows. $ref: '#/definitions/DocumentBodyTableRowBlockProperties' cells: type: array description: The list of cells for the table. items: $ref: '#/definitions/DocumentBodyTableCellBlock' V3SynchronizationDeletion: type: object properties: fileId: type: string description: The unique identifier for the deletion object. fileName: type: string description: Name of the file marked for deletion. synchronization: description: The synchronization of the file deletion. $ref: '#/definitions/V3SynchronizationRef' selfUri: type: string format: uri description: The URI for this object readOnly: true DocumentBodyListBlockWithHighlight: type: object required: - blocks - type properties: type: type: string description: The type of the list block. enum: - ListItem properties: description: The properties for the list block. $ref: '#/definitions/DocumentBodyListItemProperties' blocks: type: array description: The list of items for an OrderedList or an UnorderedList. items: $ref: '#/definitions/DocumentListContentBlockWithHighlight' KnowledgeSyncJobReport: type: object properties: errors: type: array description: List of errors occurred during processing sync. items: $ref: '#/definitions/ErrorBody' statistics: description: Statistics related to the sync job. $ref: '#/definitions/KnowledgeSyncJobStatistics' KnowledgeGuestAnswerDocumentResponse: type: object properties: id: type: string description: The document id. title: type: string description: The document title. answer: type: string description: The answer found inside a variationContent. variation: description: The variation with the answer's highlight data. $ref: '#/definitions/KnowledgeGuestDocumentVariationAnswer' ServiceNowSourceRequest: type: object required: - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the integration source. integrationId: type: string description: The integration associated with the source. schedulePeriod: type: integer format: int32 description: The schedule period of the source in hours. Must be at least 6 and at most 48 hours. minimum: 6 maximum: 48 settings: description: The settings of the source. $ref: '#/definitions/ServiceNowSettings' selfUri: type: string format: uri description: The URI for this object readOnly: true KnowledgeDocumentChunkResponse: type: object properties: query: type: string description: Query to search chunks in the knowledge base. total: type: integer format: int32 description: The total number of chunks matching the query. readOnly: true pageCount: type: integer format: int32 description: Number of pages returned in the result calculated according to the pageSize and the total readOnly: true pageSize: type: integer format: int32 description: Page size of the returned results. pageNumber: type: integer format: int32 description: Page number of the returned results. queryType: type: string description: The type of the query that initiates the chunks search. enum: - AutoSearch - ManualSearch - Suggestion searchId: type: string description: The globally unique identifier for the chunks search. readOnly: true preprocessQuery: type: boolean description: Indicates whether the chunks search query should be preprocessed. confidenceThreshold: type: number format: float description: The confidence threshold for the chunk results. If applied, the returned results will have an equal or higher chunk confidence than the threshold. results: type: array description: Chunks matching the search query. items: $ref: '#/definitions/DocumentChunkBlock' application: description: The client application details from which chunks search happened. $ref: '#/definitions/KnowledgeSearchClientApplication' conversationContext: description: Conversation context information if the chunks search is initiated in the context of a conversation. $ref: '#/definitions/KnowledgeConversationContextResponse' AnswerGenerationDocument: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true title: type: string description: The document title. selfUri: type: string format: uri description: The URI for this object readOnly: true V3SynchronizationUploadUrlRequest: type: object required: - fileName properties: fileName: type: string description: 'Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \{^}%`]">[~<#|' contentMd5: type: string description: 'Content MD5 of the file to upload encoded in base64, example: "f8VicOenD6gaWTW3Lqy+KQ==". Not the hexadecimal representation as "7fc56270e7a70fa81a5935b72eacbe29".' contentType: type: string description: The content type of the file to upload contentLength: type: integer format: int32 description: The length of the file to upload in bytes metadata: description: The metadata of the file to upload $ref: '#/definitions/V3SynchronizationUploadMetadata' KnowledgeGuestSession: type: object required: - app - customerId properties: id: type: string description: Session ID. readOnly: true app: description: The app where the session is started. $ref: '#/definitions/KnowledgeGuestSessionApp' customerId: type: string description: An arbitrary ID for the customer starting the session. Used to track multiple sessions started by the same customer. pageUrl: type: string description: URL of the page where the session is started. contexts: type: array description: The session contexts. items: $ref: '#/definitions/KnowledgeGuestSessionContext' journeySessionId: type: string description: Journey session ID. Used to get the segments of the customer to filter search results. V3SynchronizationUploadListing: type: object properties: entities: type: array items: $ref: '#/definitions/V3SynchronizationUpload' nextUri: type: string selfUri: type: string previousUri: type: string KnowledgeDocumentReference: type: object required: - id - knowledgeBase properties: id: type: string description: The globally unique identifier for the document. knowledgeBase: description: The knowledge base that the document belongs to. $ref: '#/definitions/KnowledgeBaseReference' selfUri: type: string format: uri description: The URI for this object readOnly: true DocumentVariationResponseListing: type: object properties: entities: type: array items: $ref: '#/definitions/DocumentVariationResponse' nextUri: type: string selfUri: type: string previousUri: type: string KnowledgeBaseCreateRequest: type: object required: - coreLanguage - name properties: name: type: string description: Knowledge base name description: type: string description: Knowledge base description coreLanguage: type: string example: en-US description: Core language for knowledge base in which initial content must be created, language codes [en-US, en-UK, en-AU, de-DE] are supported currently. However, the new DX knowledge will support all these language codes, along with 'early preview' language codes [ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA] which might have a lower accuracy. enum: - en-US - en-UK - en-AU - en-CA - en-HK - en-IN - en-IE - en-NZ - en-PH - en-SG - en-ZA - de-DE - de-AT - de-CH - es-AR - es-CO - es-MX - es-US - es-ES - fr-FR - fr-BE - fr-CA - fr-CH - pt-BR - pt-PT - nl-NL - nl-BE - it-IT - ca-ES - tr-TR - sv-SE - fi-FI - nb-NO - da-DK - ja-JP - ar-AE - zh-CN - zh-TW - zh-HK - ko-KR - pl-PL - hi-IN - th-TH - hu-HU - vi-VN - uk-UA - cs-CZ - fil-PH - ms-MY - he-IL - el-GR contentSearchEnabled: type: boolean description: Flag that indicates the search on content is enabled for the knowledge base. KnowledgeIntegrationReference: type: object required: - id properties: id: type: string description: The globally unique identifier for the integration. selfUri: type: string format: uri description: The URI for this object readOnly: true DocumentQueryInterval: type: object properties: field: type: string description: Specifies the date field to be used for date and time range. enum: - dateCreated - dateModified - datePublished value: type: string format: interval description: 'Specifies the date and time range for filtering the documents. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss' KnowledgeAnswerDocumentsResponse: type: object properties: results: type: array description: The results with answers if the answerMode request property is not set or contains "AnswerHighlight". Empty array otherwise. items: $ref: '#/definitions/KnowledgeAnswerDocumentResponse' answerGeneration: description: The results with AI-generated answer if the answerMode request property contains "AnswerGeneration". $ref: '#/definitions/KnowledgeAnswerGenerationResponse' BulkError: type: object properties: message: type: string description: Error message of the bulk operation result. code: type: string description: Error code of the bulk operation result. DocumentQueryClause: type: object required: - operator - predicates properties: operator: type: string description: Specifies how the predicates will be applied together. enum: - Or - And predicates: type: array description: To apply multiple conditions. Limit of 10 predicates across all clauses. items: $ref: '#/definitions/DocumentQueryPredicate' KnowledgeParseJobRequestPatch: type: object properties: hints: type: array description: Hinted titles for the parser. items: type: string securityDefinitions: PureCloud OAuth: type: oauth2 authorizationUrl: https://login.mypurecloud.com/authorize flow: implicit scopes: all: All the scopes Guest Chat JWT: type: apiKey name: Authorization in: header externalDocs: description: PureCloud API Documentation url: https://developer.genesys.cloud/