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 Task Management 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: Task Management description: Task Management paths: /api/v2/taskmanagement/workitems/bulk/jobs/users/me: get: tags: - Task Management summary: Get bulk jobs created by the currently logged in user. description: '' operationId: getTaskmanagementWorkitemsBulkJobsUsersMe produces: - application/json parameters: - 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: Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. required: false type: integer default: 25 format: int32 - name: sortOrder in: query description: Ascending or descending sort order required: false type: string default: descending enum: - ascending - descending - name: action in: query description: The bulk job action. required: false type: string enum: - TerminateWorkitems - AddWorkitems responses: '200': description: successful operation schema: $ref: '#/definitions/BulkJobsListing' '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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:bulkJob:view x-purecloud-method-name: getTaskmanagementWorkitemsBulkJobsUsersMe /api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}: get: tags: - Task Management summary: Get the bulk add job associated with the job id. description: '' operationId: getTaskmanagementWorkitemsBulkAddJob produces: - application/json parameters: - name: bulkJobId in: path description: Bulk job id required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/BulkJob' '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: Bulk add job with the specified ID 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:bulkAddJob:view x-purecloud-method-name: getTaskmanagementWorkitemsBulkAddJob delete: tags: - Task Management summary: Delete a bulk add job description: '' operationId: deleteTaskmanagementWorkitemsBulkAddJob produces: - application/json parameters: - name: bulkJobId in: path description: Bulk job id required: true type: string responses: '204': description: Bulk add job successfully 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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:bulkAddJob:delete x-purecloud-method-name: deleteTaskmanagementWorkitemsBulkAddJob patch: tags: - Task Management summary: Update workitem bulk add job. description: '' operationId: patchTaskmanagementWorkitemsBulkAddJob produces: - application/json parameters: - name: bulkJobId in: path description: Bulk job id required: true type: string - in: body name: body description: Bulk add job update request required: true schema: $ref: '#/definitions/BulkJobUpdate' responses: '200': description: successful operation schema: $ref: '#/definitions/BulkJob' '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' service.limit.bulk.jobs.concurrent.maximum.limit.reached: The maximum number of concurrent active bulk jobs 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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:bulkAddJob:edit x-purecloud-method-name: patchTaskmanagementWorkitemsBulkAddJob /api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}/results: get: tags: - Task Management summary: Get bulk add job results. description: '' operationId: getTaskmanagementWorkitemsBulkAddJobResults produces: - application/json parameters: - name: bulkJobId in: path description: Bulk job id required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/BulkJobAddResponse' '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: Bulk add job with the specified ID 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:bulkAddJobResults:view x-purecloud-method-name: getTaskmanagementWorkitemsBulkAddJobResults /api/v2/taskmanagement/workitems/bulk/add/jobs: post: tags: - Task Management summary: Create a workitem bulk add job. description: '' operationId: postTaskmanagementWorkitemsBulkAddJobs produces: - application/json parameters: - in: body name: body description: Bulk job definition. required: true schema: $ref: '#/definitions/BulkJobAddRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BulkJob' '201': description: Workitem bulk add job created. schema: $ref: '#/definitions/BulkJob' '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] validation.failed: One or more workitems contain invalid data that failed constraint validation checks. 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. workitem.external.contact.division.mismatch: Workitem must be in the same division as the external contact. '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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:bulkAddJob:add x-purecloud-method-name: postTaskmanagementWorkitemsBulkAddJobs /api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}/results: get: tags: - Task Management summary: Get bulk terminate job results. description: '' operationId: getTaskmanagementWorkitemsBulkTerminateJobResults produces: - application/json parameters: - name: bulkJobId in: path description: Bulk job id required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/BulkJobTerminateResultsResponse' '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: Get bulk terminate job results. '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: - workitems - workitems:readonly x-inin-requires-permissions: type: ALL permissions: - workitems:bulkTerminateJobResults:view x-purecloud-method-name: getTaskmanagementWorkitemsBulkTerminateJobResults /api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}: get: tags: - Task Management summary: Get the bulk job associated with the job id. description: '' operationId: getTaskmanagementWorkitemsBulkTerminateJob produces: - application/json parameters: - name: bulkJobId in: path description: Bulk job id required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/BulkJob' '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: Bulk job with the specified ID 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ALL permissions: - workitems:bulkTerminateJob:view x-purecloud-method-name: getTaskmanagementWorkitemsBulkTerminateJob delete: tags: - Task Management summary: Delete a Bulk job description: '' operationId: deleteTaskmanagementWorkitemsBulkTerminateJob produces: - application/json parameters: - name: bulkJobId in: path description: Bulk job id required: true type: string responses: '204': description: Bulk job successfully 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: - workitems x-inin-requires-permissions: type: ALL permissions: - workitems:bulkTerminateJob:delete x-purecloud-method-name: deleteTaskmanagementWorkitemsBulkTerminateJob patch: tags: - Task Management summary: Update workitem bulk terminate job. description: '' operationId: patchTaskmanagementWorkitemsBulkTerminateJob produces: - application/json parameters: - name: bulkJobId in: path description: Bulk job id required: true type: string - in: body name: body description: Bulk job update request required: true schema: $ref: '#/definitions/BulkJobUpdate' responses: '200': description: successful operation schema: $ref: '#/definitions/BulkJob' '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: - workitems x-inin-requires-permissions: type: ALL permissions: - workitems:bulkTerminateJob:edit x-purecloud-method-name: patchTaskmanagementWorkitemsBulkTerminateJob /api/v2/taskmanagement/workitems/bulk/terminate/jobs: post: tags: - Task Management summary: Create a workitem bulk terminate job. description: '' operationId: postTaskmanagementWorkitemsBulkTerminateJobs produces: - application/json parameters: - in: body name: body description: Bulk job definition. required: true schema: $ref: '#/definitions/BulkJobTerminateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BulkJob' '201': description: Workitem bulk terminate job created. schema: $ref: '#/definitions/BulkJob' '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] validation.failed: One or more ids are invalid and failed constraint validation checks. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' service.limit.bulk.jobs.concurrent.maximum.limit.reached: The maximum number of concurrent active bulk jobs 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: - workitems x-inin-requires-permissions: type: ALL permissions: - workitems:bulkTerminateJob:add x-purecloud-method-name: postTaskmanagementWorkitemsBulkTerminateJobs /api/v2/taskmanagement/workbins/query: post: tags: - Task Management summary: Query for workbins description: '' operationId: postTaskmanagementWorkbinsQuery produces: - application/json parameters: - in: body name: body description: QueryPostRequest required: true schema: $ref: '#/definitions/WorkbinQueryRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkbinQueryEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.int.value.too.high: Page size too large. invalid.input.invalid.base64.string: Wrong cursor (after key) format invalid.input.wrong.number.values: Wrong number of values provided for filter bad.request: The request could not be understood by the server due to malformed syntax. invalid.input.wrong.attribute.type: Wrong attribute type. invalid.query.operator.and.type: Certain operators and types cannot be used together workitem.max.division.filters: Maximum of 50 divisionIds are allowed in filter. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.input.filter.without.value: Missing filter values invalid.input.empty.value: Empty value. invalid.input.int.value.too.low: Page size too small. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.query.between.order.of.values: First value cannot be greater than the second value for a BETWEEN operator 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.input.invalid.uuid: Invalid UUID. invalid.query: Invalid query invalid.query.sort.attribute.in.invalid.filter: Sorting attribute is in an invalid filter invalid.query.null.with.operator.and.type: Null values cannot be used with certain operators and types 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' workitem.missing.any.division.permissions: User has no permission access to the division. 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ALL permissions: - workitems:workbin:view x-purecloud-method-name: postTaskmanagementWorkbinsQuery /api/v2/taskmanagement/workbins/{workbinId}: get: tags: - Task Management summary: Get a workbin description: '' operationId: getTaskmanagementWorkbin produces: - application/json parameters: - name: workbinId in: path description: Workbin ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/Workbin' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.empty.value: Empty value. 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.input.wrong.attribute.type: Wrong attribute type. 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.input.invalid.uuid: Invalid UUID. 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. not.found.error: Workbin 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:workbin:view x-purecloud-method-name: getTaskmanagementWorkbin delete: tags: - Task Management summary: Delete a workbin description: '' operationId: deleteTaskmanagementWorkbin produces: - application/json parameters: - name: workbinId in: path description: Workbin ID required: true type: string responses: '204': description: Deleted successfully '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.empty.value: Empty value. 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.input.wrong.attribute.type: Wrong attribute type. invalid.input.invalid.uuid: Invalid UUID. '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. not.found.error: Workbin 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: pre.check.entity.used: Workbin still being used by a Worktype. request.conflict: The request conflicts with the current state of the target resource. pre.check.delete.failed: Workbin still has Workitems associated to it. '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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:workbin:delete x-purecloud-method-name: deleteTaskmanagementWorkbin patch: tags: - Task Management summary: Update the attributes of a workbin description: '' operationId: patchTaskmanagementWorkbin produces: - application/json parameters: - name: workbinId in: path description: Workbin ID required: true type: string - in: body name: body description: 'Json with attributes and their new values: {"description":"new description", "name":"new name"}.' required: true schema: $ref: '#/definitions/WorkbinUpdate' responses: '200': description: successful operation schema: $ref: '#/definitions/Workbin' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.no.attribute.to.update: No attributes to update. invalid.input.attr.not.updatable: Attribute not updatable. bad.request: The request could not be understood by the server due to malformed syntax. invalid.input.wrong.attribute.type: Wrong attribute type. invalid.input.no.change: No changes found in request. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.input.string.value.too.short: String too short. invalid.input.string.value.too.long: String too long. invalid.input.empty.value: Empty 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.input.invalid.uuid: Invalid UUID. db.transaction.cancelled: Database transaction was cancelled. 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. not.found.error: Workbin 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. pre.check.name.in.use: Name is already in use. '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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:workbin:edit x-purecloud-method-name: patchTaskmanagementWorkbin /api/v2/taskmanagement/workbins/{workbinId}/versions: get: tags: - Task Management summary: Get all versions of a workbin description: '' operationId: getTaskmanagementWorkbinVersions produces: - application/json parameters: - name: workbinId in: path description: Workbin 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: Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. required: false type: integer default: 25 format: int32 - name: sortOrder in: query description: Ascending or descending sort order required: false type: string default: descending enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/WorkbinVersionListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.int.value.too.high: Page size too large. invalid.input.int.value.too.low: Page size too small. 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.input.invalid.uuid: Invalid UUID. 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:workbin:view x-purecloud-method-name: getTaskmanagementWorkbinVersions /api/v2/taskmanagement/workbins/{workbinId}/versions/{entityVersion}: get: tags: - Task Management summary: Get a version of a workbin description: '' operationId: getTaskmanagementWorkbinVersion produces: - application/json parameters: - name: workbinId in: path description: Workbin ID required: true type: string - name: entityVersion in: path description: Workbin version required: true type: integer minimum: 1 format: int32 responses: '200': description: successful operation schema: $ref: '#/definitions/WorkbinVersion' '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.input.invalid.uuid: Invalid UUID. 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: version.not.found: Version 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. security: - PureCloud OAuth: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:workbin:view x-purecloud-method-name: getTaskmanagementWorkbinVersion /api/v2/taskmanagement/workbins/{workbinId}/history: get: tags: - Task Management summary: Get a listing of a workbin's attribute change history description: '' operationId: getTaskmanagementWorkbinHistory produces: - application/json parameters: - name: workbinId in: path description: Workbin 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: Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. required: false type: integer default: 25 format: int32 - name: sortOrder in: query description: Ascending or descending sort order required: false type: string default: descending enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/WorkbinChangeListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.int.value.too.high: Page size too large. invalid.input.int.value.too.low: Page size too small. 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.input.invalid.uuid: Invalid UUID. 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:workbin:view x-purecloud-method-name: getTaskmanagementWorkbinHistory /api/v2/taskmanagement/workbins: post: tags: - Task Management summary: Create a workbin description: '' operationId: postTaskmanagementWorkbins produces: - application/json parameters: - in: body name: body description: Workbin required: true schema: $ref: '#/definitions/WorkbinCreate' responses: '201': description: Workbin created. schema: $ref: '#/definitions/Workbin' '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. invalid.input.wrong.attribute.type: Wrong attribute type. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.input.string.value.too.short: String too short. invalid.input.string.value.too.long: String too long. invalid.input.empty.value: Empty 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.input.invalid.uuid: Invalid UUID. 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. pre.check.name.in.use: Name is already in use. pre.check.maximum.limit.reached: Maximum number of Workbins 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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:workbin:add x-purecloud-method-name: postTaskmanagementWorkbins /api/v2/taskmanagement/workitems: post: tags: - Task Management summary: Create a workitem description: '' operationId: postTaskmanagementWorkitems produces: - application/json parameters: - in: body name: body description: Workitem required: true schema: $ref: '#/definitions/WorkitemCreate' responses: '200': description: successful operation schema: $ref: '#/definitions/Workitem' '201': description: Workitem created. schema: $ref: '#/definitions/Workitem' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.int.value.too.high: Integer too high. invalid.input.missing.queue: No queueId provided. service.limit.per.day.maximum.created.limit.reached: Reached maximum amount of workitems created per day bad.request: The request could not be understood by the server due to malformed syntax. invalid.input.wrong.attribute.type: Wrong attribute type. workitem.script.division.mismatch: Workitem must be in the same division as the script. constraint.validation: '%s' invalid.input.date.above.max: Date above maximum. invalid.input.string.value.too.short: String too short. invalid.input.string.value.too.long: String too long. invalid.input.date.below.min: Date below minimum. invalid.input.duplicate.scored.agents: Duplicate entries in the scored agents list. invalid.input.empty.value: Empty value. 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.input.invalid.uuid: Invalid UUID. invalid.input.list.value.too.long: List too long. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' invalid.input.timestamp.above.max: Timestamp above maximum. invalid.input.timestamp.below.min: Timestamp below minimum. invalid.property: Value [%s] is not a valid property for object [%s] invalid.input.undefined.status: Undefined status. invalid.input.int.value.too.low: Integer too low. 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.input.missing.required.field: Required field not supplied in payload. invalid.input.default.status.empty: Default status id is empty for worktype. invalid.input.missing.mandatory.status: Missing mandatory Open and Closed statuses in the Worktype. workitem.queue.division.mismatch: Queue is in a different division from workitem. '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' assignee.missing.any.division.permissions: Assignee does not have permissions assigned in the division authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' assignee.missing.any.permissions: Assignee does not have permissions assigned 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: routing.skill.ids.not.found: Skill IDs do not exist utilization.label.id.not.found: Utilization label ID does not exist not.found: The requested resource was not found. queue.ids.not.found: Queue ID does not exist not.found.error: Worktype or Workbin 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: pre.check.value.greater.than.or.equal: Due date greater than or equal to TTL. request.conflict: The request conflicts with the current state of the target resource. workitem.external.contact.division.mismatch: Workitem must be in the same division as the external contact. pre.check.workitem.division.mismatch: A Workitem's Workbin and Worktype must belong to the same division. wrapup.not.in.queue: Wrapup code is not configured in the queue. pre.check.value.greater.than: Due date greater than expiration or expiration greater than TTL. wrapup.no.queue: There is no queue for the workitem or its worktype. service.limit.acd.started.maximum.limit.reached: 'Reached maximum number of routing (assignmentState: AcdStarted) workitems for queue' pre.check.date.too.soon: Supplied date value is too soon. '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: schedule.service.error.job.creation.failed: Failed to schedule status transition. 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. '422': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: schema.error.schema.not.found: Schema not found. schema.error.schema.disabled: Schema disabled. schema.error.worktype.no.schema: Worktype for this workitem does not have a schema defined. schema.error.property.disabled: Schema property disabled. schema.error.missing.attributes: Missing attributes. schema.error.schema.deleted: Schema deleted. schema.error.invalid.schema: Invalid schema. schema.error.missing.version: Schema version is not defined in this workitem. schema.error.invalid.instance: Invalid schema instance. security: - PureCloud OAuth: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:workitem:add x-purecloud-method-name: postTaskmanagementWorkitems /api/v2/taskmanagement/workitems/query: post: tags: - Task Management summary: Query for workitems description: This query requires at least one EQ filter on the workbinId, assigneeId, queueId or typeId attributes. A maximum of three filters are allowed. operationId: postTaskmanagementWorkitemsQuery produces: - application/json parameters: - in: body name: body description: WorkitemQueryPostRequest required: true schema: $ref: '#/definitions/WorkitemQueryPostRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemPostQueryEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.int.value.too.high: Page size too large. invalid.input.invalid.base64.string: Wrong cursor (after key) format invalid.query.missing.workitem.filter: Missing mandatory filters invalid.input.wrong.number.values: Wrong number of values provided for filter bad.request: The request could not be understood by the server due to malformed syntax. invalid.input.wrong.attribute.type: Wrong attribute type. invalid.query.operator.and.type: Certain operators and types cannot be used together invalid.property: Value [%s] is not a valid property for object [%s] invalid.query.missing.filters: Missing filters. constraint.validation: '%s' invalid.input.filter.without.value: Missing filter values invalid.input.empty.value: Empty value. invalid.input.int.value.too.low: Page size too small. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.query.between.order.of.values: First value cannot be greater than the second value for a BETWEEN operator 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.input.invalid.uuid: Invalid UUID. invalid.query: Invalid query invalid.query.sort.attribute.in.invalid.filter: Sorting attribute is in an invalid filter invalid.query.null.with.operator.and.type: Null values cannot be used with certain operators and types invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' invalid.input.attributes.missing.expands: Invalid value for attributes. 'attributes' list must contain all fields specified in 'expands' list. '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' workitem.missing.any.division.permissions: No permission in any division to perform the query. 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. not.found.error: Not found error '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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:workitem:view x-purecloud-method-name: postTaskmanagementWorkitemsQuery /api/v2/taskmanagement/workitems/query/jobs: post: tags: - Task Management summary: Create a workitem query job description: '' operationId: postTaskmanagementWorkitemsQueryJobs produces: - application/json parameters: - in: body name: body description: WorkitemQueryJobCreate required: true schema: $ref: '#/definitions/WorkitemQueryJobCreate' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemQueryJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: workitem.concurrent.query.job.per.user.limit.exceeded: Rate limit exceeded for concurrent queries per user 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. workitem.concurrent.query.job.per.organization.limit.exceeded: Rate limit exceeded for concurrent queries per org invalid.property: Value [%s] is not a valid property for object [%s] query.filters.validation: Query filters validation error 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' workitem.missing.any.division.permissions: No permission in any divisions to create the job. 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. invalid.query.previous.job.still.running: Job with identical query already running '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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:queryJob:add x-purecloud-method-name: postTaskmanagementWorkitemsQueryJobs /api/v2/taskmanagement/workitems/query/jobs/{jobId}: get: tags: - Task Management summary: Get the workitem query job associated with the job id. description: '' operationId: getTaskmanagementWorkitemsQueryJob produces: - application/json parameters: - name: jobId in: path description: jobId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemQueryJobResponse' '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' workitem.missing.required.division.permissions: Missing division permissions to view the job. '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Job not found with the supplied id '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: - workitems - workitems:readonly x-inin-requires-permissions: type: ALL permissions: - workitems:queryJob:view x-purecloud-method-name: getTaskmanagementWorkitemsQueryJob /api/v2/taskmanagement/workitems/query/jobs/{jobId}/results: get: tags: - Task Management summary: 'Get results from for workitem query job ' description: '' operationId: getTaskmanagementWorkitemsQueryJobResults produces: - application/json parameters: - name: jobId in: path description: jobId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemPagedEntityListing' '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' workitem.missing.required.division.permissions: Missing division permissions to view the job results. '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Job not found with the supplied id '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: - workitems - workitems:readonly x-inin-requires-permissions: type: ALL permissions: - workitems:queryJobResults:view x-purecloud-method-name: getTaskmanagementWorkitemsQueryJobResults /api/v2/taskmanagement/workitems/{workitemId}/disconnect: post: tags: - Task Management summary: Disconnect the assignee of the workitem description: '' operationId: postTaskmanagementWorkitemDisconnect produces: - application/json parameters: - name: workitemId in: path description: Workitem ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/Workitem' '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] invalid.input.invalid.uuid: Invalid UUID. invalid.input.assign.state.cannot.be.set: Assignment state cannot be set. 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. not.found.error: Workitem 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. invalid.assignment.state.transition: Invalid assignment state transition. '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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:workitem:disconnect x-purecloud-method-name: postTaskmanagementWorkitemDisconnect /api/v2/taskmanagement/workitems/{workitemId}/terminate: post: tags: - Task Management summary: Terminate a workitem description: '' operationId: postTaskmanagementWorkitemTerminate produces: - application/json parameters: - name: workitemId in: path description: Workitem ID required: true type: string - in: body name: body description: Terminated request required: false schema: $ref: '#/definitions/WorkitemTerminate' responses: '200': description: successful operation schema: $ref: '#/definitions/Workitem' '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] invalid.input.invalid.uuid: Invalid UUID. pre.check.status.must.be.closed.category.for.terminated.workitem: Status provided is not a 'Closed' category status. 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. not.found.error: Not found error '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. pre.check.cannot.terminate.terminated.workitem: Cannot terminate an already terminated workitem. '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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:workitem:terminate x-purecloud-method-name: postTaskmanagementWorkitemTerminate /api/v2/taskmanagement/workitems/{workitemId}: get: tags: - Task Management summary: Get a workitem description: '' operationId: getTaskmanagementWorkitem produces: - application/json parameters: - name: workitemId in: path description: Workitem ID required: true type: string - name: expands in: query description: Which fields to expand. Comma separated if more than one. required: false type: array items: type: string enum: - type - workbin - status - queue - assignee collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/Workitem' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.empty.value: Empty value. 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.input.wrong.attribute.type: Wrong attribute type. 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.input.invalid.uuid: Invalid UUID. 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. not.found.error: Workitem 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:workitem:view x-purecloud-method-name: getTaskmanagementWorkitem delete: tags: - Task Management summary: Delete a workitem description: '' operationId: deleteTaskmanagementWorkitem produces: - application/json parameters: - name: workitemId in: path description: Workitem ID required: true type: string responses: '204': description: Deleted successfully '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.empty.value: Empty value. 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.input.wrong.attribute.type: Wrong attribute type. invalid.input.invalid.uuid: Invalid UUID. '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. not.found.error: Workitem 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: pre.check.cannot.be.deleted.due.to.assignment.state: Workitem cannot be deleted in certain assignment states 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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:workitem:delete x-purecloud-method-name: deleteTaskmanagementWorkitem patch: tags: - Task Management summary: Update the attributes of a workitem description: '' operationId: patchTaskmanagementWorkitem produces: - application/json parameters: - name: workitemId in: path description: Workitem ID required: true type: string - in: body name: body description: Workitem required: true schema: $ref: '#/definitions/WorkitemUpdate' responses: '200': description: successful operation schema: $ref: '#/definitions/Workitem' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.int.value.too.high: Integer too high. invalid.input.no.attribute.to.update: No attributes to update. invalid.input.invalid.assign.state: Invalid assignment state. invalid.input.attr.not.updatable: Attribute not updatable. bad.request: The request could not be understood by the server due to malformed syntax. invalid.input.wrong.attribute.type: Wrong attribute type. workitem.script.division.mismatch: Workitem must be in the same division as the script. constraint.validation: '%s' invalid.input.date.above.max: Date above maximum. invalid.input.string.value.too.short: String too short. invalid.input.string.value.too.long: String too long. invalid.input.date.below.min: Date below minimum. invalid.input.transition.delay.too.low: Status transition delay too low. invalid.input.duplicate.scored.agents: Duplicate entries in the scored agents list. invalid.input.empty.value: Empty value. invalid.input.missing.queue.in.workitem: No queueId provided in the Workitem. 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.input.invalid.uuid: Invalid UUID. invalid.input.list.value.too.long: List too long. invalid.input.assign.state.cannot.be.set: Assignment state cannot be set. service.limit.per.day.maximum.updated.limit.reached: Reached maximum amount of workitems updated per day db.transaction.cancelled: Database transaction was cancelled. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' invalid.input.update.queue.and.assignee: Cannot update queue and assignee in the same request. service.limit.workitem.updates.per.minute.limit.reached: Reached maximum amount of updates on a single workitem per minute invalid.input.timestamp.above.max: Timestamp above maximum. service.limit.workitem.updates.per.day.limit.reached: Reached maximum amount of updates on a single workitem per day invalid.input.timestamp.below.min: Timestamp below minimum. invalid.input.no.change: No changes found in request. invalid.property: Value [%s] is not a valid property for object [%s] invalid.input.undefined.status: Undefined status. invalid.input.update.user.and.queue: Cannot update user and queue in the same request. invalid.input.update.assign.state.in.assign: Cannot update assignmentState. invalid.input.missing.assignee: Cannot perform assignment without an assignee. invalid.input.int.value.too.low: Integer too low. invalid.input.invalid.status.transition: Invalid status transition. 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' workitem.queue.division.mismatch: Queue is in a different division from workitem. '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' assignee.missing.any.division.permissions: Assignee does not have permissions assigned in the division authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' assignee.missing.any.permissions: Assignee does not have permissions assigned 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: routing.skill.ids.not.found: Skill IDs do not exist utilization.label.id.not.found: Utilization label ID does not exist not.found: The requested resource was not found. queue.ids.not.found: Queue ID does not exist not.found.error: Workitem type or Workbin 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: pre.check.value.greater.than.or.equal: Due date greater than or equal to TTL. request.conflict: The request conflicts with the current state of the target resource. invalid.assignment.state.transition: Invalid assignment state transition. pre.check.workitem.division.cannot.be.changed: A workitem cannot be moved to a Workbin from another division. workitem.external.contact.division.mismatch: Workitem must be in the same division as the external contact. invalid.assignment.requester.not.assignee: Requester is not the assignee. pre.check.cannot.be.reassigned: Workitem cannot be reassigned. pre.check.cannot.update.terminated.workitem: Terminated workitem cannot be updated. pre.check.value.greater.than: Due date greater than expiration or expiration greater than TTL. service.limit.acd.started.maximum.limit.reached: 'Reached maximum number of routing (assignmentState: AcdStarted) workitems for queue' invalid.assignment.cannot.reassign.for.state: Cannot be assigned to another user. pre.check.date.too.soon: Supplied date value is too soon. '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: schedule.service.error.job.creation.failed: Job creation failed. schedule.service.error.job.search.failed: Job search failed. 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. '422': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: schema.error.schema.not.found: Schema not found. schema.error.worktype.no.schema: Worktype for this workitem does not have a schema defined. schema.error.property.disabled: Schema property disabled. schema.error.missing.attributes: Missing attributes. schema.error.invalid.schema: Invalid schema. schema.error.missing.version: Schema version is not defined in this workitem. schema.error.invalid.instance: Invalid schema instance. security: - PureCloud OAuth: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:workitem:edit - workitems:workitem:accept x-purecloud-method-name: patchTaskmanagementWorkitem /api/v2/taskmanagement/workitems/{workitemId}/assignment: patch: tags: - Task Management summary: Attempts to manually assign a specified workitem to a specified user. Ignores bullseye ring, PAR score, skills, and languages. description: '' operationId: patchTaskmanagementWorkitemAssignment produces: - application/json parameters: - name: workitemId in: path description: Workitem ID required: true type: string - in: body name: body description: Targeted user required: true schema: $ref: '#/definitions/WorkitemManualAssign' responses: '202': description: The manual assignment request was accepted '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. workitem.not.queued.for.assignment: The workitem cannot be manually assigned as it is not queued for assignment. invalid.property: Value [%s] is not a valid property for object [%s] operation.failed: The manual assignment attempt failed. constraint.validation: '%s' invalid.status: The user's current routing status does not allow for new assignments. 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. feature.not.enabled: Manual assignment not enabled for queue invalid.id: The targeted user ID is missing or invalid. 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' assignee.missing.any.division.permissions: Assignee does not have permissions assigned in the division authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' assignee.missing.any.permissions: Assignee does not have permissions assigned 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. not.found.error: Workitem 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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:workitem:pull - workitems:workitem:assign x-purecloud-method-name: patchTaskmanagementWorkitemAssignment /api/v2/taskmanagement/workitems/{workitemId}/versions: get: tags: - Task Management summary: Get all versions of a workitem description: '' operationId: getTaskmanagementWorkitemVersions produces: - application/json parameters: - name: workitemId in: path description: Workitem 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: Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. required: false type: integer default: 25 format: int32 - name: sortOrder in: query description: Ascending or descending sort order required: false type: string default: descending enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemVersionListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.int.value.too.high: Page size too large. invalid.input.int.value.too.low: Page size too small. 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.input.invalid.uuid: Invalid UUID. 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:workitem:view x-purecloud-method-name: getTaskmanagementWorkitemVersions /api/v2/taskmanagement/workitems/{workitemId}/versions/{entityVersion}: get: tags: - Task Management summary: Get a version of a workitem description: '' operationId: getTaskmanagementWorkitemVersion produces: - application/json parameters: - name: workitemId in: path description: Workitem ID required: true type: string - name: entityVersion in: path description: Workitem version required: true type: integer minimum: 1 format: int32 responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemVersion' '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.input.invalid.uuid: Invalid UUID. 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: version.not.found: Version 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. security: - PureCloud OAuth: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:workitem:view x-purecloud-method-name: getTaskmanagementWorkitemVersion /api/v2/taskmanagement/workitems/{workitemId}/history: get: tags: - Task Management summary: Get a listing of a workitem's attribute change history description: '' operationId: getTaskmanagementWorkitemHistory produces: - application/json parameters: - name: workitemId in: path description: Workitem 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: Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. required: false type: integer default: 25 format: int32 - name: sortOrder in: query description: Ascending or descending sort order required: false type: string default: descending enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemChangeListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.int.value.too.high: Page size too large. invalid.input.int.value.too.low: Page size too small. 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.input.invalid.uuid: Invalid UUID. 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:workitem:view x-purecloud-method-name: getTaskmanagementWorkitemHistory /api/v2/taskmanagement/workitems/{workitemId}/acd/cancel: post: tags: - Task Management summary: Cancel the assignment process for a workitem that is currently queued for assignment through ACD. description: '' operationId: postTaskmanagementWorkitemAcdCancel produces: - application/json parameters: - name: workitemId in: path description: Workitem ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/Workitem' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.limit.workitem.updates.per.minute.limit.reached: Reached maximum amount of updates on a single workitem per minute service.limit.workitem.updates.per.day.limit.reached: Reached maximum amount of updates on a single workitem per day 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] constraint.validation: '%s' 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.input.invalid.uuid: Invalid UUID. invalid.input.assign.state.cannot.be.set: Assignment state cannot be set. service.limit.per.day.maximum.updated.limit.reached: Reached maximum amount of workitems updated per day 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. invalid.assignment.state.transition: Invalid assignment state transition. '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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:workitem:cancelRouting x-purecloud-method-name: postTaskmanagementWorkitemAcdCancel /api/v2/taskmanagement/workitems/schemas/coretypes/{coreTypeName}: get: tags: - Task Management summary: Get a specific named core type. description: '' operationId: getTaskmanagementWorkitemsSchemasCoretype produces: - application/json parameters: - name: coreTypeName in: path description: Name of the core type required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/Coretype' '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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:workitemSchema:view x-purecloud-method-name: getTaskmanagementWorkitemsSchemasCoretype /api/v2/taskmanagement/workitems/schemas/coretypes: get: tags: - Task Management summary: Get the core types from which all schemas are built. description: '' operationId: getTaskmanagementWorkitemsSchemasCoretypes produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/CoretypeListing' '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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:workitemSchema:view x-purecloud-method-name: getTaskmanagementWorkitemsSchemasCoretypes /api/v2/taskmanagement/workitems/schemas/limits: get: tags: - Task Management summary: Get quantitative limits on schemas description: '' operationId: getTaskmanagementWorkitemsSchemasLimits produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/SchemaQuantityLimits' '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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:workitemSchema:view x-purecloud-method-name: getTaskmanagementWorkitemsSchemasLimits /api/v2/taskmanagement/workitems/schemas/{schemaId}: get: tags: - Task Management summary: Get a schema description: '' operationId: getTaskmanagementWorkitemsSchema produces: - application/json parameters: - name: schemaId in: path description: Schema ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/DataSchema' '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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:workitemSchema:view x-purecloud-method-name: getTaskmanagementWorkitemsSchema put: tags: - Task Management summary: Update a schema description: '' operationId: putTaskmanagementWorkitemsSchema produces: - application/json parameters: - name: schemaId in: path description: Schema ID required: true type: string - in: body name: body description: Data Schema required: true schema: $ref: '#/definitions/DataSchema' responses: '200': description: successful operation schema: $ref: '#/definitions/DataSchema' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded: The total number of fields defined for all schemas would exceed 500. dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded: There cannot be more than 20 schemas. 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] dynamic.schema.invalid.json.schema: An invalid JSON schema was provided. constraint.validation: '%s' dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded: A schema cannot have more than 25 fields dynamic.schema.validation.limit.error: The JSON schema provided for update has a validation limit error. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable dynamic.schema.incompatible.json.schema.update: The JSON schema provided for update is incompatible with the previous version. dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded: A field name cannot exceed 100 characters dynamic.schema.validation.limit.missing: The JSON schema provided for update is missing a validation limit. 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. dynamic.schema.length.limits.would.be.exceeded: The schema title should not exceed 50 characters. The schema description should not exceed 200 characters. 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. dynamic.schema.version.conflict: A valid version is required. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dynamic.schema.payload.too.large: Payload too large. 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. '422': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dynamic.schema.expand.failed: Unable to expand the schema. security: - PureCloud OAuth: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:workitemSchema:edit x-purecloud-method-name: putTaskmanagementWorkitemsSchema delete: tags: - Task Management summary: Delete a schema description: '' operationId: deleteTaskmanagementWorkitemsSchema produces: - application/json parameters: - name: schemaId in: path description: Schema ID required: true type: string 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 '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. workitem.schema.cannot.be.deleted: Workitem schema cannot be deleted. There are Worktypes associated to it. '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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:workitemSchema:delete x-purecloud-method-name: deleteTaskmanagementWorkitemsSchema /api/v2/taskmanagement/workitems/schemas/{schemaId}/versions/{versionId}: get: tags: - Task Management summary: Get a specific version of a schema description: '' operationId: getTaskmanagementWorkitemsSchemaVersion produces: - application/json parameters: - name: schemaId in: path description: Schema ID required: true type: string - name: versionId in: path description: Schema version required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/DataSchema' '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. '422': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dynamic.schema.expand.failed: The schema to expand has parse errors security: - PureCloud OAuth: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:workitemSchema:view x-purecloud-method-name: getTaskmanagementWorkitemsSchemaVersion /api/v2/taskmanagement/workitems/schemas/{schemaId}/versions: get: tags: - Task Management summary: Get all versions of a schema description: '' operationId: getTaskmanagementWorkitemsSchemaVersions produces: - application/json parameters: - name: schemaId in: path description: Schema ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/DataSchemaListing' '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. '422': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dynamic.schema.expand.failed: The schema to expand has parse errors security: - PureCloud OAuth: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:workitemSchema:view x-purecloud-method-name: getTaskmanagementWorkitemsSchemaVersions /api/v2/taskmanagement/workitems/schemas: get: tags: - Task Management summary: Get a list of schemas. description: '' operationId: getTaskmanagementWorkitemsSchemas produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/DataSchemaListing' '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. '422': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dynamic.schema.expand.failed: Unable to expand the schema. security: - PureCloud OAuth: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:workitemSchema:view x-purecloud-method-name: getTaskmanagementWorkitemsSchemas post: tags: - Task Management summary: Create a schema description: '' operationId: postTaskmanagementWorkitemsSchemas produces: - application/json parameters: - in: body name: body description: Schema required: true schema: $ref: '#/definitions/DataSchema' responses: '200': description: successful operation schema: $ref: '#/definitions/DataSchema' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded: The total number of fields defined for all schemas would exceed 500. dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded: There cannot be more than 20 schemas. 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] dynamic.schema.invalid.json.schema: An invalid JSON schema was provided. constraint.validation: '%s' dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded: A schema cannot have more than 25 fields dynamic.schema.validation.limit.error: The schema has a validation limit error. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable dynamic.schema.incompatible.json.schema.update: The JSON schema provided for update is incompatible with the previous version. dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded: A field name cannot exceed 100 characters dynamic.schema.validation.limit.missing: The schema is missing a validation limit. 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. dynamic.schema.length.limits.would.be.exceeded: The schema title should not exceed 50 characters. The schema description should not exceed 200 characters. 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. dynamic.schema.version.conflict: A valid version is required. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dynamic.schema.payload.too.large: Payload too large. 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. '422': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dynamic.schema.expand.failed: Unable to expand the schema. security: - PureCloud OAuth: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:workitemSchema:add x-purecloud-method-name: postTaskmanagementWorkitemsSchemas /api/v2/taskmanagement/workitems/{workitemId}/users/{userId}/wrapups: get: tags: - Task Management summary: Get all wrapup codes added for the given user for a workitem. description: '' operationId: getTaskmanagementWorkitemUserWrapups produces: - application/json parameters: - name: workitemId in: path description: The ID of the Workitem. required: true type: string - name: userId in: path description: The ID of the user required: true type: string - name: expands in: query description: Which fields, if any, to expand. required: false type: string enum: - wrapupCode - 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: Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50. required: false type: integer default: 25 format: int32 - name: sortOrder in: query description: Ascending or descending sort order required: false type: string default: descending enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemWrapupEntityListing' '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' forbidden: 'User does not have the wrapup view permission ' 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: workitem.not.found: Workitem 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. security: - PureCloud OAuth: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:wrapup:view x-purecloud-method-name: getTaskmanagementWorkitemUserWrapups patch: tags: - Task Management summary: Add/Remove a wrapup code for a given user in a workitem. description: '' operationId: patchTaskmanagementWorkitemUserWrapups produces: - application/json parameters: - name: workitemId in: path description: The ID of the Workitem. required: true type: string - in: body name: body description: Request body to add/remove a wrapup code for a workitem required: true schema: $ref: '#/definitions/WorkitemWrapupUpdate' - name: userId in: path description: The ID of the user required: true type: string responses: '204': description: Wrapup code 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: service.limit.workitem.updates.per.minute.limit.reached: Reached maximum amount of updates on a single workitem per minute service.limit.workitem.updates.per.day.limit.reached: Reached maximum amount of updates on a single workitem per day 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] constraint.validation: Wrapup code did not pass validation 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. service.limit.per.day.maximum.updated.limit.reached: Reached maximum amount of workitems updated per day db.transaction.cancelled: Database transaction was cancelled. wrapup.action.required: The request body is missing the action property invalid.value: Invalid value for action is provided. validation.failure: The json request body is not valid. '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' forbidden: 'User does not have the wrapup edit permission ' 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: wrapup.not.found: Wrapup code not found wrapup.deleted: Wrapup code has been deleted user.not.found: User not found workitem.not.found: Workitem 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: wrapup.cannot.remove.only.wrapup: A users last wrap-up code cannot be removed. request.conflict: The request conflicts with the current state of the target resource. wrapup.max.count.per.user: Maximum wrap-up count is reached. wrapup.already.added: This wrap-up code was already added for this user. wrapup.not.in.queue: Wrap-up code is not configured in the queue. wrapup.no.queue: There is no queue for the workitem or its worktype. wrapup.cannot.be.added.or.removed: A terminated workitem cannot have wrap-up codes applied or removed '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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:wrapup:edit x-purecloud-method-name: patchTaskmanagementWorkitemUserWrapups /api/v2/taskmanagement/workitems/{workitemId}/users/me/wrapups: patch: tags: - Task Management summary: Add/Remove a wrapup code for the current user in a workitem. description: '' operationId: patchTaskmanagementWorkitemUsersMeWrapups produces: - application/json parameters: - name: workitemId in: path description: The ID of the Workitem. required: true type: string - in: body name: body description: Request body to add/remove the wrapup code for workitem required: true schema: $ref: '#/definitions/WorkitemWrapupUpdate' responses: '204': description: Wrapup code 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: service.limit.workitem.updates.per.minute.limit.reached: Reached maximum amount of updates on a single workitem per minute service.limit.workitem.updates.per.day.limit.reached: Reached maximum amount of updates on a single workitem per day 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] constraint.validation: Wrapup did not pass validation 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. service.limit.per.day.maximum.updated.limit.reached: Reached maximum amount of workitems updated per day db.transaction.cancelled: Database transaction was cancelled. wrapup.action.required: The request body is missing the action property invalid.value: Invalid value for action is provided. validation.failure: The json request body is not valid. '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' forbidden: 'User does not have the wrapup edit permission ' 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: wrapup.not.found: Wrapup code not found wrapup.deleted: Wrapup code has been deleted user.not.found: User not found workitem.not.found: Workitem 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: wrapup.cannot.remove.only.wrapup: A users last wrap-up code cannot be removed. request.conflict: The request conflicts with the current state of the target resource. wrapup.max.count.per.user: Maximum wrap-up count is reached. wrapup.already.added: This wrap-up code was already added for this user. wrapup.not.in.queue: Wrap-up code is not configured in the queue. wrapup.no.queue: There is no queue for the workitem or its worktype. wrapup.cannot.be.added.or.removed: A terminated workitem cannot have wrapup codes applied or removed '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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:wrapupSelf:edit x-purecloud-method-name: patchTaskmanagementWorkitemUsersMeWrapups /api/v2/taskmanagement/workitems/{workitemId}/wrapups: get: tags: - Task Management summary: Get all wrapup codes added for all users for a workitem. description: '' operationId: getTaskmanagementWorkitemWrapups produces: - application/json parameters: - name: workitemId in: path description: The ID of the Workitem. required: true type: string - name: expands in: query description: Which fields, if any, to expand. required: false type: string enum: - wrapupCode - 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: Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50. required: false type: integer default: 25 format: int32 - name: sortOrder in: query description: Ascending or descending sort order required: false type: string default: descending enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemWrapupEntityListing' '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' forbidden: 'User does not have the wrapup view permission ' 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: workitem.not.found: Workitem 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. security: - PureCloud OAuth: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:wrapup:view x-purecloud-method-name: getTaskmanagementWorkitemWrapups /api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}: get: tags: - Task Management summary: Get a status description: '' operationId: getTaskmanagementWorktypeStatus produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string - name: statusId in: path description: Status id required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemStatus' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.empty.value: Empty value. 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.input.wrong.attribute.type: Wrong attribute type. 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.input.invalid.uuid: Invalid UUID. 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. not.found.error: Worktype or Status 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:status:view x-purecloud-method-name: getTaskmanagementWorktypeStatus delete: tags: - Task Management summary: Delete a status description: '' operationId: deleteTaskmanagementWorktypeStatus produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string - name: statusId in: path description: Status id required: true type: string responses: '204': description: Deleted successfully '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.empty.value: Empty value. 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.input.wrong.attribute.type: Wrong attribute type. invalid.input.invalid.uuid: Invalid UUID. '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. not.found.error: Worktype or Status 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. pre.check.worktype.has.flow: Cannot delete a status when its worktype is linked to a workitem flow. pre.check.status.is.default.status: The status is the Worktype's default status. pre.check.worktype.being.used: Worktype is in use. pre.check.status.is.destination: The status is a destination status. pre.check.status.is.default.destination: The status is a default destination of another status. pre.check.status.referenced.by.rule: The status is being referenced by a rule. '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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:status:delete x-purecloud-method-name: deleteTaskmanagementWorktypeStatus patch: tags: - Task Management summary: Update the attributes of a status description: '' operationId: patchTaskmanagementWorktypeStatus produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string - name: statusId in: path description: Status id required: true type: string - in: body name: body description: Status required: true schema: $ref: '#/definitions/WorkitemStatusUpdate' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemStatus' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.no.attribute.to.update: No attributes to update. invalid.input.int.value.too.high: Integer too high. invalid.input.attr.not.updatable: Attribute not updatable. bad.request: The request could not be understood by the server due to malformed syntax. invalid.input.wrong.attribute.type: Wrong attribute type. constraint.validation: '%s' invalid.input.string.value.too.short: String too short. invalid.input.string.value.too.long: String too long. invalid.input.duplicate.status.name: Duplicate status name. invalid.input.transition.delay.too.low: Transition delay too low. invalid.input.auto.transition.disabled.for.terminate.status: A status that terminates cannot add an auto transition. invalid.input.empty.value: Empty value. invalid.input.transition.delay.too.high: Transition delay too high. 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.input.invalid.uuid: Invalid UUID. invalid.input.list.value.too.long: List too long. invalid.input.wrong.time.format: Wrong time format. db.transaction.cancelled: Database transaction was cancelled. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' invalid.input.duplicate.destinations: Duplicate destinations. invalid.input.status.not.in.status.list: Status not in status list. invalid.input.status.itself.as.destination: Cannot have itself as destination. invalid.input.no.change: No changes found in request. invalid.property: Value [%s] is not a valid property for object [%s] invalid.input.default.status.cannot.be.terminating: The initial status of a workitem cannot be configured as terminating status. invalid.input.destinations.without.default.destination: Destinations list does not contain the default destination. invalid.input.auto.terminate.not.applicable.for.status.category: Auto termination is not applicable for this status category. invalid.input.destination.does.not.exist: Destination does not exist. invalid.input.int.value.too.low: Integer too low. 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.input.missing.transition.delay: Missing transition delay. '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. not.found.error: Worktype or Status 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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:status:edit x-purecloud-method-name: patchTaskmanagementWorktypeStatus /api/v2/taskmanagement/worktypes/{worktypeId}/statuses: get: tags: - Task Management summary: Get list of statuses for this worktype. description: '' operationId: getTaskmanagementWorktypeStatuses produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemStatusListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.invalid.path.id: Invalid UUID. 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. not.found.error: Worktype 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:status:view x-purecloud-method-name: getTaskmanagementWorktypeStatuses post: tags: - Task Management summary: Add a status to a worktype description: '' operationId: postTaskmanagementWorktypeStatuses produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string - in: body name: body description: Status required: true schema: $ref: '#/definitions/WorkitemStatusCreate' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemStatus' '201': description: Workitem status created. schema: $ref: '#/definitions/Worktype' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.int.value.too.high: Integer too high. invalid.input.invalid.category: Invalid category. bad.request: The request could not be understood by the server due to malformed syntax. invalid.input.wrong.attribute.type: Wrong attribute type. constraint.validation: '%s' invalid.input.string.value.too.short: String too short. invalid.input.string.value.too.long: String too long. invalid.input.duplicate.status.name: Duplicate status name. invalid.input.transition.delay.too.low: Transition delay too low. invalid.input.auto.transition.disabled.for.terminate.status: A status that terminates cannot add an auto transition. invalid.input.empty.value: Empty value. invalid.input.transition.delay.too.high: Transition delay too high. 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.input.invalid.uuid: Invalid UUID. invalid.input.list.value.too.long: List too long. invalid.input.wrong.time.format: Wrong time format. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' invalid.input.duplicate.destinations: Duplicate destinations. invalid.input.status.not.in.status.list: Status not in status list. invalid.property: Value [%s] is not a valid property for object [%s] invalid.input.auto.terminate.not.applicable.for.status.category: Auto termination is not applicable for this status category. invalid.input.destination.does.not.exist: Destination does not exist. invalid.input.limit.reached: Limit reached for number of statuses. invalid.input.int.value.too.low: Integer too low. 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.input.missing.transition.delay: Missing transition delay. '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. not.found.error: Worktype 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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:status:add x-purecloud-method-name: postTaskmanagementWorktypeStatuses /api/v2/taskmanagement/worktypes/query: post: tags: - Task Management summary: Query for worktypes description: Optional request field 'expands' may include 'schema' to populate the name on each worktype's schema reference. operationId: postTaskmanagementWorktypesQuery produces: - application/json parameters: - in: body name: body description: QueryPostRequest required: true schema: $ref: '#/definitions/WorktypeQueryRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/WorktypeQueryEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.int.value.too.high: Page size too large. invalid.input.invalid.base64.string: Wrong cursor (after key) format invalid.input.wrong.number.values: Wrong number of values provided for filter bad.request: The request could not be understood by the server due to malformed syntax. invalid.input.wrong.attribute.type: Wrong attribute type. invalid.query.operator.and.type: Certain operators and types cannot be used together workitem.max.division.filters: Maximum of 50 divisionIds are allowed in filter. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.input.filter.without.value: Missing filter values invalid.input.empty.value: Empty value. invalid.input.int.value.too.low: Page size too small. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.query.between.order.of.values: First value cannot be greater than the second value for a BETWEEN operator 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.input.invalid.uuid: Invalid UUID. invalid.query: Invalid query invalid.query.sort.attribute.in.invalid.filter: Sorting attribute is in an invalid filter invalid.query.null.with.operator.and.type: Null values cannot be used with certain operators and types 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' workitem.missing.any.division.permissions: User has no permission access to the division. 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ALL permissions: - workitems:worktype:view x-purecloud-method-name: postTaskmanagementWorktypesQuery /api/v2/taskmanagement/worktypes/{worktypeId}: get: tags: - Task Management summary: Get a worktype description: '' operationId: getTaskmanagementWorktype produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string - name: expands in: query description: Which fields, if any, to expand. required: false type: array items: type: string enum: - defaultQueue - defaultSkills - defaultLanguage - schema - flow - defaultScript collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/Worktype' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.empty.value: Empty value. 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.input.wrong.attribute.type: Wrong attribute type. 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.input.invalid.uuid: Invalid UUID. 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. not.found.error: Worktype 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:worktype:view x-purecloud-method-name: getTaskmanagementWorktype delete: tags: - Task Management summary: Delete a worktype description: '' operationId: deleteTaskmanagementWorktype produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string responses: '204': description: Deleted successfully '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.empty.value: Empty value. 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.input.wrong.attribute.type: Wrong attribute type. invalid.input.invalid.uuid: Invalid UUID. '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. not.found.error: Worktype 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. pre.check.worktype.being.used: Worktype still has Workitems associated to it. '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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:worktype:delete x-purecloud-method-name: deleteTaskmanagementWorktype patch: tags: - Task Management summary: Update the attributes of a worktype description: '' operationId: patchTaskmanagementWorktype produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string - in: body name: body description: Worktype required: true schema: $ref: '#/definitions/WorktypeUpdate' responses: '200': description: successful operation schema: $ref: '#/definitions/Worktype' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.no.attribute.to.update: No attributes to update. invalid.input.int.value.too.high: Integer too high. worktype.script.division.mismatch: Worktype must be in the same division as the default script. invalid.input.attr.not.updatable: Attribute not updatable. bad.request: The request could not be understood by the server due to malformed syntax. invalid.input.wrong.attribute.type: Wrong attribute type. invalid.input.default.queue.required: Default Queue ID cannot be null if Assignment is enabled. constraint.validation: '%s' invalid.input.string.value.too.short: String too short. invalid.input.string.value.too.long: String too long. invalid.input.empty.value: Empty value. 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.input.invalid.uuid: Invalid UUID. invalid.input.list.value.too.long: List too long. db.transaction.cancelled: Database transaction was cancelled. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' invalid.input.status.not.in.status.list: Status not in status list. invalid.input.no.change: No changes found in request. invalid.property: Value [%s] is not a valid property for object [%s] invalid.input.default.status.cannot.be.terminating: The initial status of a workitem cannot be configured as terminating status. invalid.input.schema.cannot.change: Schema cannot be changed. invalid.input.int.value.too.low: Integer too low. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable worktype.queue.division.mismatch: Worktype must be in the same division as the default queue. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' workitem.schema.not.updatable: The schemaId of a worktype cannot be updated. '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: routing.skill.ids.not.found: Skill IDs do not exist not.found: The requested resource was not found. queue.ids.not.found: Queue ID does not exist not.found.error: Worktype or Workbin 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: workitem.schema.version.not.allowed: Cannot set a schemaVersion to an older version. request.conflict: The request conflicts with the current state of the target resource. pre.check.value.less.than: Value is too low. pre.check.worktype.workbin.division.mismatch: A Worktype and its default Workbin must belong to the same division. pre.check.name.in.use: Name is already in use. pre.check.value.greater.than: Due duration greater than expiration or expiration greater than TTL. pre.check.cannot.launch.flow.and.start.assignment: A Worktype cannot be configured to launch both a flow and start assignment at workitem creation time. '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: - workitems x-inin-requires-permissions: type: ALL permissions: - workitems:worktype:edit x-purecloud-method-name: patchTaskmanagementWorktype /api/v2/taskmanagement/worktypes/{worktypeId}/versions: get: tags: - Task Management summary: Get all versions of a worktype description: '' operationId: getTaskmanagementWorktypeVersions produces: - application/json parameters: - name: worktypeId in: path description: Worktype 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: Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. required: false type: integer default: 25 format: int32 - name: sortOrder in: query description: Ascending or descending sort order required: false type: string default: descending enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/WorktypeVersionListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.int.value.too.high: Page size too large. invalid.input.int.value.too.low: Page size too small. 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.input.invalid.uuid: Invalid UUID. 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:worktype:view x-purecloud-method-name: getTaskmanagementWorktypeVersions /api/v2/taskmanagement/worktypes/{worktypeId}/versions/{entityVersion}: get: tags: - Task Management summary: Get a version of a worktype description: '' operationId: getTaskmanagementWorktypeVersion produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string - name: entityVersion in: path description: Worktype version required: true type: integer minimum: 1 format: int32 responses: '200': description: successful operation schema: $ref: '#/definitions/WorktypeVersion' '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.input.invalid.uuid: Invalid UUID. 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: version.not.found: Version 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. security: - PureCloud OAuth: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:worktype:view x-purecloud-method-name: getTaskmanagementWorktypeVersion /api/v2/taskmanagement/worktypes/{worktypeId}/history: get: tags: - Task Management summary: Get a listing of a worktype's attribute change history description: '' operationId: getTaskmanagementWorktypeHistory produces: - application/json parameters: - name: worktypeId in: path description: Worktype 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: Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. required: false type: integer default: 25 format: int32 - name: sortOrder in: query description: Ascending or descending sort order required: false type: string default: descending enum: - ascending - descending - name: fields in: query description: Comma-separated list of fields. The response will contain only versions created as a result of changes to these fields. required: false type: array items: type: string enum: - name - serviceLevelTarget - defaultWorkbinId - defaultDueDurationSeconds - defaultExpirationSeconds - defaultPriority - defaultLanguageId - defaultSkillIds - defaultQueueId - assignmentEnabled - defaultStatusId - statuses collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/WorktypeChangeListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.int.value.too.high: Page size too large. invalid.input.int.value.too.low: Page size too small. 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.input.invalid.uuid: Invalid UUID. 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:worktype:view x-purecloud-method-name: getTaskmanagementWorktypeHistory /api/v2/taskmanagement/worktypes: post: tags: - Task Management summary: Create a worktype description: '' operationId: postTaskmanagementWorktypes produces: - application/json parameters: - in: body name: body description: Worktype required: true schema: $ref: '#/definitions/WorktypeCreate' responses: '200': description: successful operation schema: $ref: '#/definitions/Worktype' '201': description: Worktype created. schema: $ref: '#/definitions/Worktype' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.int.value.too.high: Integer too high. worktype.script.division.mismatch: Worktype must be in the same division as the default script. workitem.default.workbin.required: A defaultWorkbinId is required. bad.request: The request could not be understood by the server due to malformed syntax. invalid.input.wrong.attribute.type: Wrong attribute type. invalid.input.default.queue.required: Default Queue ID cannot be null if Assignment is enabled. invalid.property: Value [%s] is not a valid property for object [%s] workitem.division.mismatch: Worktype must be in the same division as its default Workbin. constraint.validation: '%s' invalid.input.string.value.too.short: String too short. invalid.input.string.value.too.long: String too long. invalid.input.empty.value: Empty value. invalid.input.int.value.too.low: Integer too low. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable worktype.queue.division.mismatch: Worktype must be in the same division as the default queue. 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.input.invalid.uuid: Invalid UUID. invalid.input.list.value.too.long: List too long. 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: routing.skill.ids.not.found: Skill IDs do not exist not.found: The requested resource was not found. queue.ids.not.found: Queue ID does not exist not.found.error: Default Workbin 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. pre.check.value.less.than: Value is too low. pre.check.name.in.use: Name is already in use. pre.check.value.greater.than: Due duration greater than expiration or expiration greater than TTL. pre.check.maximum.limit.reached: Maximum number of Worktypes 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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:worktype:add x-purecloud-method-name: postTaskmanagementWorktypes /api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules/{ruleId}: get: tags: - Task Management summary: Get a date based rule description: '' operationId: getTaskmanagementWorktypeFlowsDatebasedRule produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string - name: ruleId in: path description: ruleId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemDateBasedRule' '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.input.invalid.uuid: Invalid UUID. 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. not.found.error: Worktype or rule 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:flowRuleDateBased:view x-purecloud-method-name: getTaskmanagementWorktypeFlowsDatebasedRule delete: tags: - Task Management summary: Delete a date based rule description: '' operationId: deleteTaskmanagementWorktypeFlowsDatebasedRule produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string - name: ruleId in: path description: ruleId required: true type: string responses: '204': description: Deleted 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.input.invalid.uuid: Invalid UUID. '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. not.found.error: Worktype or rule 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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:flowRuleDateBased:delete x-purecloud-method-name: deleteTaskmanagementWorktypeFlowsDatebasedRule patch: tags: - Task Management summary: Update the attributes of a date based rule description: '' operationId: patchTaskmanagementWorktypeFlowsDatebasedRule produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string - name: ruleId in: path description: ruleId required: true type: string - in: body name: body description: Rule required: true schema: $ref: '#/definitions/WorkitemDateBasedRuleUpdate' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemDateBasedRule' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.int.value.too.high: Integer too high. bad.request: The request could not be understood by the server due to malformed syntax. invalid.input.wrong.attribute.type: Wrong attribute type. invalid.input.no.change: No changes found in request. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.input.empty.value: Empty value. invalid.input.int.value.too.low: Integer too low. 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.input.invalid.uuid: Invalid UUID. 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. not.found.error: Worktype or Rule 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. pre.check.name.in.use: Name is already in use. pre.check.maximum.limit.reached: The maximum amount of allowed date-based rules has been reached. pre.check.conflicting.time.rule.condition: Rule has time difference of less than 15 minutes with another rule. '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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:flowRuleDateBased:edit x-purecloud-method-name: patchTaskmanagementWorktypeFlowsDatebasedRule /api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules: get: tags: - Task Management summary: Get all date based rules for a worktype description: '' operationId: getTaskmanagementWorktypeFlowsDatebasedRules produces: - application/json parameters: - name: worktypeId in: path description: Worktype 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: Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. required: false type: integer default: 25 format: int32 responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemDateBasedRuleListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.int.value.too.high: Page size too large. invalid.input.int.value.too.low: Page size too small. 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.input.invalid.uuid: Invalid UUID. 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:flowRuleDateBased:view x-purecloud-method-name: getTaskmanagementWorktypeFlowsDatebasedRules post: tags: - Task Management summary: Add a date based rule to a worktype description: '' operationId: postTaskmanagementWorktypeFlowsDatebasedRules produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string - in: body name: body description: Rule required: true schema: $ref: '#/definitions/WorkitemDateBasedRuleCreate' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemDateBasedRule' '201': description: Workitem rule created. schema: $ref: '#/definitions/WorkitemDateBasedRule' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.int.value.too.high: Integer too high. bad.request: The request could not be understood by the server due to malformed syntax. invalid.input.wrong.attribute.type: Wrong attribute type. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.input.empty.value: Empty value. invalid.input.int.value.too.low: Integer too low. 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.input.invalid.uuid: Invalid UUID. 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. not.found.error: Worktype 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. pre.check.name.in.use: Name is already in use. pre.check.maximum.limit.reached: The maximum amount of allowed date-based rules has been reached. pre.check.conflicting.time.rule.condition: Rule has time difference of less than 15 minutes with another rule. '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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:flowRuleDateBased:add x-purecloud-method-name: postTaskmanagementWorktypeFlowsDatebasedRules /api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}: get: tags: - Task Management summary: Get an attribute change rule description: '' operationId: getTaskmanagementWorktypeFlowsOnattributechangeRule produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string - name: ruleId in: path description: ruleId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemOnAttributeChangeRule' '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.input.invalid.uuid: Invalid UUID. 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. not.found.error: Worktype or rule 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:flowRuleOnAttributeChange:view x-purecloud-method-name: getTaskmanagementWorktypeFlowsOnattributechangeRule delete: tags: - Task Management summary: Delete a rule description: '' operationId: deleteTaskmanagementWorktypeFlowsOnattributechangeRule produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string - name: ruleId in: path description: ruleId required: true type: string responses: '204': description: Deleted 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.input.invalid.uuid: Invalid UUID. '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. not.found.error: Worktype or rule 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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:flowRuleOnAttributeChange:delete x-purecloud-method-name: deleteTaskmanagementWorktypeFlowsOnattributechangeRule patch: tags: - Task Management summary: Update the attributes of a rule description: '' operationId: patchTaskmanagementWorktypeFlowsOnattributechangeRule produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string - name: ruleId in: path description: ruleId required: true type: string - in: body name: body description: Rule required: true schema: $ref: '#/definitions/WorkitemOnAttributeChangeRuleUpdate' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemOnAttributeChangeRule' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.empty.value: Empty value. 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.input.wrong.attribute.type: Wrong attribute type. 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.input.no.change: No changes found in request. invalid.property: Value [%s] is not a valid property for object [%s] invalid.input.invalid.uuid: Invalid UUID. 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. not.found.error: Worktype or Rule 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. pre.check.name.in.use: Name is already in use. pre.check.conflicting.rule.condition: Condition conflicts with another rules condition. pre.check.cannot.have.equal.old.and.new.values: Condition cannot having equal old and new values. '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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:flowRuleOnAttributeChange:edit x-purecloud-method-name: patchTaskmanagementWorktypeFlowsOnattributechangeRule /api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules: get: tags: - Task Management summary: Get all attribute-change rules for a worktype description: '' operationId: getTaskmanagementWorktypeFlowsOnattributechangeRules produces: - application/json parameters: - name: worktypeId in: path description: Worktype 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: Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. required: false type: integer default: 25 format: int32 responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemOnAttributeChangeRuleListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.int.value.too.high: Page size too large. invalid.input.int.value.too.low: Page size too small. 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.input.invalid.uuid: Invalid UUID. 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:flowRuleOnAttributeChange:view x-purecloud-method-name: getTaskmanagementWorktypeFlowsOnattributechangeRules post: tags: - Task Management summary: Add an attribute-change rule to a worktype description: '' operationId: postTaskmanagementWorktypeFlowsOnattributechangeRules produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string - in: body name: body description: Rule required: true schema: $ref: '#/definitions/WorkitemOnAttributeChangeRuleCreate' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemOnAttributeChangeRule' '201': description: Workitem rule created. schema: $ref: '#/definitions/WorkitemOnAttributeChangeRule' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.empty.value: Empty value. 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. not.found.error: Worktype 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. pre.check.name.in.use: Name is already in use. pre.check.maximum.limit.reached: The maximum amount of allowed attribute-change rules has been reached. pre.check.conflicting.rule.condition: Condition conflicts with another rules condition. pre.check.cannot.have.equal.old.and.new.values: Condition cannot having equal old and new values. '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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:flowRuleOnAttributeChange:add x-purecloud-method-name: postTaskmanagementWorktypeFlowsOnattributechangeRules /api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}: get: tags: - Task Management summary: Get an on-create rule description: '' operationId: getTaskmanagementWorktypeFlowsOncreateRule produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string - name: ruleId in: path description: ruleId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemOnCreateRule' '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.input.invalid.uuid: Invalid UUID. 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. not.found.error: Worktype or rule 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:flowRuleOnCreate:view x-purecloud-method-name: getTaskmanagementWorktypeFlowsOncreateRule delete: tags: - Task Management summary: Delete a rule description: '' operationId: deleteTaskmanagementWorktypeFlowsOncreateRule produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string - name: ruleId in: path description: ruleId required: true type: string responses: '204': description: Deleted 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.input.invalid.uuid: Invalid UUID. '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. not.found.error: Worktype or rule 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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:flowRuleOnCreate:delete x-purecloud-method-name: deleteTaskmanagementWorktypeFlowsOncreateRule patch: tags: - Task Management summary: Update the attributes of a rule description: '' operationId: patchTaskmanagementWorktypeFlowsOncreateRule produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string - name: ruleId in: path description: ruleId required: true type: string - in: body name: body description: Rule required: true schema: $ref: '#/definitions/WorkitemOnCreateRuleUpdate' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemOnCreateRule' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.empty.value: Empty value. 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.input.wrong.attribute.type: Wrong attribute type. 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.input.no.change: No changes found in request. invalid.property: Value [%s] is not a valid property for object [%s] invalid.input.invalid.uuid: Invalid UUID. 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. not.found.error: Worktype or Rule 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. pre.check.name.in.use: Name is already in use. '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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:flowRuleOnCreate:edit x-purecloud-method-name: patchTaskmanagementWorktypeFlowsOncreateRule /api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules: get: tags: - Task Management summary: Get all on-create rules for a worktype description: '' operationId: getTaskmanagementWorktypeFlowsOncreateRules produces: - application/json parameters: - name: worktypeId in: path description: Worktype 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: Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. required: false type: integer default: 25 format: int32 responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemOnCreateRuleListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.input.int.value.too.high: Page size too large. invalid.input.int.value.too.low: Page size too small. 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.input.invalid.uuid: Invalid UUID. 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: - workitems - workitems:readonly x-inin-requires-permissions: type: ANY permissions: - workitems:flowRuleOnCreate:view x-purecloud-method-name: getTaskmanagementWorktypeFlowsOncreateRules post: tags: - Task Management summary: Add an on-create rule to a worktype description: '' operationId: postTaskmanagementWorktypeFlowsOncreateRules produces: - application/json parameters: - name: worktypeId in: path description: Worktype id required: true type: string - in: body name: body description: Rule required: true schema: $ref: '#/definitions/WorkitemOnCreateRuleCreate' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkitemOnCreateRule' '201': description: Workitem rule created. schema: $ref: '#/definitions/WorkitemOnCreateRule' '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. not.found.error: Worktype 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. pre.check.name.in.use: Name is already in use. pre.check.maximum.limit.reached: The maximum amount of allowed on-create rules has been reached for the worktype. pre.check.cannot.launch.flow.and.start.assignment: Worktype cannot have both assignmentEnabled set to true and an on-create launch flow rule. '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: - workitems x-inin-requires-permissions: type: ANY permissions: - workitems:flowRuleOnCreate:add x-purecloud-method-name: postTaskmanagementWorktypeFlowsOncreateRules definitions: JsonSchemaDocument: type: object properties: id: type: string $schema: type: string title: type: string description: type: string type: type: string required: type: array items: type: string properties: type: object additionalProperties: type: object additionalProperties: type: object description: A JSON Schema document. WorkitemsChangeWorkbinDelta: type: object properties: version: type: integer format: int32 description: Version modifiedBy: description: modifiedBy $ref: '#/definitions/UserReference' delta: description: The changes that originated this version $ref: '#/definitions/WorkbinDelta' WorkitemDateBasedRuleCreate: type: object required: - condition - name properties: name: type: string description: The name of the rule. minLength: 3 maxLength: 256 condition: description: The rules condition. If the condition criteria is met the rules action will be executed. $ref: '#/definitions/WorkitemDateBasedCondition' WorktypeCreate: type: object required: - defaultWorkbinId - name properties: name: type: string description: The name of the Worktype. Valid length between 3 and 256 characters. defaultWorkbinId: type: string description: The ID of the default Workbin for Workitems created from the Worktype. defaultDurationSeconds: type: integer format: int32 description: The default duration in seconds for Workitems created from the Worktype. Maximum of 365 days. minimum: 0 maximum: 31536000 defaultExpirationSeconds: type: integer format: int32 description: The default expiration time in seconds for Workitems created from the Worktype. Maximum of 365 days. minimum: 0 maximum: 31536000 defaultDueDurationSeconds: type: integer format: int32 description: The default due duration in seconds for Workitems created from the Worktype. Maximum of 365 days. minimum: 0 maximum: 31536000 defaultPriority: type: integer format: int32 description: The default priority for Workitems created from the Worktype. The valid range is between -25,000,000 and 25,000,000. minimum: -25000000 maximum: 25000000 defaultTtlSeconds: type: integer format: int32 description: The default time to time to live in seconds for Workitems created from the Worktype. The valid range is between 1 and 365 days. minimum: 86400 maximum: 31536000 assignmentEnabled: type: boolean description: When set to true, Workitems will be sent to the queue of the Worktype as they are created. Default value is false. schemaId: type: string description: The ID of the custom attribute schema for Workitems created from the Worktype. Must be a valid UUID. pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' serviceLevelTarget: type: integer format: int32 description: The target service level for Workitems created from the Worktype. The default value is 100. minimum: 1 maximum: 100 ruleSettings: description: Settings for the worktypes rules. $ref: '#/definitions/WorkitemRuleSettings' unassignedDivisionContactsEnabled: type: boolean description: When set to true, will allow Workitems to be associated with External Contacts that are not assigned to any division. Default value is true. description: type: string description: The description of the Worktype. Maximum length of 512 characters. minLength: 0 maxLength: 512 divisionId: type: string description: The ID of the division the Worktype belongs to. Defaults to the default Workbin division ID. The Worktype must be in the same division as its default Workbin. pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' disableDefaultStatusCreation: type: boolean description: Set to true to disable default status creation. Default statuses are created with the Worktype by default schemaVersion: type: integer format: int32 description: The version of the Worktypes custom attribute schema. The latest schema version will be used if this property is not set. defaultQueueId: type: string description: The ID of the default queue for Workitems created from the Worktype. Must be a valid UUID. pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' defaultLanguageId: type: string description: The ID of the default language for Workitems created from the Worktype. Must be a valid UUID. pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' defaultSkillIds: type: array description: The IDs of the default skills for Workitems created from the Worktype. Must be valid UUIDs. Maximum of 20 IDs items: type: string defaultScriptId: type: string description: The default script for Workitems created from the Worktype. Must be a valid UUID. pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' Worktype: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the Worktype. division: description: The division to which this entity belongs. $ref: '#/definitions/Division' description: type: string description: The description of the Worktype. dateCreated: type: string format: date-time description: 'The creation date of the Worktype. 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 modified date of the Worktype. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' defaultWorkbin: description: The default Workbin for Workitems created from the Worktype. $ref: '#/definitions/WorkbinReference' defaultStatus: description: The default status for Workitems created from the Worktype. $ref: '#/definitions/WorkitemStatusReference' statuses: type: array description: The list of possible statuses for Workitems created from the Worktype. items: $ref: '#/definitions/WorkitemStatus' defaultDurationSeconds: type: integer format: int32 description: The default duration in seconds for Workitems created from the Worktype. defaultExpirationSeconds: type: integer format: int32 description: The default expiration time in seconds for Workitems created from the Worktype. defaultDueDurationSeconds: type: integer format: int32 description: The default due duration in seconds for Workitems created from the Worktype. defaultPriority: type: integer format: int32 description: The default priority for Workitems created from the Worktype. The valid range is between -25,000,000 and 25,000,000. defaultLanguage: description: The default language for Workitems created from the Worktype. $ref: '#/definitions/LanguageReference' defaultTtlSeconds: type: integer format: int32 description: The default time to time to live in seconds for Workitems created from the Worktype. modifiedBy: description: The id of the User who modified the Worktype. $ref: '#/definitions/UserReference' defaultQueue: description: The default queue for Workitems created from the Worktype. $ref: '#/definitions/WorkitemQueueReference' defaultSkills: type: array description: The default skills for Workitems created from the Worktype. items: $ref: '#/definitions/RoutingSkillReference' assignmentEnabled: type: boolean description: When set to true, Workitems will be sent to the queue of the Worktype as they are created. Default value is false. schema: description: The schema defining the custom attributes for Workitems created from the Worktype. $ref: '#/definitions/WorkitemSchema' serviceLevelTarget: type: integer format: int32 description: The target service level for Workitems created from the Worktype. The default value is 100. ruleSettings: description: Settings for the worktypes rules. $ref: '#/definitions/WorkitemRuleSettings' flow: description: The flow associated with the Worktype. $ref: '#/definitions/WorkitemFlowReference' defaultScript: description: The default script for Workitems created from the Worktype. $ref: '#/definitions/WorkitemScriptReference' unassignedDivisionContactsEnabled: type: boolean description: When set to true, will allow Workitems to be associated with External Contacts that are not assigned to any division. Default value is true. selfUri: type: string format: uri description: The URI for this object readOnly: true Workitem: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the Workitem. division: description: The division to which this entity belongs. $ref: '#/definitions/Division' type: description: The Worktype of the Workitem. $ref: '#/definitions/WorktypeReference' description: type: string description: The description of the Workitem. language: description: The language of the Workitem. $ref: '#/definitions/LanguageReference' utilizationLabel: description: The utilization label of the Workitem. $ref: '#/definitions/WorkitemUtilizationLabelReference' priority: type: integer format: int32 description: The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000. dateCreated: type: string format: date-time description: 'The creation date of the Workitem. 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 modified date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateDue: type: string format: date-time description: 'The due date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateExpires: type: string format: date-time description: 'The expiry date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' durationSeconds: type: integer format: int32 description: The estimated duration in seconds to complete the workitem. ttl: type: integer format: int32 description: The time to live of the Workitem in seconds. status: description: The current Status of the Workitem. $ref: '#/definitions/WorkitemStatusReference' statusCategory: type: string description: The Category of the current Status of the Workitem. enum: - Open - InProgress - Waiting - Closed - Unknown dateStatusChanged: type: string format: date-time description: 'The State change date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateClosed: type: string format: date-time description: 'The date the Workitem was closed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' workbin: description: The Workbin that contains the Workitem. $ref: '#/definitions/WorkbinReference' reporter: description: The reporter of the Workitem. $ref: '#/definitions/UserReferenceWithName' assignee: description: The assignee of the Workitem. $ref: '#/definitions/UserReferenceWithName' externalContact: description: The external contact of the Workitem. $ref: '#/definitions/ExternalContactReference' externalTag: type: string description: The external tag of the Workitem. modifiedBy: description: The User who modified the Workitem. $ref: '#/definitions/UserReference' queue: description: The Workitems queue. $ref: '#/definitions/WorkitemQueueReference' assignmentState: type: string description: The assignment state of the workitem. enum: - Unknown - AcdStarted - Alerting - AlertTimeout - AcdCancelled - Terminated - Idle - Declined - Connected - Disconnected - Parked - Held - AcdExpired dateAssignmentStateChanged: type: string format: date-time description: 'The assignment state change date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' alertTimeoutSeconds: type: integer format: int32 description: The duration in seconds before an alert will timeout. skills: type: array description: The skills of the Workitem. items: $ref: '#/definitions/RoutingSkillReference' preferredAgents: type: array description: The preferred agents of the Workitem. items: $ref: '#/definitions/UserReference' autoStatusTransition: type: boolean description: Set it to false to disable auto status transition. By default, it is enabled. schema: description: The schema defining the custom fields of the Workitem. The schema is inherited from the Workitems Worktype at creation time. $ref: '#/definitions/WorkitemSchema' customFields: type: object description: Custom fields defined in the schema referenced by the Workitem. additionalProperties: type: object autoStatusTransitionDetail: description: Auto status transition details of Workitem. $ref: '#/definitions/AutoStatusTransitionDetail' scoredAgents: type: array description: A list of scored agents for the Workitem. items: $ref: '#/definitions/WorkitemScoredAgent' script: description: The script that will be executed for the Workitem. $ref: '#/definitions/WorkitemScriptReference' selfUri: type: string format: uri description: The URI for this object readOnly: true WorktypeQuerySort: type: object properties: name: type: string description: 'Specify an attribute for sorting. It''s possible to use an attribute both for sorting and in the query at the same time, but these restrictions apply: Only the operators EQ, LT, LTE, GT, GTE, BETWEEN and BEGINS_WITH are supported and the attribute can''t be present in more than one filter.' enum: - dateModified - name ascending: type: boolean description: Sort Ascending WorkitemScoredAgentDelta: type: object properties: id: type: string score: type: integer format: int32 WorkitemWrapupEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/WorkitemWrapup' nextUri: type: string selfUri: type: string previousUri: type: string WorkbinQueryEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/Workbin' nextUri: type: string selfUri: type: string previousUri: type: string after: type: string count: type: integer format: int32 description: Count of items returned by the query. Refer to the "select" request parameter for more information. WorkbinQueryRequest: type: object required: - filters properties: pageSize: type: integer format: int32 description: Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. select: type: string description: Specify the value 'Count' for this parameter in order to return only the record count. enum: - Count filters: type: array description: 'List of filter objects to be used in the search. Valid filter names are: ''id'', ''name'', ''description'', ''divisionId'', ''dateCreated'', ''dateModified'', ''modifiedBy''' items: $ref: '#/definitions/WorkitemFilter' attributes: type: array description: List of entity attributes to be retrieved in the result. items: type: string after: type: string description: The cursor that points to the end of the set of entities that has been returned. sort: description: Sort $ref: '#/definitions/WorkbinQuerySort' BulkJobTerminateResultsResponse: type: object properties: results: type: array description: A list of the results from the bulk operation. items: $ref: '#/definitions/BulkJobTerminateResult' 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 WorkitemsAttributeChangeListWorkitemScoredAgentDelta: type: object properties: newValue: type: array description: New property value items: $ref: '#/definitions/WorkitemScoredAgentDelta' oldValue: type: array description: Old property value items: $ref: '#/definitions/WorkitemScoredAgentDelta' CoretypeListing: type: object properties: total: type: integer format: int64 entities: type: array items: $ref: '#/definitions/Coretype' selfUri: type: string format: uri WorkitemQueryJobQueryFiltersCriteria: type: object required: - predicates properties: operator: type: string description: Query filter logical operator to join predicates. enum: - AND - OR predicates: type: array description: Query filter predicates. Number of predicates within the query filter should be between 1 and 5. items: $ref: '#/definitions/WorkitemQueryJobQueryFiltersPredicate' maxItems: 5 minItems: 1 ItemValidationLimits: type: object required: - maxLength - minLength properties: minLength: example: '"minLength": {"min": 0, "max": 100}' description: A structure denoting the system-imposed minimum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field. $ref: '#/definitions/MinLength' maxLength: example: '"validationLimits": { "minLength": {"min": 0, "max": 100}, "maxLength": {"min": 1, "max": 100} }' description: A structure denoting the system-imposed minimum and maximum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field. $ref: '#/definitions/MaxLength' WorktypeReference: type: object properties: id: type: string description: The globally unique identifier for the object. name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true BulkJobTerminateResultEntity: 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 MaxLength: type: object required: - max - min properties: min: type: integer format: int64 description: A non-negative integer for a text-based schema field denoting the minimum largest length string the field can contain for a schema instance. max: type: integer format: int64 description: A non-negative integer for a text-based schema field denoting the maximum largest string the field can contain for a schema instance. WorkitemQueryJobFilter: type: object required: - name - operator - values properties: name: type: string description: 'Attribute name. Valid filter names are: ''workbinId'', ''id'', ''typeId'', ''priority'', ''dateCreated'', ''dateDue'', ''statusId'', ''dateClosed'', ''externalContactId'', ''assigneeId'', ''assignmentState'', ''queueId'', ''externalTag'', ''divisionId''' operator: type: string description: Filter operator. enum: - EQ - NEQ - GT - LT - GTE - LTE - IN - CONTAINS - BETWEEN - BEGINS_WITH values: type: array description: List of values to be used in the filter. items: type: string WorkitemQueryJobSort: type: object properties: name: type: string description: Specify an attribute for sorting. enum: - dateDue - dateCreated - priority ascending: type: boolean description: Sort Ascending WorkbinCreate: type: object required: - name properties: name: type: string description: Workbin name. Valid length between 3 and 256 characters. description: type: string description: Workbin description. Maximum length of 512 characters. divisionId: type: string description: The ID of the division the Workbin belongs to. Defaults to home division ID. WorkitemWrapup: type: object properties: workitem: description: Workitem that the wrapup code has been added to. $ref: '#/definitions/WorkitemReference' wrapupCode: description: The wrapup code used in the workitem. $ref: '#/definitions/WrapupIdReference' modifiedBy: description: The user who added the wrapup code to the workitem. $ref: '#/definitions/UserReference' user: description: The user for whom wrapup code was added. This may be the same as modifiedBy. $ref: '#/definitions/UserReference' dateModified: type: string format: date-time description: 'The modified date of the Workitem when the wrapup code was added. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' Workbin: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: Workbin name division: description: The division to which this entity belongs. $ref: '#/definitions/Division' description: type: string description: Workbin description dateCreated: type: string format: date-time description: 'The creation date of the Workbin. 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 modified date of the Workbin. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' modifiedBy: description: The id of the User who modified the Workbin. $ref: '#/definitions/UserReference' selfUri: type: string format: uri description: The URI for this object readOnly: true WorkitemFlowReference: type: object properties: id: type: string description: The globally unique identifier for the object. name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true RoutingSkillReference: 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 BulkJobTerminateResult: type: object properties: error: description: Error details if the operation failed. $ref: '#/definitions/BulkJobError' entity: description: The result of the operation if it succeeded. For Workitem Bulk Terminate this is a summary. $ref: '#/definitions/BulkJobTerminateResultEntity' WorkitemVersionListing: type: object properties: entities: type: array items: $ref: '#/definitions/WorkitemVersion' nextUri: type: string selfUri: type: string previousUri: type: string after: type: string BulkJobTerminateRequest: type: object required: - entities properties: entities: type: array description: The list of bulk job entities to terminate. items: $ref: '#/definitions/BulkJobEntity' maxItems: 100 minItems: 1 WorkitemsAttributeChangeMap: type: object properties: newValue: type: object description: New property value additionalProperties: type: object oldValue: type: object description: Old property value additionalProperties: type: object WrapupDelta: type: object properties: action: type: string enum: - Add - Remove code: type: string userId: type: string DataSchemaListing: type: object properties: total: type: integer format: int64 entities: type: array items: $ref: '#/definitions/DataSchema' selfUri: type: string format: uri WorkitemStatus: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string category: type: string description: The Category of the Status. enum: - Open - InProgress - Waiting - Closed - Unknown destinationStatuses: type: array description: The Statuses the Status can transition to. items: $ref: '#/definitions/WorkitemStatusReference' description: type: string description: The description of the Status. defaultDestinationStatus: description: Default destination status to which this Status will transition to if auto status transition enabled. $ref: '#/definitions/WorkitemStatusReference' statusTransitionDelaySeconds: type: integer format: int32 description: Delay in seconds for auto status transition statusTransitionTime: type: string format: local-time description: 'Time is represented as an ISO-8601 string without a timezone. For example: HH:mm:ss.SSS' worktype: description: The Worktype containing the Status. $ref: '#/definitions/WorktypeReference' autoTerminateWorkitem: type: boolean description: Terminate workitem on selection of status. Applicable only for statuses in the Closed category. selfUri: type: string format: uri description: The URI for this object readOnly: true WorkitemPagedEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/Workitem' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 pageCount: type: integer format: int32 WorkitemsAttributeChangeInstant: type: object properties: newValue: type: string format: date-time description: 'New property value. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' oldValue: type: string format: date-time description: 'Old property value. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' WorkitemPostQueryEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/Workitem' nextUri: type: string selfUri: type: string previousUri: type: string after: type: string count: type: integer format: int32 WorkitemQueueReference: type: object properties: id: type: string description: The globally unique identifier for the object. name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true WorkitemReference: type: object properties: id: type: string description: The globally unique identifier for the object. name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true WorkitemCommonCreate: type: object required: - name - typeId properties: name: type: string description: The name of the Workitem. Valid length between 3 and 256 characters. priority: type: integer format: int32 description: The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000. dateDue: type: string format: date-time description: 'The due date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateExpires: type: string format: date-time description: 'The expiry date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' durationSeconds: type: integer format: int32 description: The estimated duration in seconds to complete the Workitem. Maximum of 365 days. ttl: type: integer format: int32 description: The epoch timestamp in seconds specifying the time to live for the Workitem. Can not be greater than 365 days from the current time. statusId: type: string description: The ID of the Status of the Workitem. workbinId: type: string description: The ID of Workbin that contains the Workitem. autoStatusTransition: type: boolean description: Set it to false to disable auto status transition. By default, it is enabled. description: type: string description: The description of the Workitem. Maximum length of 512 characters. typeId: type: string description: The ID of the Worktype of the Workitem. customFields: type: object description: Custom fields defined in the schema referenced by the worktype of the workitem. additionalProperties: type: object queueId: type: string description: The ID of the Workitems queue. Must be a valid UUID. pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' assigneeId: type: string description: The ID of the assignee of the Workitem. Must be a valid UUID. pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' languageId: type: string description: The ID of language of the Workitem. Must be a valid UUID. externalContactId: type: string description: The ID of the external contact of the Workitem. Must be a valid UUID. externalTag: type: string description: The external tag of the Workitem. skillIds: type: array description: The skill IDs of the Workitem. Must be valid UUIDs. items: type: string scriptId: type: string description: The ID of the Workitems script. Must be a valid UUID. WorkitemDateBasedRule: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string type: type: string description: The type of the rule. enum: - OnCreate - OnAttributeChange - Date action: description: The rules action. If the condition criteria is met this action will be executed. $ref: '#/definitions/WorkitemRuleAction' worktype: description: The Worktype containing the rule. $ref: '#/definitions/WorktypeReference' condition: description: The rules condition. If the condition criteria is met the rules action will be executed. $ref: '#/definitions/WorkitemDateBasedCondition' selfUri: type: string format: uri description: The URI for this object readOnly: true WorkbinReference: type: object properties: id: type: string description: The globally unique identifier for the object. name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true WorkitemOnAttributeChangeRuleCreate: type: object required: - condition - name properties: name: type: string description: The name of the rule. minLength: 3 maxLength: 256 condition: description: The rules condition. If the condition criteria is met the rules action will be executed. $ref: '#/definitions/WorkitemOnAttributeChangeCondition' WorkbinQuerySort: type: object properties: name: type: string description: 'Specify an attribute for sorting. It''s possible to use an attribute both for sorting and in the query at the same time, but these restrictions apply: Only the operators EQ, LT, LTE, GT, GTE, BETWEEN and BEGINS_WITH are supported and the attribute can''t be present in more than one filter.' enum: - dateModified - name ascending: type: boolean description: Sort Ascending WorkitemUpdate: type: object properties: name: type: string description: The name of the Workitem. Valid length between 3 and 256 characters. priority: type: integer format: int32 description: The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000. dateDue: type: string format: date-time description: 'The due date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateExpires: type: string format: date-time description: 'The expiry date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' durationSeconds: type: integer format: int32 description: The estimated duration in seconds to complete the Workitem. Maximum of 365 days. ttl: type: integer format: int32 description: The epoch timestamp in seconds specifying the time to live for the Workitem. Can not be greater than 365 days from the current time. statusId: type: string description: The ID of the Status of the Workitem. workbinId: type: string description: The ID of Workbin that contains the Workitem. autoStatusTransition: type: boolean description: Set it to false to disable auto status transition. By default, it is enabled. description: type: string description: The description of the Workitem. Maximum length of 512 characters. dateClosed: type: string format: date-time description: 'The closed date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' assignmentState: type: string description: The assignment state of the Workitem. enum: - Unknown - AcdStarted - Alerting - AlertTimeout - AcdCancelled - Terminated - Idle - Declined - Connected - Disconnected - Parked - Held - AcdExpired assignmentOperation: type: string description: Set this value to AgentAssignmentAlerting and supply an 'assigneeId' to assign the workitem to an agent and alert the agent of the assignment. Set this value to QueueAssignmentAlerting and supply a 'queueId' to route the workitem to an agent who is a member of the queue and alert the agent. enum: - AgentAssignmentAlerting - QueueAssignmentAlerting customFields: type: object description: Custom fields defined in the schema referenced by the worktype of the workitem. If set to {}, the existing keys and values will be removed. additionalProperties: type: object queueId: type: string description: The ID of the Workitems queue. Must be a valid UUID. assigneeId: type: string description: The ID of the assignee of the Workitem. If supplied it must be a valid UUID. scoredAgents: type: array description: A list of scored agents for the Workitem. A workitem can have a maximum of 20 scored agents. items: $ref: '#/definitions/WorkitemScoredAgentRequest' externalContactId: type: string description: The ID of the external contact of the Workitem. Must be a valid UUID. externalTag: type: string description: The external tag of the Workitem. skillIds: type: array description: The skill IDs of the Workitem. Must be valid UUIDs. items: type: string languageId: type: string description: The ID of language of the Workitem. Must be a valid UUID. utilizationLabelId: type: string description: The ID of the utilization label of the Workitem. Must be a valid UUID. preferredAgentIds: type: array description: The preferred agent IDs of the Workitem. Must be valid UUIDs. items: type: string scriptId: type: string description: The ID of the Workitems script. Must be a valid UUID. WorkitemFilter: type: object required: - name - operator - type - values properties: name: type: string description: Attribute name. type: type: string description: Attribute type. enum: - String - Int operator: type: string description: Filter operator. enum: - EQ - NEQ - GT - LT - GTE - LTE - IN - CONTAINS - BETWEEN - BEGINS_WITH values: type: array description: List of values to be used in the filter. items: type: string WorktypeVersionListing: type: object properties: entities: type: array items: $ref: '#/definitions/WorktypeVersion' nextUri: type: string selfUri: type: string previousUri: type: string after: type: string WorkitemSchema: type: object required: - version properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string version: type: integer format: int32 description: The version of the Workitem custom attribute schema. selfUri: type: string format: uri description: The URI for this object readOnly: true WorkitemDelta: type: object properties: name: $ref: '#/definitions/WorkitemsAttributeChangeString' description: $ref: '#/definitions/WorkitemsAttributeChangeString' languageId: $ref: '#/definitions/WorkitemsAttributeChangeString' utilizationLabelId: $ref: '#/definitions/WorkitemsAttributeChangeString' priority: $ref: '#/definitions/WorkitemsAttributeChangeInteger' skillIds: $ref: '#/definitions/WorkitemsAttributeChangeList' preferredAgentIds: $ref: '#/definitions/WorkitemsAttributeChangeList' dateDue: $ref: '#/definitions/WorkitemsAttributeChangeInstant' dateExpires: $ref: '#/definitions/WorkitemsAttributeChangeInstant' durationSeconds: $ref: '#/definitions/WorkitemsAttributeChangeInteger' statusId: $ref: '#/definitions/WorkitemsAttributeChangeString' reporterId: $ref: '#/definitions/WorkitemsAttributeChangeString' externalContactId: $ref: '#/definitions/WorkitemsAttributeChangeString' assigneeId: $ref: '#/definitions/WorkitemsAttributeChangeString' workbinId: $ref: '#/definitions/WorkitemsAttributeChangeString' queueId: $ref: '#/definitions/WorkitemsAttributeChangeString' externalTag: $ref: '#/definitions/WorkitemsAttributeChangeString' wrapupId: $ref: '#/definitions/WorkitemsAttributeChangeString' wrapup: $ref: '#/definitions/WorkitemsAttributeChangeWrapupDelta' ttl: $ref: '#/definitions/WorkitemsAttributeChangeInteger' dateClosed: $ref: '#/definitions/WorkitemsAttributeChangeInstant' assignmentState: $ref: '#/definitions/WorkitemsAttributeChangeString' autoStatusTransition: $ref: '#/definitions/WorkitemsAttributeChangeBoolean' customFields: $ref: '#/definitions/WorkitemsAttributeChangeMap' dateModified: $ref: '#/definitions/WorkitemsAttributeChangeInstant' modifiedBy: $ref: '#/definitions/WorkitemsAttributeChangeString' statusCategory: $ref: '#/definitions/WorkitemsAttributeChangeWorkitemStatusCategory' scriptId: $ref: '#/definitions/WorkitemsAttributeChangeString' dateAssignmentStateChanged: $ref: '#/definitions/WorkitemsAttributeChangeInstant' alertTimeoutSeconds: $ref: '#/definitions/WorkitemsAttributeChangeInteger' scoredAgents: $ref: '#/definitions/WorkitemsAttributeChangeListWorkitemScoredAgentDelta' MinLength: type: object required: - max - min properties: min: type: integer format: int64 description: A non-negative integer for a text-based schema field denoting the minimum smallest length a string field can contain for a schema instance. max: type: integer format: int64 description: A non-negative integer for a text-based schema field denoting the maximum smallest length string the field can contain for a schema instance. WorkitemStatusCreate: type: object required: - category - name properties: name: type: string description: The name of the Status. Valid length between 3 and 256 characters. category: type: string description: The Category of the Status. enum: - Open - InProgress - Waiting - Closed - Unknown destinationStatusIds: type: array description: A list of destination Statuses where a Workitem with this Status can transition to. If the list is empty Workitems with this Status can transition to all other Statuses defined on the Worktype. A Status can have a maximum of 24 destinations. items: type: string description: type: string description: The description of the Status. Maximum length of 512 characters. defaultDestinationStatusId: type: string description: Default destination status to which this Status will transition to if auto status transition enabled. statusTransitionDelaySeconds: type: integer format: int32 description: Delay in seconds for auto status transition. Required if defaultDestinationStatusId is provided. statusTransitionTime: type: string format: local-time description: 'Time is represented as an ISO-8601 string without a timezone. For example: HH:mm:ss.SSS' autoTerminateWorkitem: type: boolean description: Terminate workitem on selection of status. Applicable only for statuses in the Closed category. WorkitemQueryJobQueryFiltersPredicate: type: object required: - name - operator properties: name: type: string description: Property name. operator: type: string description: Query filter predicate operator. enum: - EQ - NEQ - GT - LT - GTE - LTE - IN - CONTAINS - BETWEEN - BEGINS_WITH - EXISTS values: type: array description: List of values to be used in the query filter predicate. items: type: object WorkitemDateBasedConditionUpdate: type: object properties: attribute: type: string description: The name of the workitem date attribute. enum: - dateDue - dateExpires - ttl - dateCreated relativeMinutesToInvocation: type: integer format: int32 description: The time in minutes before or after the date attribute. WorkitemOnAttributeChangeRuleListing: type: object properties: entities: type: array items: $ref: '#/definitions/WorkitemOnAttributeChangeRule' nextUri: type: string selfUri: type: string previousUri: type: string after: type: string DomainEntityRef: type: object properties: id: type: string name: type: string selfUri: type: string format: uri WorkitemStatusListing: type: object properties: total: type: integer format: int64 entities: type: array items: $ref: '#/definitions/WorkitemStatus' selfUri: type: string format: uri TaskManagementErrorDetails: type: object properties: code: type: string description: System defined error code for the error. message: type: string description: Error message. WorkitemStatusUpdate: type: object properties: name: type: string description: The name of the Status. Valid length between 3 and 256 characters. destinationStatusIds: type: array description: A list of destination Statuses where a Workitem with this Status can transition to. If the list is empty Workitems with this Status can transition to all other Statuses defined on the Worktype. A Status can have a maximum of 24 destinations. items: type: string description: type: string description: The description of the Status. Maximum length of 512 characters. defaultDestinationStatusId: type: string description: Default destination status to which this Status will transition to if auto status transition enabled. statusTransitionDelaySeconds: type: integer format: int32 description: Delay in seconds for auto status transition. Required if defaultDestinationStatusId is provided. statusTransitionTime: type: string format: local-time description: 'Time is represented as an ISO-8601 string without a timezone. For example: HH:mm:ss.SSS' autoTerminateWorkitem: type: boolean description: Terminate workitem on selection of status. Applicable only for statuses in the Closed category. WrapupIdReference: type: object properties: id: type: string description: The globally unique identifier for the object. name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true WorkitemScriptReference: type: object properties: id: type: string description: The globally unique identifier for the object. name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true BulkJobAddWorkitemSummary: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string workbin: description: The workbin of the workitem. $ref: '#/definitions/WorkbinReference' type: description: The worktype of the workitem. $ref: '#/definitions/WorktypeReference' selfUri: type: string format: uri description: The URI for this object readOnly: true WorkbinVersionListing: type: object properties: entities: type: array items: $ref: '#/definitions/WorkbinVersion' nextUri: type: string selfUri: type: string previousUri: type: string after: type: string WorkitemVersion: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the Workitem. division: description: The division to which this entity belongs. $ref: '#/definitions/Division' type: description: The Worktype of the Workitem. $ref: '#/definitions/WorktypeReference' description: type: string description: The description of the Workitem. language: description: The language of the Workitem. $ref: '#/definitions/LanguageReference' utilizationLabel: description: The utilization label of the Workitem. $ref: '#/definitions/WorkitemUtilizationLabelReference' priority: type: integer format: int32 description: The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000. dateCreated: type: string format: date-time description: 'The creation date of the Workitem. 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 modified date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateDue: type: string format: date-time description: 'The due date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateExpires: type: string format: date-time description: 'The expiry date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' durationSeconds: type: integer format: int32 description: The estimated duration in seconds to complete the workitem. ttl: type: integer format: int32 description: The time to live of the Workitem in seconds. status: description: The current Status of the Workitem. $ref: '#/definitions/WorkitemStatusReference' statusCategory: type: string description: The Category of the current Status of the Workitem. enum: - Open - InProgress - Waiting - Closed - Unknown dateStatusChanged: type: string format: date-time description: 'The State change date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateClosed: type: string format: date-time description: 'The date the Workitem was closed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' workbin: description: The Workbin that contains the Workitem. $ref: '#/definitions/WorkbinReference' reporter: description: The reporter of the Workitem. $ref: '#/definitions/UserReferenceWithName' assignee: description: The assignee of the Workitem. $ref: '#/definitions/UserReferenceWithName' externalContact: description: The external contact of the Workitem. $ref: '#/definitions/ExternalContactReference' externalTag: type: string description: The external tag of the Workitem. modifiedBy: description: The User who modified the Workitem. $ref: '#/definitions/UserReference' queue: description: The Workitems queue. $ref: '#/definitions/WorkitemQueueReference' assignmentState: type: string description: The assignment state of the workitem. enum: - Unknown - AcdStarted - Alerting - AlertTimeout - AcdCancelled - Terminated - Idle - Declined - Connected - Disconnected - Parked - Held - AcdExpired dateAssignmentStateChanged: type: string format: date-time description: 'The assignment state change date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' alertTimeoutSeconds: type: integer format: int32 description: The duration in seconds before an alert will timeout. skills: type: array description: The skills of the Workitem. items: $ref: '#/definitions/RoutingSkillReference' preferredAgents: type: array description: The preferred agents of the Workitem. items: $ref: '#/definitions/UserReference' autoStatusTransition: type: boolean description: Set it to false to disable auto status transition. By default, it is enabled. schema: description: The schema defining the custom fields of the Workitem. The schema is inherited from the Workitems Worktype at creation time. $ref: '#/definitions/WorkitemSchema' customFields: type: object description: Custom fields defined in the schema referenced by the Workitem. additionalProperties: type: object autoStatusTransitionDetail: description: Auto status transition details of Workitem. $ref: '#/definitions/AutoStatusTransitionDetail' scoredAgents: type: array description: A list of scored agents for the Workitem. items: $ref: '#/definitions/WorkitemScoredAgent' script: description: The script that will be executed for the Workitem. $ref: '#/definitions/WorkitemScriptReference' version: type: integer format: int32 description: Version selfUri: type: string format: uri description: The URI for this object readOnly: true WorktypeQueryEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/Worktype' nextUri: type: string selfUri: type: string previousUri: type: string after: type: string count: type: integer format: int32 description: Count of items returned by the query. Refer to the "select" request parameter for more information. WorkitemQueryJobError: type: object properties: code: type: string description: System defined error code for the error. message: type: string description: Error message for the failed job. WorkitemRuleAction: type: object properties: type: type: string enum: - LaunchFlow WorkitemOnCreateRuleCreate: type: object required: - name properties: name: type: string description: The name of the rule. minLength: 3 maxLength: 256 BulkJobAddResult: type: object properties: error: description: Error details if the operation failed. $ref: '#/definitions/BulkJobError' entity: description: The result of the operation if it succeeded. For Workitem Bulk Add this is a summary. $ref: '#/definitions/BulkJobAddWorkitemSummary' WorkbinDelta: type: object properties: name: $ref: '#/definitions/WorkitemsAttributeChangeString' description: $ref: '#/definitions/WorkitemsAttributeChangeString' dateModified: $ref: '#/definitions/WorkitemsAttributeChangeInstant' modifiedBy: $ref: '#/definitions/WorkitemsAttributeChangeString' WorkitemsAttributeChangeWrapupDelta: type: object properties: newValue: description: New property value $ref: '#/definitions/WrapupDelta' oldValue: description: Old property value $ref: '#/definitions/WrapupDelta' Detail: type: object properties: errorCode: type: string fieldName: type: string entityId: type: string entityName: type: string BulkJobAddResponse: type: object properties: results: type: array description: A list of the results from the bulk operation. items: $ref: '#/definitions/BulkJobAddResult' 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 DataSchema: type: object required: - jsonSchema - version properties: id: type: string description: The globally unique identifier for the schema. Only required if a schema is used for custom fields during external entity creation or updates. name: type: string version: type: integer format: int32 description: The schema's version, a positive integer. Required for updates. appliesTo: type: array description: Indicates the built-in entity type to which this schema applies. readOnly: true items: type: string enum: - CONTACT - CONVERSATION - EXTERNAL_ORGANIZATION - OPEN_ACTION - WORKITEM - DECISION_TABLE - USER_CUSTOM_ATTRIBUTES - EXTERNAL_EVENTS enabled: type: boolean description: The schema's enabled/disabled status. A disabled schema cannot be assigned to any other entities, but the data on those entities from the schema still exists. createdBy: description: The URI of the user that created this schema. readOnly: true $ref: '#/definitions/DomainEntityRef' dateCreated: type: string format: date-time description: 'The date and time this schema version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true jsonSchema: example: "{\n \"appliesTo\": [\n \"CONTACT\"\n ],\n \"jsonSchema\": {\n \"title\": \"Example schema\",\n \"description\": \"Uses all of the core types for illustrative purposes\",\n \"properties\": {\n \"field1_text\": {\n \"title\": \"Field 1\",\n \"description\": \"field1\",\n \"allOf\": [ { \"$ref\": \"#/definitions/text\" } ],\n \"minLength\": 0,\n \"maxLength\": 39\n },\n \"field2_longtext\": {\n \"title\": \"Field 2\",\n \"description\": \"field2\",\n \"allOf\": [ { \"$ref\": \"#/definitions/longtext\" } ],\n \"minLength\": 0,\n \"maxLength\": 1000\n },\n \"field3_enum\": {\n \"title\": \"Field 3\",\n \"description\": \"Field 3\",\n \"allOf\": [ { \"$ref\": \"#/definitions/enum\" } ],\n \"enum\": [\n \"enum1\",\n \"enum2\"\n ]\n },\n \"field4_identifier\": {\n \"title\": \"field4\",\n \"description\": \"Field 4\",\n \"allOf\": [ { \"$ref\": \"#/definitions/identifier\" } ],\n \"minLength\": 0,\n \"maxLength\": 37\n },\n \"field5_integer\": {\n \"title\": \"field5\",\n \"description\": \"Field 5\",\n \"allOf\": [ { \"$ref\": \"#/definitions/integer\" } ],\n \"minimum\": 1,\n \"maximum\": 24\n },\n \"field6_number\": {\n \"title\": \"field6\",\n \"description\": \"Field 6\",\n \"allOf\": [ { \"$ref\": \"#/definitions/number\" } ],\n \"minimum\": 2.7,\n \"maximum\": 31.3\n },\n \"field7_date\": {\n \"title\": \"field7\",\n \"description\": \"Field 7\",\n \"allOf\": [ { \"$ref\": \"#/definitions/date\"}]\n },\n \"field8_datetime\": {\n \"title\": \"field8\",\n \"description\": \"Field 8\",\n \"allOf\": [ { \"$ref\": \"#/definitions/datetime\"}]\n },\n \"field9_checkbox\": {\n \"title\": \"field9\",\n \"description\": \"Field 9\",\n \"allOf\": [ { \"$ref\": \"#/definitions/checkbox\"}]\n },\n \"field10_tag\": {\n \"title\": \"field10\",\n \"description\": \"Field 10\",\n \"allOf\": [ { \"$ref\": \"#/definitions/tag\" } ],\n \"items\": {\n \"minLength\": 1,\n \"maxLength\": 20\n },\n \"minItems\": 0,\n \"maxItems\": 10,\n \"uniqueItems\": true\n }\n },\n \"$schema\": \"http://json-schema.org/draft-04/schema#\"\n }\n}" description: A JSON schema defining the extension to the built-in entity type. $ref: '#/definitions/JsonSchemaDocument' selfUri: type: string format: uri description: The URI for this object readOnly: true LanguageReference: 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 WorkitemStatusReference: type: object properties: id: type: string description: The globally unique identifier for the object. name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true WorkitemQueryJobCreate: type: object required: - filters properties: pageSize: type: integer format: int32 description: The total page size requested. Default 25 minimum: 1 maximum: 200 pageNumber: type: integer format: int32 description: The page number requested minimum: 1 filters: type: array description: List of filter objects to be used in the search. items: $ref: '#/definitions/WorkitemQueryJobFilter' queryFilters: type: array description: Query filters for nested attributes. items: $ref: '#/definitions/WorkitemQueryJobQueryFilters' maxItems: 1 minItems: 1 expands: type: array description: List of entity attributes to be expanded in the result. items: type: string enum: - type - workbin - status - assignee - reporter - queue - case - externalContact attributes: type: array description: List of entity attributes to be retrieved in the result. items: type: string sort: description: Sort $ref: '#/definitions/WorkitemQueryJobSort' dateIntervalStart: type: string format: date-time description: 'Interval start date to use to filter results based on create date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateIntervalEnd: type: string format: date-time description: 'Interval end date to use to filter results based on create date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' WorkitemDateBasedCondition: type: object required: - attribute - relativeMinutesToInvocation properties: attribute: type: string description: The name of the workitem date attribute. enum: - dateDue - dateExpires - ttl - dateCreated relativeMinutesToInvocation: type: integer format: int32 description: The time in minutes before or after the date attribute. WorkitemQueryJobQueryFilters: type: object required: - criteria - name properties: name: type: string example: customFields description: Name of the attribute to filter. enum: - customFields operator: type: string description: Query filter logical operator to join criteria. enum: - AND - OR criteria: type: array description: Query filter criteria. items: $ref: '#/definitions/WorkitemQueryJobQueryFiltersCriteria' maxItems: 5 minItems: 1 ValidationLimits: type: object properties: minLength: $ref: '#/definitions/MinLength' maxLength: $ref: '#/definitions/MaxLength' minItems: $ref: '#/definitions/MinLength' maxItems: $ref: '#/definitions/MaxLength' minimum: $ref: '#/definitions/MinLength' maximum: $ref: '#/definitions/MaxLength' WorkitemQueryJobResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true state: type: string description: The state of the query job enum: - Queued - Running - Succeeded - Failed dateStarted: type: string format: date-time description: 'The date the job was started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateFinished: type: string format: date-time description: 'The date the job finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' error: description: The error associated with the query job, if the state is Failed $ref: '#/definitions/WorkitemQueryJobError' selfUri: type: string format: uri description: The URI for this object readOnly: true WorkitemManualAssign: type: object required: - id properties: id: type: string description: The globally unique identifier for this user. WorkitemsChangeWorkitemDelta: type: object properties: version: type: integer format: int32 description: Version modifiedBy: description: modifiedBy $ref: '#/definitions/UserReference' delta: description: The changes that originated this version $ref: '#/definitions/WorkitemDelta' WorktypeDelta: type: object properties: name: $ref: '#/definitions/WorkitemsAttributeChangeString' description: $ref: '#/definitions/WorkitemsAttributeChangeString' statuses: $ref: '#/definitions/WorkitemsAttributeChangeList' defaultWorkbinId: $ref: '#/definitions/WorkitemsAttributeChangeString' defaultDurationSeconds: $ref: '#/definitions/WorkitemsAttributeChangeInteger' defaultExpirationSeconds: $ref: '#/definitions/WorkitemsAttributeChangeInteger' defaultDueDurationSeconds: $ref: '#/definitions/WorkitemsAttributeChangeInteger' defaultPriority: $ref: '#/definitions/WorkitemsAttributeChangeInteger' defaultSkillIds: $ref: '#/definitions/WorkitemsAttributeChangeList' defaultStatusId: $ref: '#/definitions/WorkitemsAttributeChangeString' defaultLanguageId: $ref: '#/definitions/WorkitemsAttributeChangeString' defaultTtlSeconds: $ref: '#/definitions/WorkitemsAttributeChangeInteger' assignmentEnabled: $ref: '#/definitions/WorkitemsAttributeChangeBoolean' defaultQueueId: $ref: '#/definitions/WorkitemsAttributeChangeString' schemaId: $ref: '#/definitions/WorkitemsAttributeChangeString' schemaVersion: $ref: '#/definitions/WorkitemsAttributeChangeString' serviceLevelTarget: $ref: '#/definitions/WorkitemsAttributeChangeInteger' dateModified: $ref: '#/definitions/WorkitemsAttributeChangeInstant' modifiedBy: $ref: '#/definitions/WorkitemsAttributeChangeString' defaultScriptId: $ref: '#/definitions/WorkitemsAttributeChangeString' flowId: $ref: '#/definitions/WorkitemsAttributeChangeString' ruleSettings: $ref: '#/definitions/WorkitemsAttributeChangeWorkitemRuleSettings' unassignedDivisionContactsEnabled: $ref: '#/definitions/WorkitemsAttributeChangeBoolean' WorkitemRuleSettings: type: object properties: flowRulesEnabled: type: boolean description: When set to true, the worktypes flow rules will be processed. Default value is false. WorkitemsAttributeChangeWorkitemStatusCategory: type: object properties: newValue: type: string description: New property value enum: - Open - InProgress - Waiting - Closed - Unknown oldValue: type: string description: Old property value enum: - Open - InProgress - Waiting - Closed - Unknown WorkitemOnAttributeChangeConditionUpdate: type: object required: - attribute - newValue properties: attribute: type: string description: The name of the workitem attribute whose change will be evaluated as part of the rule. enum: - statusId newValue: type: string description: The new value of the attribute. If the attribute is updated to this value this part of the condition will be met. oldValue: type: string description: The old value of the attribute. If the attribute was updated from this value this part of the condition will be met. WorkitemScoredAgentRequest: type: object properties: id: type: string description: An agents ID. Must be a valid UUID. score: type: integer format: int32 description: Agent's score for the workitem, from 0 - 100, higher being better WorkitemQueryPostRequest: type: object required: - filters properties: pageSize: type: integer format: int32 description: Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. select: type: string description: Specify the value 'Count' for this parameter in order to return only the record count. enum: - Count filters: type: array description: 'List of filter objects to be used in the search. Valid filter names are: ''workbinId'', ''typeId, ''assigneeId'', ''id'', ''name'', ''description'', ''languageId'', ''priority'', ''dateCreated'', ''dateModified'', ''dateDue'', ''dateExpires'', ''durationInSeconds'', ''ttl'', ''statusId'', ''statusCategory'', ''dateClosed'', ''externalContactId'', ''reporterId'', ''queueId'', ''externalTag'', ''modifiedBy'', ''assignmentState'', ''divisionId'', ''caseId'', ''externalContactId'', ''customFields.''' items: $ref: '#/definitions/WorkitemFilter' maxItems: 3 minItems: 1 attributes: type: array description: List of entity attributes to be retrieved in the result. items: type: string after: type: string description: The cursor that points to the end of the set of entities that has been returned. sort: description: Sort $ref: '#/definitions/WorkitemQuerySort' expands: type: array description: List of entity attributes to be expanded in the result. items: type: string enum: - type - workbin - status - assignee - reporter - queue - case - externalContact WorkitemsAttributeChangeList: type: object properties: newValue: type: array description: New property value items: type: object oldValue: type: array description: Old property value items: type: object WorkitemQuerySort: type: object properties: name: type: string description: 'Specify an attribute for sorting. It''s possible to use an attribute both for sorting and in the query at the same time, but these restrictions apply: Only the operators EQ, LT, LTE, GT, GTE, BETWEEN and BEGINS_WITH are supported and the attribute can''t be present in more than one filter.' enum: - dateDue - priority ascending: type: boolean description: Sort Ascending BulkJob: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true state: type: string description: The bulk job state. enum: - Idle - Queued - Running - Succeeded - Failed - Cancelled - Terminated action: type: string description: The bulk job action. This determines what the bulk job does, for example, terminate workitems. enum: - TerminateWorkitems - AddWorkitems totalCount: type: integer format: int32 description: Total count of items to be processed in the bulk job. successfulCount: type: integer format: int32 description: Count of successfully processed items in the bulk job. failedCount: type: integer format: int32 description: Count of failed processed items in the bulk job. dateStarted: type: string format: date-time description: 'The bulk job start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateFinished: type: string format: date-time description: 'The bulk job finished date. 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 bulk job modification date. 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 WorktypeChangeListing: type: object properties: entities: type: array items: $ref: '#/definitions/WorkitemsChangeWorktypeDelta' nextUri: type: string selfUri: type: string previousUri: type: string after: type: string 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 WorkitemOnCreateRule: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string type: type: string description: The type of the rule. enum: - OnCreate - OnAttributeChange - Date action: description: The rules action. If the condition criteria is met this action will be executed. $ref: '#/definitions/WorkitemRuleAction' worktype: description: The Worktype containing the rule. $ref: '#/definitions/WorktypeReference' selfUri: type: string format: uri description: The URI for this object readOnly: true WorkbinChangeListing: type: object properties: entities: type: array items: $ref: '#/definitions/WorkitemsChangeWorkbinDelta' nextUri: type: string selfUri: type: string previousUri: type: string after: type: string AutoStatusTransitionDetail: type: object properties: nextStatus: description: Next status of auto status transition. $ref: '#/definitions/WorkitemStatusReference' dateOfTransition: type: string format: date-time description: 'Date at which auto status transition occurs. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' errorDetails: description: This property will be set if auto status transition is failed. $ref: '#/definitions/TaskManagementErrorDetails' BulkJobError: 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. Items: type: object properties: type: type: string pattern: type: string WorkitemOnCreateRuleListing: type: object properties: entities: type: array items: $ref: '#/definitions/WorkitemOnCreateRule' nextUri: type: string selfUri: type: string previousUri: type: string after: type: string WorkitemCreate: type: object required: - name - typeId properties: name: type: string description: The name of the Workitem. Valid length between 3 and 256 characters. priority: type: integer format: int32 description: The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000. dateDue: type: string format: date-time description: 'The due date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateExpires: type: string format: date-time description: 'The expiry date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' durationSeconds: type: integer format: int32 description: The estimated duration in seconds to complete the Workitem. Maximum of 365 days. ttl: type: integer format: int32 description: The epoch timestamp in seconds specifying the time to live for the Workitem. Can not be greater than 365 days from the current time. statusId: type: string description: The ID of the Status of the Workitem. workbinId: type: string description: The ID of Workbin that contains the Workitem. autoStatusTransition: type: boolean description: Set it to false to disable auto status transition. By default, it is enabled. description: type: string description: The description of the Workitem. Maximum length of 512 characters. typeId: type: string description: The ID of the Worktype of the Workitem. customFields: type: object description: Custom fields defined in the schema referenced by the worktype of the workitem. additionalProperties: type: object queueId: type: string description: The ID of the Workitems queue. Must be a valid UUID. pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' assigneeId: type: string description: The ID of the assignee of the Workitem. Must be a valid UUID. pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' languageId: type: string description: The ID of language of the Workitem. Must be a valid UUID. externalContactId: type: string description: The ID of the external contact of the Workitem. Must be a valid UUID. externalTag: type: string description: The external tag of the Workitem. skillIds: type: array description: The skill IDs of the Workitem. Must be valid UUIDs. items: type: string scriptId: type: string description: The ID of the Workitems script. Must be a valid UUID. wrapupCode: type: string description: The ID of the wrapup. Must be a valid UUID. utilizationLabelId: type: string description: The ID of utilization label of the Workitem. Must be a valid UUID. scoredAgents: type: array description: A list of scored agents for the Workitem. A workitem can have a maximum of 20 scored agents. items: $ref: '#/definitions/WorkitemScoredAgentRequest' preferredAgentIds: type: array description: The preferred agent IDs of the Workitem. Must be valid UUIDs. items: type: string SchemaQuantityLimits: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string minFieldNameCharacters: type: integer format: int32 example: '"minFieldNameCharacters":1' description: The minimum number of schema field name characters allowed. readOnly: true maxFieldNameCharacters: type: integer format: int32 example: '"maxFieldNameCharacters":100' description: The maximum number of schema field name characters allowed. readOnly: true minFieldTitleCharacters: type: integer format: int32 example: '"minFieldTitleCharacters":1' description: The minimum number of schema field title characters allowed. readOnly: true maxFieldTitleCharacters: type: integer format: int32 example: '"maxFieldTitleCharacters":100' description: The maximum number of schema field title characters allowed. readOnly: true minFieldDescriptionCharacters: type: integer format: int32 example: '"minFieldDescriptionCharacters":0' description: The minimum number of schema field description characters allowed. readOnly: true maxFieldDescriptionCharacters: type: integer format: int32 example: '"maxFieldDescriptionCharacters":200' description: The maximum number of schema field description characters allowed. readOnly: true minSchemaNameCharacters: type: integer format: int32 example: '"minSchemaNameCharacters":1' description: The minimum number of schema name characters allowed. readOnly: true maxSchemaNameCharacters: type: integer format: int32 example: '"maxSchemaNameCharacters":50' description: The maximum number of schema name characters allowed. readOnly: true minSchemaDescriptionCharacters: type: integer format: int32 example: '"minSchemaDescriptionCharacters":0' description: The minimum number of schema description characters allowed. readOnly: true maxSchemaDescriptionCharacters: type: integer format: int32 example: '"maxSchemaDescriptionCharacters":200' description: The maximum number of schema description characters allowed. readOnly: true maxNumberOfSchemasPerOrg: type: integer format: int32 example: '"maxNumberOfSchemasPerOrg":20' description: The maximum number of schema allowed per org. readOnly: true maxNumberOfFieldsPerSchema: type: integer format: int32 example: '"maxNumberOfFieldsPerSchema":25' description: The maximum number of schema fields allowed per schema. readOnly: true maxNumberOfFieldsPerOrg: type: integer format: int32 example: '"maxNumberOfFieldsPerOrg":500' description: The maximum number of schema fields allowed per organization across all of their schemas. readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true Coretype: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string version: type: integer format: int32 description: A positive integer denoting the core type's version dateCreated: type: string format: date-time description: 'The date the core type was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' schema: description: The core type's built-in schema $ref: '#/definitions/Schema' current: type: boolean description: A boolean indicating if the core type's version is the current one in use by the system validationFields: type: array description: An array of strings naming the fields of the core type subject to validation. Validation constraints are specified by a schema author using the core type. items: type: string validationLimits: example: '"validationLimits": { "minLength": {"min": 0, "max": 100}, "maxLength": {"min": 1, "max": 100} }' description: A structure denoting the system-imposed minimum and maximum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field. $ref: '#/definitions/ValidationLimits' itemValidationFields: type: array description: Specific to the "tag" core type, this is an array of strings naming the tag item fields of the core type subject to validation items: type: string itemValidationLimits: example: "\"validationLimits\": {\n \"minLength\": {\"min\": 1, \"max\": 100},\n \"maxLength\": {\"min\": 1, \"max\": 100}\n}" description: A structure denoting the system-imposed minimum and maximum string length for string-array based core types such as "tag" and "enum". Forexample, the validationLimits for a schema field using a tag core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schema author on individual tags. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field's tags. $ref: '#/definitions/ItemValidationLimits' selfUri: type: string format: uri description: The URI for this object readOnly: true WorkitemsAttributeChangeString: type: object properties: newValue: type: string description: New property value oldValue: type: string description: Old property value WorkitemWrapupUpdate: type: object required: - action - wrapupCode properties: action: type: string description: Action to be performed for the wrapup code. enum: - Add - Remove wrapupCode: type: string description: The wrapup code which will be added/removed. WorkitemOnCreateRuleUpdate: type: object properties: name: type: string description: The name of the rule. minLength: 3 maxLength: 256 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 UserReferenceWithName: type: object properties: id: type: string description: The globally unique identifier for the object. name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true BulkJobAddRequest: type: object required: - entities properties: entities: type: array description: The list of workitem entities to create. items: $ref: '#/definitions/WorkitemCommonCreate' maxItems: 50 minItems: 1 WorkitemsAttributeChangeBoolean: type: object properties: newValue: type: boolean description: New property value oldValue: type: boolean description: Old property value 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' Division: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true WorkitemChangeListing: type: object properties: entities: type: array items: $ref: '#/definitions/WorkitemsChangeWorkitemDelta' nextUri: type: string selfUri: type: string previousUri: type: string after: type: string WorktypeVersion: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the Worktype. division: description: The division to which this entity belongs. $ref: '#/definitions/Division' description: type: string description: The description of the Worktype. dateCreated: type: string format: date-time description: 'The creation date of the Worktype. 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 modified date of the Worktype. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' defaultWorkbin: description: The default Workbin for Workitems created from the Worktype. $ref: '#/definitions/WorkbinReference' defaultStatus: description: The default status for Workitems created from the Worktype. $ref: '#/definitions/WorkitemStatusReference' statuses: type: array description: The list of possible statuses for Workitems created from the Worktype. items: $ref: '#/definitions/WorkitemStatus' defaultDurationSeconds: type: integer format: int32 description: The default duration in seconds for Workitems created from the Worktype. defaultExpirationSeconds: type: integer format: int32 description: The default expiration time in seconds for Workitems created from the Worktype. defaultDueDurationSeconds: type: integer format: int32 description: The default due duration in seconds for Workitems created from the Worktype. defaultPriority: type: integer format: int32 description: The default priority for Workitems created from the Worktype. The valid range is between -25,000,000 and 25,000,000. defaultLanguage: description: The default language for Workitems created from the Worktype. $ref: '#/definitions/LanguageReference' defaultTtlSeconds: type: integer format: int32 description: The default time to time to live in seconds for Workitems created from the Worktype. modifiedBy: description: The id of the User who modified the Worktype. $ref: '#/definitions/UserReference' defaultQueue: description: The default queue for Workitems created from the Worktype. $ref: '#/definitions/WorkitemQueueReference' defaultSkills: type: array description: The default skills for Workitems created from the Worktype. items: $ref: '#/definitions/RoutingSkillReference' assignmentEnabled: type: boolean description: When set to true, Workitems will be sent to the queue of the Worktype as they are created. Default value is false. schema: description: The schema defining the custom attributes for Workitems created from the Worktype. $ref: '#/definitions/WorkitemSchema' serviceLevelTarget: type: integer format: int32 description: The target service level for Workitems created from the Worktype. The default value is 100. ruleSettings: description: Settings for the worktypes rules. $ref: '#/definitions/WorkitemRuleSettings' flow: description: The flow associated with the Worktype. $ref: '#/definitions/WorkitemFlowReference' defaultScript: description: The default script for Workitems created from the Worktype. $ref: '#/definitions/WorkitemScriptReference' unassignedDivisionContactsEnabled: type: boolean description: When set to true, will allow Workitems to be associated with External Contacts that are not assigned to any division. Default value is true. version: type: integer format: int32 description: Version selfUri: type: string format: uri description: The URI for this object readOnly: true BulkJobUpdate: type: object required: - state properties: state: type: string description: The destination state of the bulk job. enum: - Queued - Terminated WorkitemTerminate: type: object properties: statusId: type: string description: The ID of the status the workitem should be updated to when terminating. The status must be a 'Closed' category status. WorkitemDateBasedRuleListing: type: object properties: entities: type: array items: $ref: '#/definitions/WorkitemDateBasedRule' nextUri: type: string selfUri: type: string previousUri: type: string after: type: string BulkJobsListing: type: object properties: entities: type: array items: $ref: '#/definitions/BulkJob' nextUri: type: string selfUri: type: string previousUri: type: string after: type: string WorkitemOnAttributeChangeCondition: type: object required: - attribute - newValue properties: attribute: type: string description: The name of the workitem attribute whose change will be evaluated as part of the rule. enum: - statusId newValue: type: string description: The new value of the attribute. If the attribute is updated to this value this part of the condition will be met. oldValue: type: string description: The old value of the attribute. If the attribute was updated from this value this part of the condition will be met. WorkbinVersion: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: Workbin name division: description: The division to which this entity belongs. $ref: '#/definitions/Division' description: type: string description: Workbin description dateCreated: type: string format: date-time description: 'The creation date of the Workbin. 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 modified date of the Workbin. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' modifiedBy: description: The id of the User who modified the Workbin. $ref: '#/definitions/UserReference' version: type: integer format: int32 description: Version selfUri: type: string format: uri description: The URI for this object readOnly: true ExternalContactReference: type: object properties: id: type: string description: The globally unique identifier for the object. firstName: type: string description: The first name of the contact. lastName: type: string description: The last name of the contact. selfUri: type: string format: uri description: The URI for this object readOnly: true WorkitemsAttributeChangeInteger: type: object properties: newValue: type: integer format: int32 description: New property value oldValue: type: integer format: int32 description: Old property value BulkJobEntity: type: object properties: id: type: string description: The id of the bulk job entity. WorkitemsAttributeChangeWorkitemRuleSettings: type: object properties: newValue: description: New property value $ref: '#/definitions/WorkitemRuleSettings' oldValue: description: Old property value $ref: '#/definitions/WorkitemRuleSettings' WorkitemOnAttributeChangeRuleUpdate: type: object properties: name: type: string description: The name of the rule. minLength: 3 maxLength: 256 condition: description: The rules condition. If the condition criteria is met the rules action will be executed. $ref: '#/definitions/WorkitemOnAttributeChangeConditionUpdate' Schema: type: object properties: title: type: string description: A core type's title readOnly: true description: type: string description: A core type's description readOnly: true type: type: array example: '["string"] for a text-based core type, ["integer"] for a numeric core type, or ["boolean", "null"] for the checkbox core type' description: An array of fundamental JSON Schema primitive types on which the core type is based readOnly: true items: type: string items: example: '{ type": "string", "pattern": "^[\\S]+$" }' description: Denotes the type and pattern of the items in an enum core type readOnly: true $ref: '#/definitions/Items' pattern: type: string description: For the "date" and "datetime" core types, denotes the regex prescribing the allowable date/datetime format readOnly: true WorkbinUpdate: type: object properties: name: type: string description: Workbin name. Valid length between 3 and 256 characters. description: type: string description: Workbin description. Maximum length of 512 characters. WorktypeQueryRequest: type: object required: - filters properties: pageSize: type: integer format: int32 description: Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. select: type: string description: Specify the value 'Count' for this parameter in order to return only the record count. enum: - Count filters: type: array description: 'List of filter objects to be used in the search. Valid filter names are: ''divisionId'', ''id'', ''name'', ''description'', ''defaultWorkbinId'', ''defaultDurationSeconds'', ''defaultExpirationSeconds'', ''defaultDueDurationSeconds'', ''defaultPriority'', ''defaultLanguageId'', ''defaultTtlSeconds'', ''assignmentEnabled'', ''defaultQueueId'', ''schemaId'', ''schemaVersion'', ''dateCreated'', ''dateModified'', ''modifiedBy''' items: $ref: '#/definitions/WorkitemFilter' attributes: type: array description: List of entity attributes to be retrieved in the result. items: type: string after: type: string description: The cursor that points to the end of the set of entities that has been returned. expands: type: string description: List of entity attributes to be expanded in the result. enum: - schema sort: description: Sort $ref: '#/definitions/WorktypeQuerySort' WorkitemsChangeWorktypeDelta: type: object properties: version: type: integer format: int32 description: Version modifiedBy: description: modifiedBy $ref: '#/definitions/UserReference' delta: description: The changes that originated this version $ref: '#/definitions/WorktypeDelta' WorkitemDateBasedRuleUpdate: type: object properties: name: type: string description: The name of the rule. minLength: 3 maxLength: 256 condition: description: The rules condition. If the condition criteria is met the rules action will be executed. $ref: '#/definitions/WorkitemDateBasedConditionUpdate' WorkitemScoredAgent: type: object properties: agent: description: The agent $ref: '#/definitions/UserReference' score: type: integer format: int32 description: Agent's score for the workitem, from 0 - 100, higher being better WorkitemOnAttributeChangeRule: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string type: type: string description: The type of the rule. enum: - OnCreate - OnAttributeChange - Date action: description: The rules action. If the condition criteria is met this action will be executed. $ref: '#/definitions/WorkitemRuleAction' worktype: description: The Worktype containing the rule. $ref: '#/definitions/WorktypeReference' condition: description: The rules condition. If the condition criteria is met the rules action will be executed. $ref: '#/definitions/WorkitemOnAttributeChangeCondition' selfUri: type: string format: uri description: The URI for this object readOnly: true WorkitemUtilizationLabelReference: 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 WorktypeUpdate: type: object properties: name: type: string description: The name of the Worktype. Valid length between 3 and 256 characters. minLength: 3 maxLength: 256 defaultWorkbinId: type: string description: The ID of the default Workbin for Workitems created from the Worktype. pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' defaultDurationSeconds: type: integer format: int32 description: The default duration in seconds for Workitems created from the Worktype. Maximum of 365 days. minimum: 0 maximum: 31536000 defaultExpirationSeconds: type: integer format: int32 description: The default expiration time in seconds for Workitems created from the Worktype. Maximum of 365 days. minimum: 0 maximum: 31536000 defaultDueDurationSeconds: type: integer format: int32 description: The default due duration in seconds for Workitems created from the Worktype. Maximum of 365 days. minimum: 0 maximum: 31536000 defaultPriority: type: integer format: int32 description: The default priority for Workitems created from the Worktype. The valid range is between -25,000,000 and 25,000,000. minimum: -25000000 maximum: 25000000 defaultTtlSeconds: type: integer format: int32 description: The default time to time to live in seconds for Workitems created from the Worktype. The valid range is between 1 and 365 days. minimum: 86400 maximum: 31536000 assignmentEnabled: type: boolean description: When set to true, Workitems will be sent to the queue of the Worktype as they are created. Default value is false. schemaId: type: string description: The ID of the custom attribute schema for Workitems created from the Worktype. Must be a valid UUID. pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' serviceLevelTarget: type: integer format: int32 description: The target service level for Workitems created from the Worktype. The default value is 100. minimum: 1 maximum: 100 ruleSettings: description: Settings for the worktypes rules. $ref: '#/definitions/WorkitemRuleSettings' unassignedDivisionContactsEnabled: type: boolean description: When set to true, will allow Workitems to be associated with External Contacts that are not assigned to any division. Default value is true. description: type: string description: The description of the Worktype. Maximum length of 512 characters. defaultStatusId: type: string description: The ID of the default status for Workitems created from the Worktype. Must be a valid UUID. pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' schemaVersion: type: integer format: int32 description: The version of the Worktypes custom attribute schema. The latest schema version will be used if this property is not set. defaultLanguageId: type: string description: The ID of the default language for Workitems created from the Worktype. Must be a valid UUID. defaultSkillIds: type: array description: The IDs of the default skills for Workitems created from the Worktype. Must be valid UUIDs. Maximum of 20 IDs items: type: string defaultQueueId: type: string description: The ID of the default queue for Workitems created from the Worktype. Must be a valid UUID. defaultScriptId: type: string description: The default script for Workitems created from the Worktype. Must be a valid UUID. 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/