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 Workforce 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: Workforce Management description: Adherence, Schedules, Forecasts, Intraday Monitoring, Time Off Requests, Configuration externalDocs: description: Workforce Management Documentation url: https://developer.genesys.cloud/useragentman/workforcemanagement/ paths: /api/v2/workforcemanagement/calendar/data/ics: get: tags: - Workforce Management summary: Get ics formatted calendar based on shareable link description: '' operationId: getWorkforcemanagementCalendarDataIcs produces: - text/calendar parameters: - name: calendarId in: query description: The id of the ics-formatted calendar required: true type: string responses: '200': description: successful operation schema: type: string '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: Query parameter did not pass validation 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: Forbidden from getting calendar 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. wfm.external.calendar.entity.not.found: The requested calendar entity was not found '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. x-purecloud-method-name: getWorkforcemanagementCalendarDataIcs /api/v2/workforcemanagement/managementunits/{managementUnitId}/activitycodes: get: tags: - Workforce Management summary: 'Deprecated: Instead use /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes. Get the list of activity codes' description: '' operationId: getWorkforcemanagementManagementunitActivitycodes produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ActivityCodeContainer' '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly deprecated: true x-inin-requires-permissions: type: ANY permissions: - wfm:activityCode:add - wfm:activityCode:delete - wfm:activityCode:edit - wfm:activityCode:view - wfm:agent:edit - wfm:agentSchedule:view - wfm:agentTimeOffRequest:submit - wfm:agent:view - wfm:businessUnit:add - wfm:businessUnit:delete - wfm:businessUnit:edit - wfm:businessUnit:view - wfm:historicalAdherence:view - wfm:shrinkage:view - wfm:intraday:view - wfm:managementUnit:add - wfm:managementUnit:delete - wfm:managementUnit:edit - wfm:managementUnit:view - wfm:publishedSchedule:view - wfm:realtimeAdherence:view - wfm:schedule:add - wfm:schedule:delete - wfm:schedule:edit - wfm:schedule:generate - wfm:schedule:view - wfm:shortTermForecast:add - wfm:shortTermForecast:delete - wfm:shortTermForecast:edit - wfm:shortTermForecast:view - wfm:timeOffRequest:add - wfm:timeOffRequest:edit - wfm:timeOffRequest:view - wfm:workPlan:add - wfm:workPlan:delete - wfm:workPlan:edit - wfm:workPlan:view - wfm:workPlanRotation:add - wfm:workPlanRotation:delete - wfm:workPlanRotation:edit - wfm:workPlanRotation:view - wfm:agentSchedulingPreferencesQuery:view - wfm:agentSchedulingPreferences:edit - wfm:agentSchedulingPreferencesSettings:view - wfm:schedulingPreferencesQuery:view - wfm:schedulingPreferencesSettings:view - wfm:schedulingPreferencesSettings:edit x-purecloud-method-name: getWorkforcemanagementManagementunitActivitycodes /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes: get: tags: - Workforce Management summary: Get activity codes description: '' operationId: getWorkforcemanagementBusinessunitActivitycodes produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit, or 'mine' for the business unit of the logged-in user. required: true type: string - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/BusinessUnitActivityCodeListing' '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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentSchedule:view - wfm:agentTimeOffRequest:submit - wfm:activityCode:add - wfm:activityCode:delete - wfm:activityCode:edit - wfm:activityCode:view - wfm:agent:edit - wfm:agent:view - wfm:businessUnit:add - wfm:businessUnit:delete - wfm:businessUnit:edit - wfm:businessUnit:view - wfm:historicalAdherence:view - wfm:shrinkage:view - wfm:intraday:view - wfm:managementUnit:add - wfm:managementUnit:delete - wfm:managementUnit:edit - wfm:managementUnit:view - wfm:realtimeAdherence:view - wfm:schedule:add - wfm:schedule:delete - wfm:schedule:edit - wfm:schedule:generate - wfm:schedule:view - wfm:publishedSchedule:view - wfm:serviceGoalTemplate:add - wfm:serviceGoalTemplate:delete - wfm:serviceGoalTemplate:edit - wfm:serviceGoalTemplate:view - wfm:planningGroup:add - wfm:planningGroup:delete - wfm:planningGroup:edit - wfm:planningGroup:view - wfm:shiftTradeRequest:edit - wfm:shiftTradeRequest:view - wfm:shortTermForecast:add - wfm:shortTermForecast:delete - wfm:shortTermForecast:edit - wfm:shortTermForecast:view - wfm:timeOffLimit:add - wfm:timeOffLimit:delete - wfm:timeOffLimit:edit - wfm:timeOffLimit:view - wfm:timeOffPlan:add - wfm:timeOffPlan:delete - wfm:timeOffPlan:edit - wfm:timeOffPlan:view - wfm:timeOffRequest:add - wfm:timeOffRequest:edit - wfm:timeOffRequest:view - wfm:workPlan:add - wfm:workPlan:delete - wfm:workPlan:edit - wfm:workPlan:view - wfm:workPlanRotation:add - wfm:workPlanRotation:delete - wfm:workPlanRotation:edit - wfm:workPlanRotation:view - wfm:agentSchedulingPreferencesQuery:view - wfm:agentSchedulingPreferences:edit - wfm:agentSchedulingPreferencesSettings:view - wfm:schedulingPreferencesQuery:view - wfm:schedulingPreferencesSettings:view - wfm:schedulingPreferencesSettings:edit x-purecloud-method-name: getWorkforcemanagementBusinessunitActivitycodes post: tags: - Workforce Management summary: Create a new activity code description: '' operationId: postWorkforcemanagementBusinessunitActivitycodes produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit, or 'mine' for the business unit of the logged-in user. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/CreateActivityCodeRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BusinessUnitActivityCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information bad.request: The request could not be understood by the server due to malformed syntax. wfm.ids.may.not.be.blank: One or more secondary presence IDs was passed in as a blank value invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details wfm.primary.secondary.presences: The request contains one or more primary secondary presences wfm.too.many.secondary.presences: The request contains too many secondary presences response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '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: wfm.secondary.presences.inactive.or.not.found: One or more secondary presences are inactive or do not exist wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:activityCode:add x-purecloud-method-name: postWorkforcemanagementBusinessunitActivitycodes /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}: get: tags: - Workforce Management summary: Get an activity code description: '' operationId: getWorkforcemanagementBusinessunitActivitycode produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit, or 'mine' for the business unit of the logged-in user. required: true type: string - name: activityCodeId in: path description: The ID of the activity code to fetch required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/BusinessUnitActivityCode' '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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:activityCode:view x-purecloud-method-name: getWorkforcemanagementBusinessunitActivitycode delete: tags: - Workforce Management summary: Deletes an activity code description: '' operationId: deleteWorkforcemanagementBusinessunitActivitycode produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit, or 'mine' for the business unit of the logged-in user. required: true type: string - name: activityCodeId in: path description: The ID of the activity code to delete required: true type: string responses: '204': description: The activity code was 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 wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information '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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:activityCode:delete x-purecloud-method-name: deleteWorkforcemanagementBusinessunitActivitycode patch: tags: - Workforce Management summary: Update an activity code description: '' operationId: patchWorkforcemanagementBusinessunitActivitycode produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit, or 'mine' for the business unit of the logged-in user. required: true type: string - name: activityCodeId in: path description: The ID of the activity code to update required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/UpdateActivityCodeRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BusinessUnitActivityCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information bad.request: The request could not be understood by the server due to malformed syntax. wfm.ids.may.not.be.blank: One or more secondary presence IDs was passed in as a blank value wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details wfm.primary.secondary.presences: The request contains one or more primary secondary presences wfm.too.many.secondary.presences: The request contains too many secondary presences response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '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: wfm.secondary.presences.inactive.or.not.found: One or more secondary presences are inactive or do not exist wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:activityCode:edit x-purecloud-method-name: patchWorkforcemanagementBusinessunitActivitycode /api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday/planninggroups: get: tags: - Workforce Management summary: Get intraday planning groups for the given date description: '' operationId: getWorkforcemanagementBusinessunitIntradayPlanninggroups produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: date in: query description: 'yyyy-MM-dd date string interpreted in the configured business unit time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date responses: '200': description: successful operation schema: $ref: '#/definitions/WfmIntradayPlanningGroupListing' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:intraday:view x-purecloud-method-name: getWorkforcemanagementBusinessunitIntradayPlanninggroups /api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday: post: tags: - Workforce Management summary: Get intraday data for the given date for the requested planningGroupIds description: '' operationId: postWorkforcemanagementBusinessunitIntraday produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean - in: body name: body description: body required: true schema: $ref: '#/definitions/IntradayPlanningGroupRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AsyncIntradayResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:intraday:view x-purecloud-method-name: postWorkforcemanagementBusinessunitIntraday /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import/uploadurl: post: tags: - Workforce Management summary: Creates a signed upload URL for importing a short term forecast description: Once the upload is complete, call the /import route to start the short term forecast import process operationId: postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit to which the forecast belongs required: true type: string - name: weekDateId in: path description: 'First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - in: body name: body description: body required: true schema: $ref: '#/definitions/UploadUrlRequestBody' responses: '200': description: successful operation schema: $ref: '#/definitions/ImportForecastUploadResponse' '201': description: The upload url for import was successfully created schema: $ref: '#/definitions/ImportForecastUploadResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:shortTermForecast:add x-purecloud-method-name: postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import: post: tags: - Workforce Management summary: Starts importing the uploaded short term forecast description: Call after uploading the forecast data to the url supplied by the /import/uploadurl route operationId: postWorkforcemanagementBusinessunitWeekShorttermforecastsImport produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit to which the forecast belongs required: true type: string - name: weekDateId in: path description: 'First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - in: body name: body description: body required: true schema: $ref: '#/definitions/WfmProcessUploadRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ImportForecastResponse' '202': description: The forecast import is processing schema: $ref: '#/definitions/ImportForecastResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:shortTermForecast:add x-purecloud-method-name: postWorkforcemanagementBusinessunitWeekShorttermforecastsImport ? /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/generationresults : get: tags: - Workforce Management summary: Gets the forecast generation results description: '' operationId: getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit to which the forecast belongs required: true type: string - name: weekDateId in: path description: 'The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: forecastId in: path description: The ID of the forecast required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/BuForecastGenerationResult' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:shortTermForecast:view x-purecloud-method-name: getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts: get: tags: - Workforce Management summary: Get short term forecasts description: Use "recent" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for up to +/- 26 weeks from the current date. Response will include any forecast which spans the specified week operationId: getWorkforcemanagementBusinessunitWeekShorttermforecasts produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit to which the forecast belongs required: true type: string - name: weekDateId in: path description: The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/BuShortTermForecastListing' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:generate - wfm:shortTermForecast:view x-purecloud-method-name: getWorkforcemanagementBusinessunitWeekShorttermforecasts /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/generate: post: tags: - Workforce Management summary: Generate a short term forecast description: '' operationId: postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit to which the forecast belongs required: true type: string - name: weekDateId in: path description: 'The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean - in: body name: body description: body required: true schema: $ref: '#/definitions/GenerateBuForecastRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AsyncForecastOperationResult' '202': description: The request was accepted and the result will be sent asynchronously via notification schema: $ref: '#/definitions/AsyncForecastOperationResult' '201': description: The forecast was successfully generated schema: $ref: '#/definitions/AsyncForecastOperationResult' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: Business unit 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. '502': description: Bad Gateway schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.server.error: WFM Server Error security: - PureCloud OAuth: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:shortTermForecast:add x-purecloud-method-name: postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}: get: tags: - Workforce Management summary: Get a short term forecast description: '' operationId: getWorkforcemanagementBusinessunitWeekShorttermforecast produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit to which the forecast belongs required: true type: string - name: weekDateId in: path description: 'The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: forecastId in: path description: The ID of the forecast required: true type: string - name: expand in: query description: Include to access additional data on the forecast required: false type: array items: type: string enum: - planningGroups - generationResults collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/BuShortTermForecast' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:shortTermForecast:view x-purecloud-method-name: getWorkforcemanagementBusinessunitWeekShorttermforecast delete: tags: - Workforce Management summary: Delete a short term forecast description: Must not be tied to any schedules operationId: deleteWorkforcemanagementBusinessunitWeekShorttermforecast produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit to which the forecast belongs required: true type: string - name: weekDateId in: path description: 'The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: forecastId in: path description: The ID of the forecast required: true type: string responses: '204': description: The forecast was 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 wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details '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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:shortTermForecast:delete x-purecloud-method-name: deleteWorkforcemanagementBusinessunitWeekShorttermforecast ? /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/planninggroups : get: tags: - Workforce Management summary: Gets the forecast planning group snapshot description: '' operationId: getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit to which the forecast belongs required: true type: string - name: weekDateId in: path description: 'The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: forecastId in: path description: The ID of the forecast required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ForecastPlanningGroupsResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:shortTermForecast:view - wfm:schedule:view - wfm:publishedSchedule:view x-purecloud-method-name: getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/data: get: tags: - Workforce Management summary: Get the result of a short term forecast calculation description: Includes modifications unless you pass the doNotApplyModifications query parameter operationId: getWorkforcemanagementBusinessunitWeekShorttermforecastData produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit to which the forecast belongs required: true type: string - name: weekDateId in: path description: 'The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: forecastId in: path description: The ID of the forecast required: true type: string - name: weekNumber in: query description: The week number to fetch (for multi-week forecasts) required: false type: integer format: int32 - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/BuForecastResultResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:shortTermForecast:view x-purecloud-method-name: getWorkforcemanagementBusinessunitWeekShorttermforecastData ? /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement : get: tags: - Workforce Management summary: Get the staffing requirement by planning group for a forecast description: '' operationId: getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit to which the forecast belongs required: true type: string - name: weekDateId in: path description: 'The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: forecastId in: path description: The ID of the forecast required: true type: string - name: weekNumbers in: query description: The week numbers to fetch (for multi-week forecasts) staffing requirements. Returns all week data if the list is not specified required: false type: array items: type: string collectionFormat: multi - name: expand in: query description: Expand to include minimum staffing values in (staffing requirement response or applied to base staffing requirement values) required: false type: array items: type: string enum: - results.planningGroupStaffingRequirements.minimumStaffPerInterval - results.planningGroupStaffingRequirements.effectiveStaffPerInterval collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/BuForecastStaffingRequirementsResultResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:staffingRequirement:view x-purecloud-method-name: getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement ? /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/longtermforecastdata : get: tags: - Workforce Management summary: Get the result of a long term forecast calculation description: Includes modifications unless you pass the doNotApplyModifications query parameter operationId: getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit to which the forecast belongs required: true type: string - name: weekDateId in: path description: 'The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: forecastId in: path description: The ID of the forecast required: true type: string - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/LongTermForecastResultResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:shortTermForecast:view x-purecloud-method-name: getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy: post: tags: - Workforce Management summary: Copy a short term forecast description: '' operationId: postWorkforcemanagementBusinessunitWeekShorttermforecastCopy produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit to which the forecast belongs required: true type: string - name: weekDateId in: path description: 'The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: forecastId in: path description: The ID of the forecast to copy required: true type: string - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean - in: body name: body description: body required: true schema: $ref: '#/definitions/CopyBuForecastRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AsyncForecastOperationResult' '202': description: The request was accepted and the result will be sent asynchronously via notification schema: $ref: '#/definitions/AsyncForecastOperationResult' '201': description: The forecast was created schema: $ref: '#/definitions/AsyncForecastOperationResult' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:shortTermForecast:add x-purecloud-method-name: postWorkforcemanagementBusinessunitWeekShorttermforecastCopy /api/v2/workforcemanagement/businessunits/{businessUnitId}/users: get: tags: - Workforce Management summary: Get users in the business unit description: '' operationId: getWorkforcemanagementBusinessunitUsers produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: managementUnitIds in: query description: The IDs of the management units for which to retrieve users required: false type: array items: type: string collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/BuUserListing' '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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agent:view x-purecloud-method-name: getWorkforcemanagementBusinessunitUsers /api/v2/workforcemanagement/businessunits/{businessUnitId}: get: tags: - Workforce Management summary: Get business unit description: Expanding "settings" will retrieve all settings. All other expands will retrieve only the requested settings field(s). operationId: getWorkforcemanagementBusinessunit produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit, or 'mine' for the business unit of the logged-in user. required: true type: string - name: expand in: query description: Include to access additional data on the business unit required: false type: array items: type: string enum: - settings - settings.timeZone - settings.startDayOfWeek - settings.shortTermForecasting - settings.scheduling - settings.notifications.scheduling - settings.learning - settings.coaching collectionFormat: multi - name: includeSchedulingDefaultMessageSeverities in: query description: Whether to include scheduling default message severities required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/BusinessUnitResponse' '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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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: - coaching - learning - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:activityCode:add - wfm:activityCode:delete - wfm:activityCode:edit - wfm:activityCode:view - wfm:agent:edit - wfm:agentSchedule:view - wfm:agentTimeOffRequest:submit - wfm:agent:view - wfm:businessUnit:add - wfm:businessUnit:delete - wfm:businessUnit:edit - wfm:businessUnit:view - wfm:historicalAdherence:view - wfm:shrinkage:view - wfm:intraday:view - wfm:managementUnit:add - wfm:managementUnit:delete - wfm:managementUnit:edit - wfm:managementUnit:view - wfm:publishedSchedule:view - wfm:realtimeAdherence:view - wfm:schedule:add - wfm:schedule:delete - wfm:schedule:edit - wfm:schedule:generate - wfm:schedule:view - wfm:serviceGoalTemplate:add - wfm:serviceGoalTemplate:delete - wfm:serviceGoalTemplate:edit - wfm:serviceGoalTemplate:view - wfm:planningGroup:add - wfm:planningGroup:delete - wfm:planningGroup:edit - wfm:planningGroup:view - wfm:shiftTradeRequest:edit - wfm:shiftTradeRequest:view - wfm:agentShiftTradeRequest:participate - wfm:shortTermForecast:add - wfm:shortTermForecast:delete - wfm:shortTermForecast:edit - wfm:shortTermForecast:view - wfm:staffingGroup:add - wfm:staffingGroup:delete - wfm:staffingGroup:edit - wfm:staffingGroup:view - wfm:timeOffRequest:add - wfm:timeOffRequest:edit - wfm:timeOffRequest:view - wfm:timeOffLimit:add - wfm:timeOffLimit:delete - wfm:timeOffLimit:edit - wfm:timeOffLimit:view - wfm:timeOffPlan:add - wfm:timeOffPlan:delete - wfm:timeOffPlan:edit - wfm:timeOffPlan:view - wfm:timeOffRequest:add - wfm:timeOffRequest:edit - wfm:timeOffRequest:view - wfm:workPlan:add - wfm:workPlan:delete - wfm:workPlan:edit - wfm:workPlan:view - wfm:workPlanRotation:add - wfm:workPlanRotation:delete - wfm:workPlanRotation:edit - wfm:workPlanRotation:view - coaching:appointment:add - coaching:appointment:edit - learning:assignment:add - learning:assignment:reschedule - wfm:agentSchedulingPreferencesQuery:view - wfm:agentSchedulingPreferences:edit - wfm:agentSchedulingPreferencesSettings:view - wfm:schedulingPreferencesQuery:view - wfm:schedulingPreferencesSettings:view - wfm:schedulingPreferencesSettings:edit x-purecloud-method-name: getWorkforcemanagementBusinessunit delete: tags: - Workforce Management summary: Delete business unit description: A business unit cannot be deleted if it contains one or more management units operationId: deleteWorkforcemanagementBusinessunit produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit, or 'mine' for the business unit of the logged-in user. required: true type: string responses: '204': description: The business unit was 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 wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information '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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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: wfm.server.error: WFM Server Error internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:businessUnit:delete x-purecloud-method-name: deleteWorkforcemanagementBusinessunit patch: tags: - Workforce Management summary: Update business unit description: '' operationId: patchWorkforcemanagementBusinessunit produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit, or 'mine' for the business unit of the logged-in user. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/UpdateBusinessUnitRequest' - name: includeSchedulingDefaultMessageSeverities in: query description: Whether to include scheduling default message severities required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/BusinessUnitResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ALL permissions: - wfm:businessUnit:edit x-purecloud-method-name: patchWorkforcemanagementBusinessunit /api/v2/workforcemanagement/businessunits/{businessUnitId}/managementunits: get: tags: - Workforce Management summary: Get all authorized management units in the business unit description: '' operationId: getWorkforcemanagementBusinessunitManagementunits produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit, or 'mine' for the business unit of the logged-in user. required: true type: string - name: feature in: query description: If specified, the list of management units for which the user is authorized to use the requested feature will be returned required: false type: string enum: - AgentHistoricalAdherence - AgentHistoricalAdherenceConformance - AgentSchedule - AgentAdherenceAdjustments - AgentTimeOffRequest - AgentWorkPlanBid - AgentScheduleBid - AgentShiftTrade - AlternativeShift - Coaching - Learning - AgentUnavailableTimes - AgentSelfScheduleJob - AgentSelfScheduleOffers - AgentSelfScheduleQuery - AgentSelfScheduleActivityMove - SelfScheduleSettings - AgentSelfScheduleSettings - AgentOpportunitiesQuery - AgentOpportunitiesEnrollments - AgentOpportunitiesEnrollmentsStatuses - AgentSchedulingPreferencesQuery - AgentSchedulingPreferences - AgentSchedulingPreferencesSettings - ActivityCodes - ActivityPlans - AdherenceAdjustmentsSettings - AdherenceAdjustmentsReasonCodes - AdherenceAdjustments - UnavailableTimes - Agents - BuActivityCodes - BusinessUnits - CapacityPlan - CapacityPlanForecastInputs - CapacityPlanPerformancePrediction - ContinuousForecast - HistoricalAdherence - HistoricalShrinkage - IntradayMonitoring - BuIntradayMonitoring - ManagementUnits - RealTimeAdherence - Schedules - BuSchedules - ServiceGoalTemplates - PlanningGroups - LongTermStaffing - ShiftTrading - ShortTermForecasts - BuShortTermForecasts - StaffingGroups - TimeOffPlans - TimeOffRequests - TimeOffLimits - WorkPlanBids - WorkPlanBidGroups - WorkPlanRotations - WorkPlans - ScheduleBid - ScheduleBidGroup - Opportunities - OpportunitiesQuery - OpportunitiesEnrollmentsQuery - OpportunitiesExternalActivitiesQuery - OpportunitiesStatuses - OpportunitiesEnrollmentsStatuses - SchedulingPreferencesQuery - SchedulingPreferencesSettings - DecisionMetrics - name: divisionId in: query description: If specified, the list of management units belonging to the specified division will be returned required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ManagementUnitListing' '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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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: wfm.server.error: WFM Server Error internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - workforce-management - workforce-management:readonly x-purecloud-method-name: getWorkforcemanagementBusinessunitManagementunits /api/v2/workforcemanagement/businessunits: get: tags: - Workforce Management summary: Get business units description: '' operationId: getWorkforcemanagementBusinessunits produces: - application/json parameters: - name: feature in: query description: If specified, the list of business units for which the user is authorized to use the requested feature will be returned required: false type: string enum: - AgentHistoricalAdherence - AgentHistoricalAdherenceConformance - AgentSchedule - AgentAdherenceAdjustments - AgentTimeOffRequest - AgentWorkPlanBid - AgentScheduleBid - AgentShiftTrade - AlternativeShift - Coaching - Learning - AgentUnavailableTimes - AgentSelfScheduleJob - AgentSelfScheduleOffers - AgentSelfScheduleQuery - AgentSelfScheduleActivityMove - SelfScheduleSettings - AgentSelfScheduleSettings - AgentOpportunitiesQuery - AgentOpportunitiesEnrollments - AgentOpportunitiesEnrollmentsStatuses - AgentSchedulingPreferencesQuery - AgentSchedulingPreferences - AgentSchedulingPreferencesSettings - ActivityCodes - ActivityPlans - AdherenceAdjustmentsSettings - AdherenceAdjustmentsReasonCodes - AdherenceAdjustments - UnavailableTimes - Agents - BuActivityCodes - BusinessUnits - CapacityPlan - CapacityPlanForecastInputs - CapacityPlanPerformancePrediction - ContinuousForecast - HistoricalAdherence - HistoricalShrinkage - IntradayMonitoring - BuIntradayMonitoring - ManagementUnits - RealTimeAdherence - Schedules - BuSchedules - ServiceGoalTemplates - PlanningGroups - LongTermStaffing - ShiftTrading - ShortTermForecasts - BuShortTermForecasts - StaffingGroups - TimeOffPlans - TimeOffRequests - TimeOffLimits - WorkPlanBids - WorkPlanBidGroups - WorkPlanRotations - WorkPlans - ScheduleBid - ScheduleBidGroup - Opportunities - OpportunitiesQuery - OpportunitiesEnrollmentsQuery - OpportunitiesExternalActivitiesQuery - OpportunitiesStatuses - OpportunitiesEnrollmentsStatuses - SchedulingPreferencesQuery - SchedulingPreferencesSettings - DecisionMetrics - name: divisionId in: query description: If specified, the list of business units belonging to the specified division will be returned required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/BusinessUnitListing' '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: wfm.server.error: WFM Server Error internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - workforce-management - workforce-management:readonly x-purecloud-method-name: getWorkforcemanagementBusinessunits post: tags: - Workforce Management summary: Add a new business unit description: It may take a minute or two for a new business unit to be available for api operations operationId: postWorkforcemanagementBusinessunits produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/CreateBusinessUnitRequest' - name: includeSchedulingDefaultMessageSeverities in: query description: Whether to include scheduling default message severities required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/BusinessUnitResponse' '201': description: The business unit was successfully created schema: $ref: '#/definitions/BusinessUnitResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.server.error: WFM Server Error internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:businessUnit:add x-purecloud-method-name: postWorkforcemanagementBusinessunits /api/v2/workforcemanagement/businessunits/divisionviews: get: tags: - Workforce Management summary: Get business units across divisions description: '' operationId: getWorkforcemanagementBusinessunitsDivisionviews produces: - application/json parameters: - name: divisionId in: query description: The divisionIds to filter by. If omitted, will return business units in all divisions required: false type: array items: type: string collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/BusinessUnitListing' '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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:businessUnit:search x-purecloud-method-name: getWorkforcemanagementBusinessunitsDivisionviews /api/v2/workforcemanagement/managementunits/{managementUnitId}: get: tags: - Workforce Management summary: Get management unit description: settings.shortTermForecasting is deprecated and now lives on the business unit operationId: getWorkforcemanagementManagementunit produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: expand in: query required: false type: array items: type: string enum: - settings - settings.adherence - settings.timeOff - settings.scheduling - settings.shortTermForecasting - settings.shiftTrading collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/ManagementUnit' '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: wfm.server.error: WFM Server Error internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:activityCode:add - wfm:activityCode:delete - wfm:activityCode:edit - wfm:activityCode:view - wfm:agent:edit - wfm:agentSchedule:view - wfm:agentTimeOffRequest:submit - wfm:agent:view - wfm:businessUnit:add - wfm:businessUnit:delete - wfm:businessUnit:edit - wfm:businessUnit:view - wfm:historicalAdherence:view - wfm:shrinkage:view - wfm:intraday:view - wfm:managementUnit:add - wfm:managementUnit:delete - wfm:managementUnit:edit - wfm:managementUnit:view - wfm:publishedSchedule:view - wfm:realtimeAdherence:view - wfm:schedule:add - wfm:schedule:delete - wfm:schedule:edit - wfm:schedule:generate - wfm:schedule:view - wfm:serviceGoalTemplate:add - wfm:serviceGoalTemplate:delete - wfm:serviceGoalTemplate:edit - wfm:serviceGoalTemplate:view - wfm:planningGroup:add - wfm:planningGroup:delete - wfm:planningGroup:edit - wfm:planningGroup:view - wfm:shiftTradeRequest:edit - wfm:shiftTradeRequest:view - wfm:agentShiftTradeRequest:participate - wfm:shortTermForecast:add - wfm:shortTermForecast:delete - wfm:shortTermForecast:edit - wfm:shortTermForecast:view - wfm:staffingGroup:add - wfm:staffingGroup:delete - wfm:staffingGroup:edit - wfm:staffingGroup:view - wfm:timeOffLimit:add - wfm:timeOffLimit:delete - wfm:timeOffLimit:edit - wfm:timeOffLimit:view - wfm:timeOffPlan:add - wfm:timeOffPlan:delete - wfm:timeOffPlan:edit - wfm:timeOffPlan:view - wfm:timeOffRequest:add - wfm:timeOffRequest:edit - wfm:timeOffRequest:view - wfm:workPlan:add - wfm:workPlan:delete - wfm:workPlan:edit - wfm:workPlan:view - wfm:workPlanRotation:add - wfm:workPlanRotation:delete - wfm:workPlanRotation:edit - wfm:workPlanRotation:view - wfm:agentSchedulingPreferencesQuery:view - wfm:agentSchedulingPreferences:edit - wfm:agentSchedulingPreferencesSettings:view - wfm:schedulingPreferencesQuery:view - wfm:schedulingPreferencesSettings:view - wfm:schedulingPreferencesSettings:edit x-purecloud-method-name: getWorkforcemanagementManagementunit delete: tags: - Workforce Management summary: Delete management unit description: '' operationId: deleteWorkforcemanagementManagementunit produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string responses: '204': description: The management unit was 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 wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:managementUnit:delete x-purecloud-method-name: deleteWorkforcemanagementManagementunit patch: tags: - Workforce Management summary: Update the requested management unit description: '' operationId: patchWorkforcemanagementManagementunit produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/UpdateManagementUnitRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ManagementUnit' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.missing.one.of.permission.sets: Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets. 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:managementUnit:edit x-purecloud-method-name: patchWorkforcemanagementManagementunit /api/v2/workforcemanagement/managementunits/{managementUnitId}/move: post: tags: - Workforce Management summary: Move the requested management unit to a new business unit description: Returns status 200 if the management unit is already in the requested business unit operationId: postWorkforcemanagementManagementunitMove produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/MoveManagementUnitRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/MoveManagementUnitResponse' '202': description: The management unit is being moved schema: $ref: '#/definitions/MoveManagementUnitResponse' '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. wfm.validation.business.unit.not.found: Business unit not found invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.missing.one.of.permission.sets: Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets. 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ALL permissions: - wfm:managementUnit:edit x-purecloud-method-name: postWorkforcemanagementManagementunitMove /api/v2/workforcemanagement/managementunits: get: tags: - Workforce Management summary: Get management units description: '' operationId: getWorkforcemanagementManagementunits produces: - application/json parameters: - name: pageSize in: query description: Deprecated, paging is not supported required: false type: integer format: int32 - name: pageNumber in: query description: Deprecated, paging is not supported required: false type: integer format: int32 - name: expand in: query description: Deprecated, expand settings on the single MU route required: false type: string enum: - details - name: feature in: query description: If specified, the list of management units for which the user is authorized to use the requested feature will be returned required: false type: string enum: - AgentHistoricalAdherence - AgentHistoricalAdherenceConformance - AgentSchedule - AgentAdherenceAdjustments - AgentTimeOffRequest - AgentWorkPlanBid - AgentScheduleBid - AgentShiftTrade - AlternativeShift - Coaching - Learning - AgentUnavailableTimes - AgentSelfScheduleJob - AgentSelfScheduleOffers - AgentSelfScheduleQuery - AgentSelfScheduleActivityMove - SelfScheduleSettings - AgentSelfScheduleSettings - AgentOpportunitiesQuery - AgentOpportunitiesEnrollments - AgentOpportunitiesEnrollmentsStatuses - AgentSchedulingPreferencesQuery - AgentSchedulingPreferences - AgentSchedulingPreferencesSettings - ActivityCodes - ActivityPlans - AdherenceAdjustmentsSettings - AdherenceAdjustmentsReasonCodes - AdherenceAdjustments - UnavailableTimes - Agents - BuActivityCodes - BusinessUnits - CapacityPlan - CapacityPlanForecastInputs - CapacityPlanPerformancePrediction - ContinuousForecast - HistoricalAdherence - HistoricalShrinkage - IntradayMonitoring - BuIntradayMonitoring - ManagementUnits - RealTimeAdherence - Schedules - BuSchedules - ServiceGoalTemplates - PlanningGroups - LongTermStaffing - ShiftTrading - ShortTermForecasts - BuShortTermForecasts - StaffingGroups - TimeOffPlans - TimeOffRequests - TimeOffLimits - WorkPlanBids - WorkPlanBidGroups - WorkPlanRotations - WorkPlans - ScheduleBid - ScheduleBidGroup - Opportunities - OpportunitiesQuery - OpportunitiesEnrollmentsQuery - OpportunitiesExternalActivitiesQuery - OpportunitiesStatuses - OpportunitiesEnrollmentsStatuses - SchedulingPreferencesQuery - SchedulingPreferencesSettings - DecisionMetrics - name: divisionId in: query description: If specified, the list of management units belonging to the specified division will be returned required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ManagementUnitListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: - workforce-management - workforce-management:readonly x-purecloud-method-name: getWorkforcemanagementManagementunits post: tags: - Workforce Management summary: Add a management unit description: It may take a minute or two for a new management unit to be available for api operations operationId: postWorkforcemanagementManagementunits produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/CreateManagementUnitApiRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ManagementUnit' '201': description: The management unit was successfully created schema: $ref: '#/definitions/ManagementUnit' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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. wfm.validation.business.unit.not.found: Business unit not found invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.missing.one.of.permission.sets: Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets. 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: - workforce-management x-inin-requires-permissions: type: ALL permissions: - wfm:managementUnit:add x-purecloud-method-name: postWorkforcemanagementManagementunits /api/v2/workforcemanagement/managementunits/divisionviews: get: tags: - Workforce Management summary: Get management units across divisions description: '' operationId: getWorkforcemanagementManagementunitsDivisionviews produces: - application/json parameters: - name: divisionId in: query description: The divisionIds to filter by. If omitted, will return all divisions required: false type: array items: type: string collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/ManagementUnitListing' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:managementUnit:search x-purecloud-method-name: getWorkforcemanagementManagementunitsDivisionviews /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}: get: tags: - Workforce Management summary: Get data for agent in the management unit description: '' operationId: getWorkforcemanagementManagementunitAgent produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: agentId in: path description: The agent id required: true type: string - name: excludeCapabilities in: query description: Excludes all capabilities of the agent such as queues, languages, and skills required: false type: boolean - name: expand in: query required: false type: array items: type: string enum: - workPlanOverrides collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/WfmAgent' '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agent:view x-purecloud-method-name: getWorkforcemanagementManagementunitAgent /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}/shifttrades: get: tags: - Workforce Management summary: Gets all the shift trades for a given agent description: Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/query/jobs) operationId: getWorkforcemanagementManagementunitAgentShifttrades produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: agentId in: path description: The agent id required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeListResponse' '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly deprecated: true x-inin-requires-permissions: type: ANY permissions: - wfm:shiftTradeRequest:edit - wfm:shiftTradeRequest:view x-purecloud-method-name: getWorkforcemanagementManagementunitAgentShifttrades /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents: patch: tags: - Workforce Management summary: Update agent configurations description: '' operationId: patchWorkforcemanagementManagementunitAgents produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/UpdateMuAgentsRequest' responses: '204': description: Success '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested agents was not found in the management unit 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:agent:edit x-purecloud-method-name: patchWorkforcemanagementManagementunitAgents /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/query: post: tags: - Workforce Management summary: Get agents work plans configuration description: '' operationId: postWorkforcemanagementManagementunitAgentsWorkplansQuery produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/GetAgentsWorkPlansRequest' - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean responses: '200': description: Success schema: $ref: '#/definitions/AgentsWorkPlansResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:workPlan:view x-purecloud-method-name: postWorkforcemanagementManagementunitAgentsWorkplansQuery /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/bulk: patch: tags: - Workforce Management summary: Updates agent work plan configuration description: '' operationId: patchWorkforcemanagementManagementunitAgentsWorkplansBulk produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/UpdateMuAgentWorkPlansBatchRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/UpdateMuAgentWorkPlansBatchResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested agents/work plans not found in management unit 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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:workPlan:edit x-purecloud-method-name: patchWorkforcemanagementManagementunitAgentsWorkplansBulk /api/v2/workforcemanagement/managementunits/{managementUnitId}/users: get: tags: - Workforce Management summary: Get users in the management unit description: '' operationId: getWorkforcemanagementManagementunitUsers produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WfmUserEntityListing' '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agent:view - wfm:historicalAdherence:view - wfm:publishedSchedule:view - wfm:realtimeAdherence:view - wfm:schedule:view - wfm:staffingGroup:view - wfm:timeOffRequest:view - wfm:workPlanRotation:view - wfm:workPlan:view x-purecloud-method-name: getWorkforcemanagementManagementunitUsers /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}: get: tags: - Workforce Management summary: Get a planning group description: '' operationId: getWorkforcemanagementBusinessunitPlanninggroup produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit. required: true type: string - name: planningGroupId in: path description: The ID of a planning group to fetch required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/PlanningGroup' '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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:planningGroup:view x-purecloud-method-name: getWorkforcemanagementBusinessunitPlanninggroup delete: tags: - Workforce Management summary: Deletes the planning group description: '' operationId: deleteWorkforcemanagementBusinessunitPlanninggroup produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit. required: true type: string - name: planningGroupId in: path description: The ID of a planning group to delete required: true type: string responses: '204': description: The planning group was 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 '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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:planningGroup:delete x-purecloud-method-name: deleteWorkforcemanagementBusinessunitPlanninggroup patch: tags: - Workforce Management summary: Updates the planning group description: If the request body contains queue references in route paths, routing:queue:view is required in each referenced queue's division. operationId: patchWorkforcemanagementBusinessunitPlanninggroup produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit. required: true type: string - name: planningGroupId in: path description: The ID of a planning group to update required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/UpdatePlanningGroupRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/PlanningGroup' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information bad.request: The request could not be understood by the server due to malformed syntax. wfm.ids.may.not.be.blank: One or more language, skill or queue IDs was passed in as a blank value wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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. wfm.too.many.skills.in.planning.group: Too many skill IDs were passed across all route paths 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: One or more skill IDs were not found language.ids.not.found: One or more language IDs were not found wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information not.found: The requested resource was not found. queue.ids.not.found: One or more queue IDs were 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ALL permissions: - wfm:planningGroup:edit - routing:queue:view x-purecloud-method-name: patchWorkforcemanagementBusinessunitPlanninggroup /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups: get: tags: - Workforce Management summary: Gets list of planning groups description: '' operationId: getWorkforcemanagementBusinessunitPlanninggroups produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit. required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/PlanningGroupList' '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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:planningGroup:view - wfm:shortTermForecast:view - wfm:intraday:view - wfm:agent:view - wfm:schedule:view - wfm:publishedSchedule:view x-purecloud-method-name: getWorkforcemanagementBusinessunitPlanninggroups post: tags: - Workforce Management summary: Adds a new planning group description: If the request body contains queue references in route paths, routing:queue:view is required in each referenced queue's division. operationId: postWorkforcemanagementBusinessunitPlanninggroups produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/CreatePlanningGroupRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/PlanningGroup' '201': description: The planning group was successfully created schema: $ref: '#/definitions/ServiceGoalTemplate' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information bad.request: The request could not be understood by the server due to malformed syntax. wfm.ids.may.not.be.blank: One or more language, skill or queue IDs was passed in as a blank value wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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. wfm.too.many.skills.in.planning.group: Too many skill IDs were passed across all route paths 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: One or more skill IDs were not found language.ids.not.found: One or more language IDs were not found wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information not.found: The requested resource was not found. queue.ids.not.found: One or more queue IDs were 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ALL permissions: - wfm:planningGroup:add - routing:queue:view x-purecloud-method-name: postWorkforcemanagementBusinessunitPlanninggroups /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}: get: tags: - Workforce Management summary: Get a service goal template description: '' operationId: getWorkforcemanagementBusinessunitServicegoaltemplate produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit. required: true type: string - name: serviceGoalTemplateId in: path description: The ID of a service goal template to fetch required: true type: string - name: expand in: query description: Include to access additional data on the service goal template required: false type: array items: type: string enum: - impactOverride collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/ServiceGoalTemplate' '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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:serviceGoalTemplate:view x-purecloud-method-name: getWorkforcemanagementBusinessunitServicegoaltemplate delete: tags: - Workforce Management summary: Delete a service goal template description: '' operationId: deleteWorkforcemanagementBusinessunitServicegoaltemplate produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit. required: true type: string - name: serviceGoalTemplateId in: path description: The ID of the service goal template to delete required: true type: string responses: '204': description: The service goal template was 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 wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information '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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:serviceGoalTemplate:delete x-purecloud-method-name: deleteWorkforcemanagementBusinessunitServicegoaltemplate patch: tags: - Workforce Management summary: Updates a service goal template description: '' operationId: patchWorkforcemanagementBusinessunitServicegoaltemplate produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit. required: true type: string - name: serviceGoalTemplateId in: path description: The ID of a service goal template to update required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/UpdateServiceGoalTemplate' responses: '200': description: successful operation schema: $ref: '#/definitions/ServiceGoalTemplate' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:serviceGoalTemplate:edit x-purecloud-method-name: patchWorkforcemanagementBusinessunitServicegoaltemplate /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates: get: tags: - Workforce Management summary: Gets list of service goal templates description: '' operationId: getWorkforcemanagementBusinessunitServicegoaltemplates produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit. required: true type: string - name: expand in: query description: Include to access additional data on the service goal template required: false type: array items: type: string enum: - impactOverride collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/ServiceGoalTemplateList' '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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:serviceGoalTemplate:view - wfm:planningGroup:view - wfm:shortTermForecast:view x-purecloud-method-name: getWorkforcemanagementBusinessunitServicegoaltemplates post: tags: - Workforce Management summary: Adds a new service goal template description: '' operationId: postWorkforcemanagementBusinessunitServicegoaltemplates produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/CreateServiceGoalTemplate' responses: '200': description: successful operation schema: $ref: '#/definitions/ServiceGoalTemplate' '201': description: The service goal template was successfully created schema: $ref: '#/definitions/ServiceGoalTemplate' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:serviceGoalTemplate:add x-purecloud-method-name: postWorkforcemanagementBusinessunitServicegoaltemplates /api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/users: get: tags: - Workforce Management summary: Gets list of users available for whom you can send direct shift trade requests description: '' operationId: getWorkforcemanagementManagementunitShifttradesUsers produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WfmUserEntityListing' '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentShiftTradeRequest:participate x-purecloud-method-name: getWorkforcemanagementManagementunitShifttradesUsers /api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/matched: get: tags: - Workforce Management summary: Gets a summary of all shift trades in the matched state description: Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs) operationId: getWorkforcemanagementManagementunitShifttradesMatched produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeMatchesSummaryResponse' '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly deprecated: true x-inin-requires-permissions: type: ANY permissions: - wfm:shiftTradeRequest:view - wfm:shiftTradeRequest:edit x-purecloud-method-name: getWorkforcemanagementManagementunitShifttradesMatched /api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups: get: tags: - Workforce Management summary: Gets a list of staffing groups description: '' operationId: getWorkforcemanagementBusinessunitStaffinggroups produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: managementUnitId in: query description: The ID of the management unit to get management unit specific staffing groups required: false type: string - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/StaffingGroupListing' '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] wfm.validation.management.unit.not.found: Management unit not found 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:staffingGroup:view x-purecloud-method-name: getWorkforcemanagementBusinessunitStaffinggroups post: tags: - Workforce Management summary: Creates a new staffing group description: '' operationId: postWorkforcemanagementBusinessunitStaffinggroups produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/CreateStaffingGroupRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/StaffingGroupResponse' '201': description: The staffing group was successfully created schema: $ref: '#/definitions/StaffingGroupResponse' '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] wfm.validation.management.unit.not.found: Management unit not found constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.business.unit.not.found: Business unit 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:staffingGroup:add x-purecloud-method-name: postWorkforcemanagementBusinessunitStaffinggroups /api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}: get: tags: - Workforce Management summary: Gets a staffing group description: '' operationId: getWorkforcemanagementBusinessunitStaffinggroup produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: staffingGroupId in: path description: The ID of the staffing group to fetch required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/StaffingGroupResponse' '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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:staffingGroup:view x-purecloud-method-name: getWorkforcemanagementBusinessunitStaffinggroup delete: tags: - Workforce Management summary: Deletes a staffing group description: '' operationId: deleteWorkforcemanagementBusinessunitStaffinggroup produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: staffingGroupId in: path description: The ID of the staffing group to delete required: true type: string responses: '204': description: The staffing group was 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:staffingGroup:delete x-purecloud-method-name: deleteWorkforcemanagementBusinessunitStaffinggroup patch: tags: - Workforce Management summary: Updates a staffing group description: '' operationId: patchWorkforcemanagementBusinessunitStaffinggroup produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: staffingGroupId in: path description: The ID of the staffing group to update required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/UpdateStaffingGroupRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/StaffingGroupResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:staffingGroup:edit x-purecloud-method-name: patchWorkforcemanagementBusinessunitStaffinggroup /api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/planninggroups/query: post: tags: - Workforce Management summary: Gets a list of planning group to staffing groups list association description: '' operationId: postWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQuery produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/QueryPlanningGroupToStaffingGroupsRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/PlanningGroupToStaffingGroupsListing' '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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:staffingGroup:view x-purecloud-method-name: postWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQuery /api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query: post: tags: - Workforce Management summary: Gets staffing group associations for a list of user IDs description: '' operationId: postWorkforcemanagementBusinessunitStaffinggroupsQuery produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/QueryUserStaffingGroupListRequest' - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/UserStaffingGroupListing' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:staffingGroup:view x-purecloud-method-name: postWorkforcemanagementBusinessunitStaffinggroupsQuery /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search: post: tags: - Workforce Management summary: Searches for potential shift trade matches for the current agent description: Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs) operationId: postWorkforcemanagementManagementunitWeekShifttradesSearch produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: weekDateId in: path description: 'The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean - in: body name: body description: body required: true schema: $ref: '#/definitions/SearchShiftTradesRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/SearchShiftTradesResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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' wfm.validation.failure: Invalid week date ID in path parameter 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly deprecated: true x-inin-requires-permissions: type: ANY permissions: - wfm:agentShiftTradeRequest:participate x-purecloud-method-name: postWorkforcemanagementManagementunitWeekShifttradesSearch /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades: get: tags: - Workforce Management summary: Gets all the shift trades for a given week description: Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs) operationId: getWorkforcemanagementManagementunitWeekShifttrades produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: weekDateId in: path description: 'The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: evaluateMatches in: query description: Whether to evaluate the matches for violations required: false type: boolean default: true - name: includeCrossWeekShifts in: query description: Whether to include all shift trades with either the initiating shift or the receiving shift in the week required: false type: boolean default: 'null' - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/WeekShiftTradeListResponse' '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' wfm.validation.failure: Invalid week date ID in path parameter 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly deprecated: true x-inin-requires-permissions: type: ANY permissions: - wfm:shiftTradeRequest:view - wfm:shiftTradeRequest:edit x-purecloud-method-name: getWorkforcemanagementManagementunitWeekShifttrades post: tags: - Workforce Management summary: Adds a shift trade description: Deprecated. Use new route instead (/shifttrading/trades/jobs) operationId: postWorkforcemanagementManagementunitWeekShifttrades produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: weekDateId in: path description: 'The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - in: body name: body description: body required: true schema: $ref: '#/definitions/AddShiftTradeRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management deprecated: true x-inin-requires-permissions: type: ANY permissions: - wfm:agentShiftTradeRequest:participate x-purecloud-method-name: postWorkforcemanagementManagementunitWeekShifttrades /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/state/bulk: post: tags: - Workforce Management summary: Updates the state of a batch of shift trades description: Admin functionality is not supported with "mine". Deprecated. Use new route instead (/businessunits/{buId}/shifttrading/trades/state/bulk/jobs) operationId: postWorkforcemanagementManagementunitWeekShifttradesStateBulk produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: weekDateId in: path description: 'The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - in: body name: body description: body required: true schema: $ref: '#/definitions/BulkShiftTradeStateUpdateRequest' - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/BulkUpdateShiftTradeStateResponse' '202': description: The shift trades are being updated. Results will come via notification schema: $ref: '#/definitions/BulkUpdateShiftTradeStateResponse' '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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management deprecated: true x-inin-requires-permissions: type: ANY permissions: - wfm:agentShiftTradeRequest:participate - wfm:shiftTradeRequest:edit x-purecloud-method-name: postWorkforcemanagementManagementunitWeekShifttradesStateBulk /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}: patch: tags: - Workforce Management summary: Updates a shift trade. This route can only be called by the initiating agent description: Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/jobs) operationId: patchWorkforcemanagementManagementunitWeekShifttrade produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: weekDateId in: path description: 'The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - in: body name: body description: body required: true schema: $ref: '#/definitions/PatchShiftTradeRequest' - name: tradeId in: path description: The ID of the shift trade to update required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management deprecated: true x-inin-requires-permissions: type: ANY permissions: - wfm:agentShiftTradeRequest:participate x-purecloud-method-name: patchWorkforcemanagementManagementunitWeekShifttrade /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match: post: tags: - Workforce Management summary: Matches a shift trade. This route can only be called by the receiving agent description: Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/match/jobs) operationId: postWorkforcemanagementManagementunitWeekShifttradeMatch produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: weekDateId in: path description: 'The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - in: body name: body description: body required: true schema: $ref: '#/definitions/MatchShiftTradeRequest' - name: tradeId in: path description: The ID of the shift trade to update required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/MatchShiftTradeResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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' wfm.validation.failure: Invalid week date ID in path parameter 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management deprecated: true x-inin-requires-permissions: type: ANY permissions: - wfm:agentShiftTradeRequest:participate x-purecloud-method-name: postWorkforcemanagementManagementunitWeekShifttradeMatch /api/v2/workforcemanagement/agents: post: tags: - Workforce Management summary: Move agents in and out of management unit description: '' operationId: postWorkforcemanagementAgents produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/MoveAgentsRequest' responses: '202': description: Processing request schema: $ref: '#/definitions/MoveAgentsResponse' '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 wfm.ids.may.not.be.blank: One or more user IDs was passed in as a blank value 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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.management.unit.not.found: Management unit not found not.found: The requested resource was not found. user.ids.not.found: One of the requested resources in the request body was not found, please check the error details for more information '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:agent:edit x-purecloud-method-name: postWorkforcemanagementAgents /api/v2/workforcemanagement/agents/{agentId}/managementunit: get: tags: - Workforce Management summary: Get the management unit to which the agent belongs description: '' operationId: getWorkforcemanagementAgentManagementunit produces: - application/json parameters: - name: agentId in: path description: The ID of the agent to look up required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AgentManagementUnitReference' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: The requested agent is not in a management unit 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: - coaching - learning - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agent:view - wfm:publishedSchedule:view - wfm:schedule:view - coaching:appointment:add - coaching:appointment:edit - learning:assignment:add - learning:assignment:reschedule x-purecloud-method-name: getWorkforcemanagementAgentManagementunit /api/v2/workforcemanagement/agents/me/managementunit: get: tags: - Workforce Management summary: Get the management unit to which the currently logged in agent belongs description: '' operationId: getWorkforcemanagementAgentsMeManagementunit produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/AgentManagementUnitReference' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: The requested agent is not in a management unit 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: - coaching - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentSchedule:view - wfm:agentTimeOffRequest:submit - wfm:activityCode:add - wfm:activityCode:delete - wfm:activityCode:edit - wfm:activityCode:view - wfm:agent:edit - wfm:agent:view - wfm:businessUnit:add - wfm:businessUnit:delete - wfm:businessUnit:edit - wfm:businessUnit:view - wfm:historicalAdherence:view - wfm:intraday:view - wfm:managementUnit:add - wfm:managementUnit:delete - wfm:managementUnit:edit - wfm:managementUnit:view - wfm:realtimeAdherence:view - wfm:schedule:add - wfm:schedule:delete - wfm:schedule:edit - wfm:schedule:generate - wfm:schedule:view - wfm:publishedSchedule:view - wfm:serviceGoalTemplate:add - wfm:serviceGoalTemplate:delete - wfm:serviceGoalTemplate:edit - wfm:serviceGoalTemplate:view - wfm:planningGroup:add - wfm:planningGroup:delete - wfm:planningGroup:edit - wfm:planningGroup:view - wfm:shiftTradeRequest:edit - wfm:shiftTradeRequest:view - wfm:shortTermForecast:add - wfm:shortTermForecast:delete - wfm:shortTermForecast:edit - wfm:shortTermForecast:view - wfm:timeOffLimit:add - wfm:timeOffLimit:delete - wfm:timeOffLimit:edit - wfm:timeOffLimit:view - wfm:timeOffPlan:add - wfm:timeOffPlan:delete - wfm:timeOffPlan:edit - wfm:timeOffPlan:view - wfm:timeOffRequest:add - wfm:timeOffRequest:edit - wfm:timeOffRequest:view - wfm:workPlan:add - wfm:workPlan:delete - wfm:workPlan:edit - wfm:workPlan:view - wfm:workPlanRotation:add - wfm:workPlanRotation:delete - wfm:workPlanRotation:edit - wfm:workPlanRotation:view - wfm:agentSchedulingPreferencesQuery:view - wfm:agentSchedulingPreferences:edit - wfm:agentSchedulingPreferencesSettings:view - wfm:schedulingPreferencesQuery:view - wfm:schedulingPreferencesSettings:view - wfm:schedulingPreferencesSettings:edit x-purecloud-method-name: getWorkforcemanagementAgentsMeManagementunit /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate: post: tags: - Workforce Management summary: Validate Work Plan description: '' operationId: postWorkforcemanagementManagementunitWorkplanValidate produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: workPlanId in: path description: The ID of the work plan to validate. For new work plan, use the word 'new' for the ID. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/WorkPlanValidationRequest' - name: expand in: query required: false type: array items: type: string enum: - messages collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/ValidateWorkPlanResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:workPlan:add - wfm:workPlan:edit x-purecloud-method-name: postWorkforcemanagementManagementunitWorkplanValidate /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}: get: tags: - Workforce Management summary: Get a work plan description: '' operationId: getWorkforcemanagementManagementunitWorkplan produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: workPlanId in: path description: The ID of the work plan to fetch required: true type: string - name: includeOnly in: query description: limit response to the specified fields required: false type: array items: type: string enum: - agentCount - agents - optionalDays - shifts - shiftStartVariances collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlan' '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanRotation:view - wfm:workPlan:view - wfm:schedule:edit x-purecloud-method-name: getWorkforcemanagementManagementunitWorkplan delete: tags: - Workforce Management summary: Delete a work plan description: '' operationId: deleteWorkforcemanagementManagementunitWorkplan produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: workPlanId in: path description: The ID of the work plan to delete required: true type: string responses: '204': description: The work plan was 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 wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:workPlan:delete x-purecloud-method-name: deleteWorkforcemanagementManagementunitWorkplan patch: tags: - Workforce Management summary: Update a work plan description: '' operationId: patchWorkforcemanagementManagementunitWorkplan produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: workPlanId in: path description: The ID of the work plan to update required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/WorkPlan' - name: validationMode in: query description: Allows to update work plan even if validation result is invalid required: false type: string enum: - Ignore responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlan' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Version of the request does not match the version on the backend '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:workPlan:edit x-purecloud-method-name: patchWorkforcemanagementManagementunitWorkplan /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans: get: tags: - Workforce Management summary: Get work plans description: '"expand=details" is deprecated' operationId: getWorkforcemanagementManagementunitWorkplans produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: expand in: query description: Include to access additional data on the work plans required: false type: array items: type: string enum: - agentCount - agents - optionalDays - shifts - shiftStartVariances - details collectionFormat: multi - name: exclude in: query description: Exclude specific data on the work plans from the response required: false type: array items: type: string enum: - shifts.activities collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlanListResponse' '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: wfm.server.error: WFM Server Error internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agent:view - wfm:publishedSchedule:view - wfm:schedule:view - wfm:workPlanRotation:view - wfm:workPlan:view x-purecloud-method-name: getWorkforcemanagementManagementunitWorkplans post: tags: - Workforce Management summary: Create a new work plan description: '' operationId: postWorkforcemanagementManagementunitWorkplans produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/CreateWorkPlan' - name: validationMode in: query description: Allows to create work plan even if the validation result is invalid required: false type: string enum: - Ignore responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlan' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:workPlan:add x-purecloud-method-name: postWorkforcemanagementManagementunitWorkplans /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy: post: tags: - Workforce Management summary: Create a copy of work plan description: '' operationId: postWorkforcemanagementManagementunitWorkplanCopy produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: workPlanId in: path description: The ID of the work plan to create a copy required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/CopyWorkPlan' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlan' '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' wfm.validation.failure: Name not specified or there is already a work plan with the name mentioned for copy 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:workPlan:add x-purecloud-method-name: postWorkforcemanagementManagementunitWorkplanCopy /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations: get: tags: - Workforce Management summary: Get work plan rotations description: '' operationId: getWorkforcemanagementManagementunitWorkplanrotations produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: expand in: query required: false type: array items: type: string enum: - agents collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlanRotationListResponse' '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agent:view - wfm:workPlanRotation:view x-purecloud-method-name: getWorkforcemanagementManagementunitWorkplanrotations post: tags: - Workforce Management summary: Create a new work plan rotation description: '' operationId: postWorkforcemanagementManagementunitWorkplanrotations produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/AddWorkPlanRotationRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlanRotationResponse' '201': description: The work plan rotation was successfully created schema: $ref: '#/definitions/WorkPlanRotationResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanRotation:add x-purecloud-method-name: postWorkforcemanagementManagementunitWorkplanrotations /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}: get: tags: - Workforce Management summary: Get a work plan rotation description: '' operationId: getWorkforcemanagementManagementunitWorkplanrotation produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: workPlanRotationId in: path description: The ID of the work plan rotation to fetch required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlanRotationResponse' '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanRotation:view x-purecloud-method-name: getWorkforcemanagementManagementunitWorkplanrotation delete: tags: - Workforce Management summary: Delete a work plan rotation description: '' operationId: deleteWorkforcemanagementManagementunitWorkplanrotation produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: workPlanRotationId in: path description: The ID of the work plan rotation to be deleted required: true type: string responses: '204': description: The work plan rotation was 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 wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanRotation:delete x-purecloud-method-name: deleteWorkforcemanagementManagementunitWorkplanrotation patch: tags: - Workforce Management summary: Update a work plan rotation description: '' operationId: patchWorkforcemanagementManagementunitWorkplanrotation produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: workPlanRotationId in: path description: The ID of the work plan rotation to update required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/UpdateWorkPlanRotationRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlanRotationResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Version of the request does not match the version on the backend '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanRotation:edit x-purecloud-method-name: patchWorkforcemanagementManagementunitWorkplanrotation /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy: post: tags: - Workforce Management summary: Create a copy of work plan rotation description: '' operationId: postWorkforcemanagementManagementunitWorkplanrotationCopy produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: workPlanRotationId in: path description: The ID of the work plan rotation to create a copy required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/CopyWorkPlanRotationRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlanRotationResponse' '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' wfm.validation.failure: Name not specified or there is already a work plan rotation with the name mentioned for copy 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanRotation:add x-purecloud-method-name: postWorkforcemanagementManagementunitWorkplanrotationCopy /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/jobs: get: tags: - Workforce Management summary: Gets the latest job for all activity plans in the business unit description: '' operationId: getWorkforcemanagementBusinessunitActivityplansJobs produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ActivityPlanJobListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: Validation rules were violated on this request 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:activityPlan:view x-purecloud-method-name: getWorkforcemanagementBusinessunitActivityplansJobs /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans: get: tags: - Workforce Management summary: Get activity plans description: '' operationId: getWorkforcemanagementBusinessunitActivityplans produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: state in: query description: Optionally filter by activity plan state required: false type: string enum: - Active - Inactive responses: '200': description: successful operation schema: $ref: '#/definitions/ActivityPlanListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: Validation rules were violated on this request 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:activityPlan:view x-purecloud-method-name: getWorkforcemanagementBusinessunitActivityplans post: tags: - Workforce Management summary: Create an activity plan description: '' operationId: postWorkforcemanagementBusinessunitActivityplans produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/CreateActivityPlanRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ActivityPlanResponse' '201': description: The activity plan was created successfully schema: $ref: '#/definitions/ActivityPlanResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: Validation rules were violated on this request 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:activityPlan:add x-purecloud-method-name: postWorkforcemanagementBusinessunitActivityplans /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}: get: tags: - Workforce Management summary: Get an activity plan description: '' operationId: getWorkforcemanagementBusinessunitActivityplan produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: activityPlanId in: path description: The ID of the activity plan to fetch required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ActivityPlanResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: Validation rules were violated on this request 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:activityPlan:view x-purecloud-method-name: getWorkforcemanagementBusinessunitActivityplan patch: tags: - Workforce Management summary: Update an activity plan description: If a job associated with the activity plan is in 'Processing' state the activity plan cannot be updated operationId: patchWorkforcemanagementBusinessunitActivityplan produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: activityPlanId in: path description: The ID of the activity plan to update required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/UpdateActivityPlanRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ActivityPlanResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: Validation rules were violated on this request 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:activityPlan:edit x-purecloud-method-name: patchWorkforcemanagementBusinessunitActivityplan /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs: post: tags: - Workforce Management summary: Run an activity plan manually description: Triggers a job running the activity plan. The activity plan cannot be updated until the job completes operationId: postWorkforcemanagementBusinessunitActivityplanRunsJobs produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: activityPlanId in: path description: The ID of the activity plan to run required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ActivityPlanRunJobResponse' '201': description: The run activity plan job is running schema: $ref: '#/definitions/ActivityPlanRunJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: Validation rules were violated on this request 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:activityPlanRunJob:add x-purecloud-method-name: postWorkforcemanagementBusinessunitActivityplanRunsJobs /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs/{jobId}: get: tags: - Workforce Management summary: Gets an activity plan run job description: '' operationId: getWorkforcemanagementBusinessunitActivityplanRunsJob produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: activityPlanId in: path description: The ID of the activity plan associated with the run job required: true type: string - name: jobId in: path description: The ID of the activity plan run job required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ActivityPlanJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: Validation rules were violated on this request 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:activityPlanRunJob:view x-purecloud-method-name: getWorkforcemanagementBusinessunitActivityplanRunsJob /api/v2/workforcemanagement/adherence/explanations/jobs/{jobId}: get: tags: - Workforce Management summary: Query the status of an adherence explanation operation. Only the user who started the operation can query the status description: Job details are only retained if the initial request returned a 202 ACCEPTED response operationId: getWorkforcemanagementAdherenceExplanationsJob produces: - application/json parameters: - name: jobId in: path description: The ID of the job required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AdherenceExplanationJob' '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: wfm.entity.not.found: The job with the requested ID was 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: - workforce-management - workforce-management:readonly x-purecloud-method-name: getWorkforcemanagementAdherenceExplanationsJob /api/v2/workforcemanagement/agents/{agentId}/adherence/explanations: post: tags: - Workforce Management summary: Add an adherence explanation for the requested user description: '' operationId: postWorkforcemanagementAgentAdherenceExplanations produces: - application/json parameters: - name: agentId in: path description: The ID of the agent to query required: true type: string - in: body name: body description: The request body required: true schema: $ref: '#/definitions/AddAdherenceExplanationAdminRequest' responses: '202': description: The adherence explanation is processing schema: $ref: '#/definitions/AdherenceExplanationAsyncResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:adherenceExplanation:add x-purecloud-method-name: postWorkforcemanagementAgentAdherenceExplanations /api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}: get: tags: - Workforce Management summary: Get an adherence explanation description: '' operationId: getWorkforcemanagementAgentAdherenceExplanation produces: - application/json parameters: - name: agentId in: path description: The ID of the agent to query required: true type: string - name: explanationId in: path description: The ID of the explanation to update required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AdherenceExplanationResponse' '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: wfm.entity.not.found: The explanation was not found. It either does not exist or may now only be accessible via query by date range 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:adherenceExplanation:view x-purecloud-method-name: getWorkforcemanagementAgentAdherenceExplanation patch: tags: - Workforce Management summary: Update an adherence explanation description: '' operationId: patchWorkforcemanagementAgentAdherenceExplanation produces: - application/json parameters: - name: agentId in: path description: The ID of the agent to query required: true type: string - name: explanationId in: path description: The ID of the explanation to update required: true type: string - in: body name: body description: The request body required: true schema: $ref: '#/definitions/UpdateAdherenceExplanationStatusRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AdherenceExplanationAsyncResponse' '202': description: The adherence explanation update is processing schema: $ref: '#/definitions/AdherenceExplanationAsyncResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:adherenceExplanation:edit x-purecloud-method-name: patchWorkforcemanagementAgentAdherenceExplanation /api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query: post: tags: - Workforce Management summary: Query adherence explanations for the given agent across a specified range description: '' operationId: postWorkforcemanagementAgentAdherenceExplanationsQuery produces: - application/json parameters: - name: agentId in: path description: The ID of the agent to query required: true type: string - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean - in: body name: body description: The request body required: true schema: $ref: '#/definitions/AgentQueryAdherenceExplanationsRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AgentQueryAdherenceExplanationsResponse' '202': description: The adherence explanation query is processing schema: $ref: '#/definitions/AgentQueryAdherenceExplanationsResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:adherenceExplanation:view x-purecloud-method-name: postWorkforcemanagementAgentAdherenceExplanationsQuery /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query: post: tags: - Workforce Management summary: Query adherence explanations across an entire business unit for the requested period description: '' operationId: postWorkforcemanagementBusinessunitAdherenceExplanationsQuery produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean - in: body name: body description: The request body required: true schema: $ref: '#/definitions/BuQueryAdherenceExplanationsRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BuQueryAdherenceExplanationsResponse' '202': description: The adherence explanation query is processing schema: $ref: '#/definitions/BuQueryAdherenceExplanationsResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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: wfm.business.unit.not.found: The requested business unit was 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:adherenceExplanation:view x-purecloud-method-name: postWorkforcemanagementBusinessunitAdherenceExplanationsQuery /api/v2/workforcemanagement/adherence/explanations: post: tags: - Workforce Management summary: Submit an adherence explanation for the current user description: '' operationId: postWorkforcemanagementAdherenceExplanations produces: - application/json parameters: - in: body name: body description: The request body required: true schema: $ref: '#/definitions/AddAdherenceExplanationAgentRequest' responses: '202': description: The adherence explanation is processing schema: $ref: '#/definitions/AdherenceExplanationAsyncResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:agentAdherenceExplanation:submit x-purecloud-method-name: postWorkforcemanagementAdherenceExplanations /api/v2/workforcemanagement/adherence/explanations/{explanationId}: get: tags: - Workforce Management summary: Get an adherence explanation for the current user description: '' operationId: getWorkforcemanagementAdherenceExplanation produces: - application/json parameters: - name: explanationId in: path description: The ID of the explanation to update required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AdherenceExplanationResponse' '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: wfm.entity.not.found: The explanation was not found. It either does not exist or may now only be accessible via query by date range 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentAdherenceExplanation:submit x-purecloud-method-name: getWorkforcemanagementAdherenceExplanation /api/v2/workforcemanagement/adherence/explanations/query: post: tags: - Workforce Management summary: Query adherence explanations for the current user description: '' operationId: postWorkforcemanagementAdherenceExplanationsQuery produces: - application/json parameters: - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean - in: body name: body description: The request body required: true schema: $ref: '#/definitions/AgentQueryAdherenceExplanationsRequest' responses: '202': description: The adherence explanation query is processing schema: $ref: '#/definitions/QueryAdherenceExplanationsResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentAdherenceExplanation:submit x-purecloud-method-name: postWorkforcemanagementAdherenceExplanationsQuery /api/v2/workforcemanagement/agents/me/adherence/historical/jobs/{jobId}: get: tags: - Workforce Management summary: Request to fetch the status of the agent adherence job. Only the user who started the operation can query the status description: Job details are only retained if the initial request returned a 202 ACCEPTED response operationId: getWorkforcemanagementAgentsMeAdherenceHistoricalJob produces: - application/json parameters: - name: jobId in: path description: ID of the job to get required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WfmAgentHistoricalAdherenceResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: job.not.found: The requested job could not be 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: - workforce-management - workforce-management:readonly x-purecloud-method-name: getWorkforcemanagementAgentsMeAdherenceHistoricalJob /api/v2/workforcemanagement/agents/me/adherence/historical/jobs: post: tags: - Workforce Management summary: Request an agent historical adherence report description: 'The maximum supported range for historical adherence queries is 31 days, or 7 days when the expand query parameter includes any of the following: exceptionInfo, actuals, scheduledActivities' operationId: postWorkforcemanagementAgentsMeAdherenceHistoricalJobs produces: - application/json parameters: - name: expand in: query description: Which fields, if any, to expand with. wfm:AgentHistoricalAdherenceConformance:view permission is required for conformance, and wfm:agentSchedule:view permission is required for scheduledActivities. required: false type: array items: type: string enum: - exceptionInfo - actuals - scheduledActivities - conformance collectionFormat: multi - in: body name: body description: body required: false schema: $ref: '#/definitions/WfmHistoricalAdherenceQueryForAgent' responses: '202': description: Processing request schema: $ref: '#/definitions/WfmAgentHistoricalAdherenceResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:agentHistoricalAdherence:view - wfm:agentHistoricalAdherenceConformance:view x-purecloud-method-name: postWorkforcemanagementAgentsMeAdherenceHistoricalJobs /api/v2/workforcemanagement/adherence/historical/bulk: post: tags: - Workforce Management summary: Request a historical adherence report in bulk description: '' operationId: postWorkforcemanagementAdherenceHistoricalBulk produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/WfmHistoricalAdherenceBulkQuery' responses: '202': description: Processing request schema: $ref: '#/definitions/WfmHistoricalAdherenceBulkResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.missing.fields: One or more required fields are missing from the request 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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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' wfm.team.only.permissions.not.allowed: Team-only permissions are not allowed 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' wfm.only.authorized.for.team.access.some.divisions: You are only authorized to call this route for specific teams for some of the required divisions 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:historicalAdherence:view x-purecloud-method-name: postWorkforcemanagementAdherenceHistoricalBulk /api/v2/workforcemanagement/adherence/historical/bulk/jobs/{jobId}: get: tags: - Workforce Management summary: Request to fetch the status of the historical adherence bulk job. Only the user who started the operation can query the status description: Job details are only retained if the initial request returned a 202 ACCEPTED response operationId: getWorkforcemanagementAdherenceHistoricalBulkJob produces: - application/json parameters: - name: jobId in: path description: ID of the job to get required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WfmHistoricalAdherenceBulkResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: job.not.found: The requested job could not be 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: - workforce-management - workforce-management:readonly x-purecloud-method-name: getWorkforcemanagementAdherenceHistoricalBulkJob /api/v2/workforcemanagement/adherence/historical/jobs/{jobId}: get: tags: - Workforce Management summary: Query the status of a historical adherence request operation. Only the user who started the operation can query the status description: Job details are only retained if the initial request returned a 202 ACCEPTED response operationId: getWorkforcemanagementAdherenceHistoricalJob produces: - application/json parameters: - name: jobId in: path description: jobId required: true type: string responses: '200': description: Successful Operation schema: $ref: '#/definitions/WfmHistoricalAdherenceResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: entitynotfound: The requested entity was not found. job.not.found: The requested job could not be 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:historicalAdherence:view x-purecloud-method-name: getWorkforcemanagementAdherenceHistoricalJob /api/v2/workforcemanagement/managementunits/{managementUnitId}/historicaladherencequery: post: tags: - Workforce Management summary: Request a historical adherence report description: The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true operationId: postWorkforcemanagementManagementunitHistoricaladherencequery produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/WfmHistoricalAdherenceQuery' responses: '202': description: Processing request schema: $ref: '#/definitions/WfmHistoricalAdherenceResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.team.empty.or.no.members.in.management.unit: No members of the team were in a management unit, or the team was empty 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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details wfm.requested.teams.and.users: You may only either teams or users, not both wfm.only.authorized.for.team.access: You are only authorized to call this route for specific teams wfm.too.many.teams.requested: You may only request up to 10 teams in a single request response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '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' wfm.missing.team.permissions: You must have access to the requested teams 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:historicalAdherence:view x-purecloud-method-name: postWorkforcemanagementManagementunitHistoricaladherencequery /api/v2/workforcemanagement/teams/{teamId}/adherence/historical: post: tags: - Workforce Management summary: Request a teams historical adherence report description: The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true operationId: postWorkforcemanagementTeamAdherenceHistorical produces: - application/json parameters: - name: teamId in: path description: The ID of the team required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/WfmHistoricalAdherenceQueryForTeams' responses: '202': description: Processing request schema: $ref: '#/definitions/WfmHistoricalAdherenceResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.team.empty.or.no.members.in.management.unit: No members of the team were in a management unit, or the team was empty 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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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' wfm.missing.team.permissions: You must have access to the requested teams wfm.unauthorized.for.any.team.members: You are not authorized for any members of the team 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:historicalAdherence:view x-purecloud-method-name: postWorkforcemanagementTeamAdherenceHistorical /api/v2/workforcemanagement/managementunits/{managementUnitId}/adherence: get: tags: - Workforce Management summary: Get a list of user schedule adherence records for the requested management unit description: '' operationId: getWorkforcemanagementManagementunitAdherence produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit required: true type: string - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/UserScheduleAdherenceListing' '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.id: The management unit ID must be a valid 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' wfm.team.only.permissions.not.allowed: Team-only permissions are not allowed 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: wfm.management.unit.not.found: Management unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:realtimeAdherence:view x-purecloud-method-name: getWorkforcemanagementManagementunitAdherence /api/v2/workforcemanagement/teams/{teamId}/adherence: get: tags: - Workforce Management summary: Get a list of user schedule adherence records for the requested team description: '' operationId: getWorkforcemanagementTeamAdherence produces: - application/json parameters: - name: teamId in: path description: The ID of the team required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/UserScheduleAdherenceListing' '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.id: The team ID must be a valid 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' wfm.missing.team.permissions: You must have access to the requested team 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:realtimeAdherence:view x-purecloud-method-name: getWorkforcemanagementTeamAdherence /api/v2/workforcemanagement/adherence: get: tags: - Workforce Management summary: Get a list of UserScheduleAdherence records for the requested users description: '' operationId: getWorkforcemanagementAdherence produces: - application/json parameters: - name: userId in: query description: User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request required: true type: array items: type: string collectionFormat: multi responses: '200': description: successful operation schema: type: array items: $ref: '#/definitions/UserScheduleAdherence' '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.id: All requested user IDs must be valid UUIDs no.user.ids.specified: You must specify at least one userId constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' max.user.ids: Only 100 users can be requested at a time '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: fail: WFM Server Error internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:realtimeAdherence:view x-purecloud-method-name: getWorkforcemanagementAdherence /api/v2/workforcemanagement/agents/me/possibleworkshifts: post: tags: - Workforce Management summary: Get agent possible work shifts for requested time frame description: '' operationId: postWorkforcemanagementAgentsMePossibleworkshifts produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/AgentPossibleWorkShiftsRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AgentPossibleWorkShiftsResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentPossibleWorkShifts:view x-purecloud-method-name: postWorkforcemanagementAgentsMePossibleworkshifts /api/v2/workforcemanagement/businessunits/{businessUnitId}/unavailabletimes/settings/query: post: tags: - Workforce Management summary: Query availability management units settings description: '' operationId: postWorkforcemanagementBusinessunitUnavailabletimesSettingsQuery produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/QueryAvailabilityManagementUnitsSettingsRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/QueryAvailabilityManagementUnitsSettingsResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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] wfm.validation.management.unit.not.found: Management unit not found 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: wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:managementUnit:view x-purecloud-method-name: postWorkforcemanagementBusinessunitUnavailabletimesSettingsQuery /api/v2/workforcemanagement/businessunits/{businessUnitId}/unavailabletimes/schedules/query: post: tags: - Workforce Management summary: Get agent schedule generation unavailable times description: '' operationId: postWorkforcemanagementBusinessunitUnavailabletimesSchedulesQuery produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/QueryAgentScheduleUnavailableTimesRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/QueryAgentScheduleUnavailableTimesResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:unavailableTimes:view x-purecloud-method-name: postWorkforcemanagementBusinessunitUnavailabletimesSchedulesQuery /api/v2/workforcemanagement/managementunits/{managementUnitId}/unavailabletimes/settings: patch: tags: - Workforce Management summary: Update management unit availability settings description: '' operationId: patchWorkforcemanagementManagementunitUnavailabletimesSettings produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/UpdateManagementUnitsSettingsRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ManagementUnitAvailabilitySettingsResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:managementUnit:edit x-purecloud-method-name: patchWorkforcemanagementManagementunitUnavailabletimesSettings /api/v2/workforcemanagement/agents/{agentId}/unavailabletimes/query: post: tags: - Workforce Management summary: Get agent unavailable times description: '' operationId: postWorkforcemanagementAgentUnavailabletimesQuery produces: - application/json parameters: - name: agentId in: path description: The ID of the agent required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/QueryAgentUnavailableTimesRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/UnavailableTimeListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: The requested agent is not in a management unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:unavailableTimes:view x-purecloud-method-name: postWorkforcemanagementAgentUnavailabletimesQuery /api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings: get: tags: - Workforce Management summary: Get alternative shifts settings for a business unit description: '' operationId: getWorkforcemanagementBusinessunitAlternativeshiftsSettings produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AlternativeShiftBuSettingsResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:businessUnit:view x-purecloud-method-name: getWorkforcemanagementBusinessunitAlternativeshiftsSettings patch: tags: - Workforce Management summary: Update alternative shifts settings for a business unit description: '' operationId: patchWorkforcemanagementBusinessunitAlternativeshiftsSettings produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/UpdateAlternativeShiftBuSettingsRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AlternativeShiftBuSettingsResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:businessUnit:edit x-purecloud-method-name: patchWorkforcemanagementBusinessunitAlternativeshiftsSettings /api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search: post: tags: - Workforce Management summary: List alternative shifts trades for a given management unit or agent description: '' operationId: postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: The request body required: true schema: $ref: '#/definitions/SearchAlternativeShiftTradesRequest' - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/BuListAlternativeShiftTradesResponse' '202': description: The search trades request is processing schema: $ref: '#/definitions/BuListAlternativeShiftTradesResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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] wfm.validation.management.unit.not.found: Management unit not found 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:alternativeShift:view x-purecloud-method-name: postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch /api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search/jobs/{jobId}: get: tags: - Workforce Management summary: Query the status of an alternative shift search trade operation. Only the user who started the operation can query the status description: Job details are only retained if the initial request returned a 202 ACCEPTED response operationId: getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: jobId in: path description: The ID of the job required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/BuAlternativeShiftJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:alternativeShift:view x-purecloud-method-name: getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob /api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/{tradeId}: get: tags: - Workforce Management summary: Get an alternative shifts trade in a business unit for a given trade ID description: '' operationId: getWorkforcemanagementBusinessunitAlternativeshiftsTrade produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: tradeId in: path description: The ID of the alternative shift trade required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AlternativeShiftTradeResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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] wfm.validation.management.unit.not.found: Management unit not found 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:alternativeShift:view x-purecloud-method-name: getWorkforcemanagementBusinessunitAlternativeshiftsTrade /api/v2/workforcemanagement/alternativeshifts/offers/jobs: post: tags: - Workforce Management summary: Request a list of alternative shift offers for a given schedule description: '' operationId: postWorkforcemanagementAlternativeshiftsOffersJobs produces: - application/json parameters: - in: body name: body description: The request body required: true schema: $ref: '#/definitions/AlternativeShiftOffersRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AlternativeShiftAsyncResponse' '202': description: The list offers request is processing schema: $ref: '#/definitions/AlternativeShiftAsyncResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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: wfm.management.unit.not.found: The requesting agent is not in a business or management unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentAlternativeShift:submit x-purecloud-method-name: postWorkforcemanagementAlternativeshiftsOffersJobs /api/v2/workforcemanagement/alternativeshifts/offers/jobs/{jobId}: get: tags: - Workforce Management summary: Query the status of an alternative shift offers operation. Only the user who started the operation can query the status description: Job details are only retained if the initial request returned a 202 ACCEPTED response operationId: getWorkforcemanagementAlternativeshiftsOffersJob produces: - application/json parameters: - name: jobId in: path description: The ID of the job required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AlternativeShiftJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentAlternativeShift:submit x-purecloud-method-name: getWorkforcemanagementAlternativeshiftsOffersJob /api/v2/workforcemanagement/alternativeshifts/offers/search/jobs: post: tags: - Workforce Management summary: Request a search of alternative shift offers for a given shift description: '' operationId: postWorkforcemanagementAlternativeshiftsOffersSearchJobs produces: - application/json parameters: - in: body name: body description: The request body required: true schema: $ref: '#/definitions/AlternativeShiftSearchOffersRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AlternativeShiftAsyncResponse' '202': description: The search offers request is processing schema: $ref: '#/definitions/AlternativeShiftAsyncResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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: wfm.management.unit.not.found: The requesting agent is not in a business or management unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentAlternativeShift:submit x-purecloud-method-name: postWorkforcemanagementAlternativeshiftsOffersSearchJobs /api/v2/workforcemanagement/alternativeshifts/offers/search/jobs/{jobId}: get: tags: - Workforce Management summary: Query the status of an alternative shift search offers operation. Only the user who started the operation can query the status description: Job details are only retained if the initial request returned a 202 ACCEPTED response operationId: getWorkforcemanagementAlternativeshiftsOffersSearchJob produces: - application/json parameters: - name: jobId in: path description: The ID of the job required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AlternativeShiftJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentAlternativeShift:submit x-purecloud-method-name: getWorkforcemanagementAlternativeshiftsOffersSearchJob /api/v2/workforcemanagement/alternativeshifts/trades: get: tags: - Workforce Management summary: Get a list of my alternative shifts trades description: '' operationId: getWorkforcemanagementAlternativeshiftsTrades produces: - application/json parameters: - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/ListAlternativeShiftTradesResponse' '202': description: The list trades request is processing schema: $ref: '#/definitions/ListAlternativeShiftTradesResponse' '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: wfm.entity.not.found: The requesting agent is not in a business or management unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentAlternativeShift:submit x-purecloud-method-name: getWorkforcemanagementAlternativeshiftsTrades post: tags: - Workforce Management summary: Create my alternative shift trade using an existing offer's jobId description: '' operationId: postWorkforcemanagementAlternativeshiftsTrades produces: - application/json parameters: - in: body name: body description: The request body required: true schema: $ref: '#/definitions/CreateAlternativeShiftTradeRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AlternativeShiftTradeResponse' '201': description: The requested trade was created schema: $ref: '#/definitions/AlternativeShiftTradeResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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: wfm.entity.not.found: The requesting agent is not in a business or management unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentAlternativeShift:submit x-purecloud-method-name: postWorkforcemanagementAlternativeshiftsTrades /api/v2/workforcemanagement/alternativeshifts/trades/jobs/{jobId}: get: tags: - Workforce Management summary: Query the status of an alternative shift trades operation. Only the user who started the operation can query the status description: Job details are only retained if the initial request returned a 202 ACCEPTED response operationId: getWorkforcemanagementAlternativeshiftsTradesJob produces: - application/json parameters: - name: jobId in: path description: The ID of the job required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AlternativeShiftJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentAlternativeShift:submit x-purecloud-method-name: getWorkforcemanagementAlternativeshiftsTradesJob /api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}: get: tags: - Workforce Management summary: Get my alternative shift trade by trade ID description: '' operationId: getWorkforcemanagementAlternativeshiftsTrade produces: - application/json parameters: - name: tradeId in: path description: The ID of the alternative shift trade required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AlternativeShiftTradeResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentAlternativeShift:submit x-purecloud-method-name: getWorkforcemanagementAlternativeshiftsTrade patch: tags: - Workforce Management summary: Update my alternative shifts trade by trade ID description: '' operationId: patchWorkforcemanagementAlternativeshiftsTrade produces: - application/json parameters: - name: tradeId in: path description: The ID of the alternative shift trade required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/AgentUpdateAlternativeShiftTradeRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AlternativeShiftTradeResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:agentAlternativeShift:submit x-purecloud-method-name: patchWorkforcemanagementAlternativeshiftsTrade /api/v2/workforcemanagement/alternativeshifts/trades/state/jobs: patch: tags: - Workforce Management summary: Bulk update alternative shift trade states description: '' operationId: patchWorkforcemanagementAlternativeshiftsTradesStateJobs produces: - application/json parameters: - in: body name: body description: The request body required: true schema: $ref: '#/definitions/AdminBulkUpdateAlternativeShiftTradeStateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AlternativeShiftAsyncResponse' '202': description: The bulk update trade state request is processing schema: $ref: '#/definitions/AlternativeShiftAsyncResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:alternativeShift:edit x-purecloud-method-name: patchWorkforcemanagementAlternativeshiftsTradesStateJobs /api/v2/workforcemanagement/alternativeshifts/trades/state/jobs/{jobId}: get: tags: - Workforce Management summary: Query the status of an alternative shift trade state operation. Only the user who started the operation can query the status description: Job details are only retained if the initial request returned a 202 ACCEPTED response operationId: getWorkforcemanagementAlternativeshiftsTradesStateJob produces: - application/json parameters: - name: jobId in: path description: The ID of the job required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AlternativeShiftJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:alternativeShift:edit x-purecloud-method-name: getWorkforcemanagementAlternativeshiftsTradesStateJob /api/v2/workforcemanagement/calendar/url/ics: get: tags: - Workforce Management summary: Get existing calendar link for the current user description: '' operationId: getWorkforcemanagementCalendarUrlIcs produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/CalendarUrlResponse' '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. wfm.external.calendar.entity.not.found: The requested calendar entity 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ALL permissions: - wfm:agentSchedule:sync - wfm:agentSchedule:view x-purecloud-method-name: getWorkforcemanagementCalendarUrlIcs post: tags: - Workforce Management summary: Create a newly generated calendar link for the current user; if the current user has previously generated one, the generated link will be returned description: '' operationId: postWorkforcemanagementCalendarUrlIcs produces: - application/json parameters: - name: language in: query description: A language tag (which is sometimes referred to as a "locale identifier") to use to localize default activity code names in the ics-formatted calendar required: false type: string default: en-US x-example: en-US responses: '200': description: successful operation schema: $ref: '#/definitions/CalendarUrlResponse' '201': description: '' schema: $ref: '#/definitions/CalendarUrlResponse' '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: - workforce-management x-inin-requires-permissions: type: ALL permissions: - wfm:agentSchedule:sync - wfm:agentSchedule:view x-purecloud-method-name: postWorkforcemanagementCalendarUrlIcs delete: tags: - Workforce Management summary: Disable generated calendar link for the current user description: '' operationId: deleteWorkforcemanagementCalendarUrlIcs produces: - application/json parameters: [] 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. '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: - workforce-management x-inin-requires-permissions: type: ALL permissions: - wfm:agentSchedule:sync x-purecloud-method-name: deleteWorkforcemanagementCalendarUrlIcs /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}: get: tags: - Workforce Management summary: Get a capacity plan description: '' operationId: getWorkforcemanagementBusinessunitCapacityplan produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: capacityPlanId in: path description: The ID of the capacity plan required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CapacityPlanResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:capacityPlan:view x-purecloud-method-name: getWorkforcemanagementBusinessunitCapacityplan patch: tags: - Workforce Management summary: Update a capacity plan configuration description: '' operationId: patchWorkforcemanagementBusinessunitCapacityplan produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: capacityPlanId in: path description: The ID of the capacity plan required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/UpdateCapacityPlanRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/CapacityPlanResponse' '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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:capacityPlan:edit x-purecloud-method-name: patchWorkforcemanagementBusinessunitCapacityplan /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans: get: tags: - Workforce Management summary: Get list of capacity plans for a business unit description: '' operationId: getWorkforcemanagementBusinessunitCapacityplans produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CapacityPlansListResponse' '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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:capacityPlan:view x-purecloud-method-name: getWorkforcemanagementBusinessunitCapacityplans post: tags: - Workforce Management summary: Create a new capacity plan description: '' operationId: postWorkforcemanagementBusinessunitCapacityplans produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/CapacityPlanRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/CapacityPlanResponse' '201': description: The capacity plan was successfully created schema: $ref: '#/definitions/CapacityPlanResponse' '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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:capacityPlan:add x-purecloud-method-name: postWorkforcemanagementBusinessunitCapacityplans /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/bulk/remove: post: tags: - Workforce Management summary: Delete capacity plans in a business unit description: '' operationId: postWorkforcemanagementBusinessunitCapacityplansBulkRemove produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/CapacityPlanDeleteRequest' responses: '204': description: The capacity plans were 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.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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:capacityPlan:delete x-purecloud-method-name: postWorkforcemanagementBusinessunitCapacityplansBulkRemove /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocations: get: tags: - Workforce Management summary: Get a capacity plan's staffing group allocations description: '' operationId: getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: capacityPlanId in: path description: The ID of the capacity plan required: true type: string - name: granularity in: query description: Granularity to access staffing group data, defaults to weekly required: false type: string enum: - weekly - monthly responses: '200': description: successful operation schema: $ref: '#/definitions/CapacityPlanStaffingGroupAllocationsResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:capacityPlan:view x-purecloud-method-name: getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations post: tags: - Workforce Management summary: Create staffing group allocations for a capacity plan description: '' operationId: postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: capacityPlanId in: path description: The ID of the capacity plan required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/CreateCapacityPlanStaffingGroupMetricChangeRequest' responses: '201': description: The capacity plan staffing group allocations was successfully created schema: $ref: '#/definitions/CapacityPlanStaffingGroupMetricChangeResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:capacityPlan:edit x-purecloud-method-name: postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffingrequirements: get: tags: - Workforce Management summary: Get a capacity plan's staffing requirements description: '' operationId: getWorkforcemanagementBusinessunitCapacityplanStaffingrequirements produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: capacityPlanId in: path description: The ID of the capacity plan required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CapacityPlanStaffingRequirementResult' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:capacityPlan:view x-purecloud-method-name: getWorkforcemanagementBusinessunitCapacityplanStaffingrequirements /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/copy: post: tags: - Workforce Management summary: Copy a capacity plan description: '' operationId: postWorkforcemanagementBusinessunitCapacityplanCopy produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: capacityPlanId in: path description: The ID of the capacity plan required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/CopyCapacityPlanRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/CapacityPlanResponse' '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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:capacityPlan:add x-purecloud-method-name: postWorkforcemanagementBusinessunitCapacityplanCopy /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/requirement/generate: post: tags: - Workforce Management summary: Regenerate requirements for capacity plan description: '' operationId: postWorkforcemanagementBusinessunitCapacityplanRequirementGenerate produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: capacityPlanId in: path description: The ID of the capacity plan required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CapacityPlanStaffingRequirementResult' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:capacityPlan:edit x-purecloud-method-name: postWorkforcemanagementBusinessunitCapacityplanRequirementGenerate ? /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocationshistory/query : post: tags: - Workforce Management summary: Query staffing groups allocations history for a capacity plan description: '' operationId: postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: capacityPlanId in: path description: The ID of the capacity plan required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/QueryCapacityPlanStaffingGroupMetricChangeHistory' responses: '200': description: Success schema: $ref: '#/definitions/CapacityPlanStaffingGroupMetricChangeHistoryListResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:capacityPlan:view x-purecloud-method-name: postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocationshistory: delete: tags: - Workforce Management summary: Delete staffing group allocations history created for a capacity plan before the given date description: '' operationId: deleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistory produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: capacityPlanId in: path description: The ID of the capacity plan required: true type: string - name: beforeDateId in: query description: 'The date to delete records that are created on or before this date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: false type: string format: date responses: '204': description: The capacity plan staffing group allocations were 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 wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details '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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:capacityPlan:edit x-purecloud-method-name: deleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistory /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/forecast: get: tags: - Workforce Management summary: Get a capacity plan's forecast inputs description: '' operationId: getWorkforcemanagementBusinessunitCapacityplanForecast produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: capacityPlanId in: path description: The ID of the capacity plan required: true type: string - name: granularity in: query description: Granularity to access capacity plan forecast data, defaults to weekly required: false type: string enum: - weekly - monthly responses: '200': description: successful operation schema: $ref: '#/definitions/CapacityPlanForecastInputsResponse' '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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:capacityPlanForecastInputs:view x-purecloud-method-name: getWorkforcemanagementBusinessunitCapacityplanForecast ? /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplanning/longtermrequirements/automaticbestmethod/weeks/{weekDateId}/forecasts/{forecastId} : get: tags: - Workforce Management summary: Get the latest long term staffing requirements for a business unit description: '' operationId: getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast produces: - application/json parameters: - name: businessUnitId in: path required: true type: string - name: weekDateId in: path description: 'weekDateId of forecast, format yyyy-MM-dd. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: forecastId in: path description: forecastId of forecast required: true type: string - name: granularity in: query description: Granularity to access staffing requirements data, defaults to weekly required: false type: string enum: - weekly - monthly responses: '200': description: successful operation schema: $ref: '#/definitions/LongTermRequirementsResponse' '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: wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:longTermStaffing:view x-purecloud-method-name: getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast ? /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplanning/longtermrequirements/automaticbestmethod/weeks/{weekDateId}/forecasts/{forecastId}/forceregenerate : post: tags: - Workforce Management summary: Force regenerate the latest long term staffing requirements for a business unit description: '' operationId: postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate produces: - application/json parameters: - name: businessUnitId in: path required: true type: string - name: weekDateId in: path description: 'weekDateId of forecast, format yyyy-MM-dd. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: forecastId in: path description: forecastId of forecast required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/LongTermRequirementsResponse' '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: wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:longTermStaffing:edit x-purecloud-method-name: postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate /api/v2/workforcemanagement/schedulebids: get: tags: - Workforce Management summary: Gets the list of schedule bids that belong to an agent. It will fetch an open bid or upcoming bid or a bid that is closed recently description: '' operationId: getWorkforcemanagementSchedulebids produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/AgentScheduleBids' '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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentScheduleBid:submit x-purecloud-method-name: getWorkforcemanagementSchedulebids /api/v2/workforcemanagement/schedulebids/{bidId}/preference: get: tags: - Workforce Management summary: Gets an agent's schedule bidding preference description: '' operationId: getWorkforcemanagementSchedulebidPreference produces: - application/json parameters: - name: bidId in: path description: The ID of the schedule bid required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AgentScheduleBiddingPreferenceResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentScheduleBid:submit x-purecloud-method-name: getWorkforcemanagementSchedulebidPreference put: tags: - Workforce Management summary: Update an agent's schedule set preference description: '' operationId: putWorkforcemanagementSchedulebidPreference consumes: - application/json produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/UpdateAgentScheduleBiddingPreference' - name: bidId in: path description: The ID of the schedule bid required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AgentScheduleBiddingPreferenceResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:agentScheduleBid:submit x-purecloud-method-name: putWorkforcemanagementSchedulebidPreference /api/v2/workforcemanagement/schedulebids/{bidId}/schedulesets: get: tags: - Workforce Management summary: Gets an agent's schedule sets for a bid description: '' operationId: getWorkforcemanagementSchedulebidSchedulesets produces: - application/json parameters: - name: bidId in: path description: The ID of the schedule bid required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AgentScheduleBidScheduleSetResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentScheduleBid:submit x-purecloud-method-name: getWorkforcemanagementSchedulebidSchedulesets /api/v2/workforcemanagement/timeofflimits/available/query: post: tags: - Workforce Management summary: Queries available time off for the current user description: '' operationId: postWorkforcemanagementTimeofflimitsAvailableQuery produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/AvailableTimeOffRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AvailableTimeOffResponse' '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. wfm.configuration.conflict: The request failed due to existing configuration conflict invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentTimeOffRequest:submit x-purecloud-method-name: postWorkforcemanagementTimeofflimitsAvailableQuery /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions: get: tags: - Workforce Management summary: Get the daily waitlist positions of a time off request for the current user description: '' operationId: getWorkforcemanagementTimeoffrequestWaitlistpositions produces: - application/json parameters: - name: timeOffRequestId in: path description: The ID of the time off request required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WaitlistPositionListing' '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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentTimeOffRequest:submit x-purecloud-method-name: getWorkforcemanagementTimeoffrequestWaitlistpositions /api/v2/workforcemanagement/timeoffrequests: get: tags: - Workforce Management summary: Get a list of time off requests for the current user description: '' operationId: getWorkforcemanagementTimeoffrequests produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffRequestList' '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: wfm.server.error: WFM Server Error internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentSchedule:view - wfm:agentTimeOffRequest:submit x-purecloud-method-name: getWorkforcemanagementTimeoffrequests post: tags: - Workforce Management summary: Create a time off request for the current user description: '' operationId: postWorkforcemanagementTimeoffrequests produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/CreateAgentTimeOffRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffRequestResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:agentTimeOffRequest:submit x-purecloud-method-name: postWorkforcemanagementTimeoffrequests /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}: get: tags: - Workforce Management summary: Get a time off request for the current user description: '' operationId: getWorkforcemanagementTimeoffrequest produces: - application/json parameters: - name: timeOffRequestId in: path description: The ID of the time off request required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffRequestResponse' '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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentSchedule:view - wfm:agentTimeOffRequest:submit x-purecloud-method-name: getWorkforcemanagementTimeoffrequest patch: tags: - Workforce Management summary: Update a time off request for the current user description: '' operationId: patchWorkforcemanagementTimeoffrequest produces: - application/json parameters: - name: timeOffRequestId in: path description: The ID of the time off request required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/AgentTimeOffRequestPatch' responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffRequestResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:agentTimeOffRequest:submit x-purecloud-method-name: patchWorkforcemanagementTimeoffrequest /api/v2/workforcemanagement/unavailabletimes: patch: tags: - Workforce Management summary: Update agent unavailable times description: '' operationId: patchWorkforcemanagementUnavailabletimes produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/UpdateUnavailableTimesRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/UnavailableTimeListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:agentUnavailableTimes:submit x-purecloud-method-name: patchWorkforcemanagementUnavailabletimes /api/v2/workforcemanagement/unavailabletimes/validation/jobs: post: tags: - Workforce Management summary: Validates proposed changes to an agent's unavailable time spans against scheduling rules and constraints for a specific week description: '' operationId: postWorkforcemanagementUnavailabletimesValidationJobs produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/ValidateAgentUnavailableTimesRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ValidateAgentUnavailableTimesResponse' '202': description: The validation request is processing schema: $ref: '#/definitions/ValidateAgentUnavailableTimesResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentUnavailableTimes:submit x-purecloud-method-name: postWorkforcemanagementUnavailabletimesValidationJobs /api/v2/workforcemanagement/unavailabletimes/query: post: tags: - Workforce Management summary: Get agent unavailable times description: '' operationId: postWorkforcemanagementUnavailabletimesQuery produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/QueryAgentUnavailableTimesRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/UnavailableTimeListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentUnavailableTimes:submit x-purecloud-method-name: postWorkforcemanagementUnavailabletimesQuery /api/v2/workforcemanagement/unavailabletimes/settings: get: tags: - Workforce Management summary: Get availability management unit's settings for agent description: '' operationId: getWorkforcemanagementUnavailabletimesSettings produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/ManagementUnitAvailabilitySettingsResponse' '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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentUnavailableTimes:submit x-purecloud-method-name: getWorkforcemanagementUnavailabletimesSettings /api/v2/workforcemanagement/unavailabletimes/validation/jobs/{jobId}: get: tags: - Workforce Management summary: Query agent unavailable times validation job description: '' operationId: getWorkforcemanagementUnavailabletimesValidationJob produces: - application/json parameters: - name: jobId in: path description: The ID of the job required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/QueryAgentUnavailableTimesValidationJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentUnavailableTimes:submit x-purecloud-method-name: getWorkforcemanagementUnavailabletimesValidationJob /api/v2/workforcemanagement/workplanbids/{bidId}/preferences: get: tags: - Workforce Management summary: Gets an agent's work plan bidding preference description: '' operationId: getWorkforcemanagementWorkplanbidPreferences produces: - application/json parameters: - name: bidId in: path description: The ID of the work plan bid required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AgentWorkPlanBiddingPreferenceResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentWorkPlanBid:submit x-purecloud-method-name: getWorkforcemanagementWorkplanbidPreferences patch: tags: - Workforce Management summary: Update an agent's work plan bidding preference description: '' operationId: patchWorkforcemanagementWorkplanbidPreferences produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/UpdateAgentWorkPlanBiddingPreference' - name: bidId in: path description: The ID of the work plan bid required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AgentWorkPlanBiddingPreferenceResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:agentWorkPlanBid:submit x-purecloud-method-name: patchWorkforcemanagementWorkplanbidPreferences /api/v2/workforcemanagement/workplanbids/{bidId}/workplans: get: tags: - Workforce Management summary: Gets an agent's work plans for a bid description: '' operationId: getWorkforcemanagementWorkplanbidWorkplans produces: - application/json parameters: - name: bidId in: path description: The ID of the work plan bid required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AgentWorkPlanListResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentWorkPlanBid:submit x-purecloud-method-name: getWorkforcemanagementWorkplanbidWorkplans /api/v2/workforcemanagement/workplanbids: get: tags: - Workforce Management summary: Gets the list of work plan bids that belong to an agent description: '' operationId: getWorkforcemanagementWorkplanbids produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/AgentWorkPlanBids' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: Agent work plan preference 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentWorkPlanBid:submit x-purecloud-method-name: getWorkforcemanagementWorkplanbids /api/v2/workforcemanagement/alternativeshifts/settings: get: tags: - Workforce Management summary: Get alternative shifts settings from the current logged in agent’s business unit description: '' operationId: getWorkforcemanagementAlternativeshiftsSettings produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/AlternativeShiftBuSettingsResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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: wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentAlternativeShift:submit x-purecloud-method-name: getWorkforcemanagementAlternativeshiftsSettings /api/v2/workforcemanagement/agentschedules/mine: post: tags: - Workforce Management summary: Get published schedule for the current user description: '' operationId: postWorkforcemanagementAgentschedulesMine produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/BuGetCurrentAgentScheduleRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BuCurrentAgentScheduleSearchResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentSchedule:view x-purecloud-method-name: postWorkforcemanagementAgentschedulesMine /api/v2/workforcemanagement/agentschedules/managementunits/mine: post: tags: - Workforce Management summary: Fetch agent schedules for the logged in user's management unit description: '' operationId: postWorkforcemanagementAgentschedulesManagementunitsMine produces: - application/json parameters: - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean - in: body name: body description: body required: true schema: $ref: '#/definitions/AgentMuScheduleQuery' responses: '200': description: successful operation schema: $ref: '#/definitions/AgentMuQueryResponse' '202': description: The schedule query is processing schema: $ref: '#/definitions/AgentMuQueryResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentManagementUnitSchedule:view x-purecloud-method-name: postWorkforcemanagementAgentschedulesManagementunitsMine /api/v2/workforcemanagement/schedules: post: tags: - Workforce Management summary: Get published schedule for the current user description: '' operationId: postWorkforcemanagementSchedules produces: - application/json parameters: - in: body name: body description: body required: false schema: $ref: '#/definitions/CurrentUserScheduleRequestBody' responses: '200': description: successful operation schema: $ref: '#/definitions/UserScheduleContainer' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management deprecated: true x-inin-requires-permissions: type: ANY permissions: - wfm:agentSchedule:view x-purecloud-method-name: postWorkforcemanagementSchedules /api/v2/workforcemanagement/shifttrades: get: tags: - Workforce Management summary: Gets all of my shift trades description: Deprecated. Use new route instead (/shifttrading/trades/mine/query/jobs) operationId: getWorkforcemanagementShifttrades produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeListResponse' '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: - workforce-management - workforce-management:readonly deprecated: true x-inin-requires-permissions: type: ANY permissions: - wfm:shiftTradeRequest:edit - wfm:shiftTradeRequest:view - wfm:agentShiftTradeRequest:participate x-purecloud-method-name: getWorkforcemanagementShifttrades /api/v2/workforcemanagement/timeoffrequests/integrationstatus/query: post: tags: - Workforce Management summary: Retrieves integration statuses for a list of current user time off requests description: '' operationId: postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/CurrentUserTimeOffIntegrationStatusRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffIntegrationStatusResponseListing' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: The user is not in a management unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentTimeOffRequest:submit x-purecloud-method-name: postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery /api/v2/workforcemanagement/notifications: get: tags: - Workforce Management summary: Get a list of notifications for the current user description: Notifications are only initially sent if you have the relevant Notify and Edit permissions operationId: getWorkforcemanagementNotifications produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/NotificationsResponse' '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: - workforce-management - workforce-management:readonly x-purecloud-method-name: getWorkforcemanagementNotifications /api/v2/workforcemanagement/notifications/update: post: tags: - Workforce Management summary: Mark a list of notifications as read or unread description: '' operationId: postWorkforcemanagementNotificationsUpdate produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/UpdateNotificationsRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/UpdateNotificationsResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: - workforce-management x-purecloud-method-name: postWorkforcemanagementNotificationsUpdate /api/v2/workforcemanagement/historicaldata/bulk/remove/jobs/{jobId}: get: tags: - Workforce Management summary: Retrieves delete job status for historical data imports associated with the job id description: '' operationId: getWorkforcemanagementHistoricaldataBulkRemoveJob produces: - application/json parameters: - name: jobId in: path description: The job ID of the historical data delete request required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/HistoricalImportDeleteFilesJobResponse' '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: Invalid status. '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 job could not be 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ALL permissions: - wfm:historicalData:upload x-purecloud-method-name: getWorkforcemanagementHistoricaldataBulkRemoveJob /api/v2/workforcemanagement/historicaldata/bulk/remove/jobs: get: tags: - Workforce Management summary: Retrieves all delete job status for historical data description: '' operationId: getWorkforcemanagementHistoricaldataBulkRemoveJobs produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/HistoricalImportOverallDeleteStatusResponse' '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: Invalid status. '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: No historical data delete request was 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ALL permissions: - wfm:historicalData:upload x-purecloud-method-name: getWorkforcemanagementHistoricaldataBulkRemoveJobs post: tags: - Workforce Management summary: Delete the list of the historical data import entries description: '' operationId: postWorkforcemanagementHistoricaldataBulkRemoveJobs produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/HistoricalImportDeleteFilesJobRequest' responses: '202': description: Delete job is accepted. Try using get API to get the status. schema: $ref: '#/definitions/HistoricalImportDeleteFilesJobResponse' '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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ALL permissions: - wfm:historicalData:upload x-purecloud-method-name: postWorkforcemanagementHistoricaldataBulkRemoveJobs /api/v2/workforcemanagement/historicaldata/importstatus/{jobId}: get: tags: - Workforce Management summary: Retrieves status of the historical data imports associated with job id description: '' operationId: getWorkforcemanagementHistoricaldataImportstatusJobId produces: - application/json parameters: - name: jobId in: path description: The job Id of the historical data import request required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/HistoricalImportStatusJobResponse' '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: Invalid status. '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 job could not be 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ALL permissions: - wfm:historicalData:upload x-purecloud-method-name: getWorkforcemanagementHistoricaldataImportstatusJobId /api/v2/workforcemanagement/historicaldata/importstatus: get: tags: - Workforce Management summary: Retrieves status of the historical data imports of the organization description: '' operationId: getWorkforcemanagementHistoricaldataImportstatus produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/HistoricalImportStatusListing' '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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ALL permissions: - wfm:historicalData:upload x-purecloud-method-name: getWorkforcemanagementHistoricaldataImportstatus /api/v2/workforcemanagement/historicaldata/validate: post: tags: - Workforce Management summary: Trigger validation process for historical import description: '' operationId: postWorkforcemanagementHistoricaldataValidate produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/ValidationServiceRequest' responses: '202': description: Accepted - Triggering validation process. schema: $ref: '#/definitions/ValidationServiceAsyncResponse' '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. general.bad.request: The request could not be processed due to invalid request data. 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. wfm.historical.running.request: Another request from organization is in progress. '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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ALL permissions: - wfm:historicalData:upload x-purecloud-method-name: postWorkforcemanagementHistoricaldataValidate /api/v2/workforcemanagement/agents/integrations/hris/query: post: tags: - Workforce Management summary: Query integrations for agents description: '' operationId: postWorkforcemanagementAgentsIntegrationsHrisQuery produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/QueryAgentsIntegrationsRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AgentsIntegrationsListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agent:view x-purecloud-method-name: postWorkforcemanagementAgentsIntegrationsHrisQuery /api/v2/workforcemanagement/agents/{agentId}/integrations/hris: put: tags: - Workforce Management summary: Update integrations for agent description: '' operationId: putWorkforcemanagementAgentIntegrationsHris produces: - application/json parameters: - name: agentId in: path description: The ID of the agent required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/AgentIntegrationsRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AgentIntegrationsResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.bad.request: The request failed validation 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. user.ids.not.found: One of the requested resources in the path variables was not found, please check the error details for more information '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:agent:edit x-purecloud-method-name: putWorkforcemanagementAgentIntegrationsHris /api/v2/workforcemanagement/integrations/hris/timeofftypes/jobs/{jobId}: get: tags: - Workforce Management summary: Query the results of time off types job description: '' operationId: getWorkforcemanagementIntegrationsHrisTimeofftypesJob produces: - application/json parameters: - name: jobId in: path description: The ID of the job. required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/HrisTimeOffTypesJobResponse' '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: wfm.entity.not.found: The job with the requested ID was 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: - workforce-management - workforce-management:readonly x-purecloud-method-name: getWorkforcemanagementIntegrationsHrisTimeofftypesJob /api/v2/workforcemanagement/integrations/hris: get: tags: - Workforce Management summary: Get integrations description: '' operationId: getWorkforcemanagementIntegrationsHris produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/WfmIntegrationListing' '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: wfm.server.error: WFM Server Error internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:integration:view x-purecloud-method-name: getWorkforcemanagementIntegrationsHris /api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs: post: tags: - Workforce Management summary: Get list of time off types configured in integration description: '' operationId: postWorkforcemanagementIntegrationsHriTimeofftypesJobs produces: - application/json parameters: - name: hrisIntegrationId in: path description: The ID of the HRIS integration for which time off types are queried. required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/HrisTimeOffTypesResponse' '202': description: The time off types query is processing schema: $ref: '#/definitions/HrisTimeOffTypesResponse' '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: wfm.entity.not.found: The integration was 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:integration:view x-purecloud-method-name: postWorkforcemanagementIntegrationsHriTimeofftypesJobs /api/v2/workforcemanagement/businessunits/{businessUnitId}/minimumstaffing/settings: get: tags: - Workforce Management summary: Get minimum staffing settings for a business unit description: '' operationId: getWorkforcemanagementBusinessunitMinimumstaffingSettings produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/MinimumStaffingResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:minimumStaffingSettings:view x-purecloud-method-name: getWorkforcemanagementBusinessunitMinimumstaffingSettings patch: tags: - Workforce Management summary: Update minimum staffing settings for a business unit description: '' operationId: patchWorkforcemanagementBusinessunitMinimumstaffingSettings produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/MinimumStaffingRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/MinimumStaffingResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:minimumStaffingSettings:edit x-purecloud-method-name: patchWorkforcemanagementBusinessunitMinimumstaffingSettings /api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/add: post: tags: - Workforce Management summary: Bulk add enrollments to opportunities for the authenticated agent description: Allows an agent to enroll in opportunities. This endpoint can return partial success. operationId: postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd consumes: - application/json produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/AgentBulkAddOpportunityEnrollmentsRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AgentBulkAddOpportunityEnrollmentsResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:agentOpportunitiesEnrollments:add x-purecloud-method-name: postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd /api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/statuses/update: post: tags: - Workforce Management summary: Bulk update enrollment status for the authenticated agent description: Allows an agent to update the status of their enrollments (e.g. withdraw). Returns partial success if some enrollments cannot be updated. operationId: postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate consumes: - application/json produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/AgentBulkStatusUpdateOpportunityEnrollmentsRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AgentBulkStatusUpdateOpportunityEnrollmentsResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:agentOpportunitiesEnrollmentsStatuses:edit x-purecloud-method-name: postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate /api/v2/workforcemanagement/agents/opportunities/query: post: tags: - Workforce Management summary: Query opportunities for the authenticated agent description: Queries within the specified date range. Each opportunity includes the agent's enrollment details if they have enrolled. operationId: postWorkforcemanagementAgentsOpportunitiesQuery consumes: - application/json produces: - application/json parameters: - name: expand in: query description: List of resources to expand required: false type: string enum: - enrollment - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean - in: body name: body description: body required: true schema: $ref: '#/definitions/QueryOpportunitiesRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AgentQueryOpportunitiesResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentOpportunitiesQuery:view x-purecloud-method-name: postWorkforcemanagementAgentsOpportunitiesQuery /api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/bulk/statuses/update: post: tags: - Workforce Management summary: Bulk update enrollment status description: Updates the status of enrollments (approve/deny). Returns partial success if some enrollments cannot be updated. operationId: postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/BulkOpportunityEnrollmentsStatusUpdateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BulkUpdateOpportunityEnrollmentsStatusResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:opportunitiesEnrollmentsStatuses:edit x-purecloud-method-name: postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate /api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/query: post: tags: - Workforce Management summary: Query enrollments description: For more information about opportunities, use the expand parameter. operationId: postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: expand in: query description: List of resources to expand required: false type: string enum: - opportunities - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean - in: body name: body description: body required: true schema: $ref: '#/definitions/QueryOpportunityEnrollmentsRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/QueryOpportunityEnrollmentsResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:opportunitiesEnrollmentsQuery:view x-purecloud-method-name: postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery /api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/query: post: tags: - Workforce Management summary: Query opportunities within the specified date range description: '' operationId: postWorkforcemanagementBusinessunitOpportunitiesQuery consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean - in: body name: body description: body required: true schema: $ref: '#/definitions/QueryOpportunitiesRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/QueryOpportunitiesResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:opportunitiesQuery:view x-purecloud-method-name: postWorkforcemanagementBusinessunitOpportunitiesQuery /api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/externalactivities/query: post: tags: - Workforce Management summary: Query opportunities by external activity IDs description: '' operationId: postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/BulkOpportunitiesExternalActivitiesRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/QueryExternalActivityOpportunitiesResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:opportunitiesExternalActivitiesQuery:view x-purecloud-method-name: postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery /api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/add: post: tags: - Workforce Management summary: Bulk add opportunities description: '' operationId: postWorkforcemanagementBusinessunitOpportunitiesBulkAdd consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/BulkAddOpportunitiesRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BulkAddOpportunitiesResponse' '201': description: Opportunities added successfully schema: $ref: '#/definitions/BulkAddOpportunitiesResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:opportunities:add x-purecloud-method-name: postWorkforcemanagementBusinessunitOpportunitiesBulkAdd /api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/remove: post: tags: - Workforce Management summary: Bulk remove opportunities description: This operation is permanent and cannot be undone. Returns partial success if some opportunities cannot be removed. operationId: postWorkforcemanagementBusinessunitOpportunitiesBulkRemove consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/BulkOpportunitiesRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BulkRemoveOpportunitiesResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:opportunities:delete x-purecloud-method-name: postWorkforcemanagementBusinessunitOpportunitiesBulkRemove /api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/publish: post: tags: - Workforce Management summary: Bulk publish opportunities description: Published opportunities become available for agent enrollment when they open. Returns partial success if some opportunities cannot be published. operationId: postWorkforcemanagementBusinessunitOpportunitiesBulkPublish consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/BulkOpportunitiesRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BulkPublishOpportunitiesResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:opportunities:publish x-purecloud-method-name: postWorkforcemanagementBusinessunitOpportunitiesBulkPublish /api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/statuses/update: post: tags: - Workforce Management summary: Bulk update opportunities status description: If status is Closed, pending enrollments are automatically denied; approved enrollments remain in schedules. Returns partial success if some opportunities cannot be updated. operationId: postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/BulkOpportunitiesStatusUpdateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BulkOpportunitiesStatusUpdateResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:opportunitiesStatuses:edit x-purecloud-method-name: postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate /api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}: get: tags: - Workforce Management summary: Get opportunity details description: '' operationId: getWorkforcemanagementBusinessunitOpportunity produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: opportunityId in: path description: The ID of the opportunity required: true type: string - name: expand in: query description: List of resources to expand required: false type: string enum: - agentIds responses: '200': description: successful operation schema: $ref: '#/definitions/OpportunityResultWithAgentIds' '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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:opportunity:view x-purecloud-method-name: getWorkforcemanagementBusinessunitOpportunity patch: tags: - Workforce Management summary: Update the opportunity description: Only opportunities with Draft status can be updated. operationId: patchWorkforcemanagementBusinessunitOpportunity consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: opportunityId in: path description: The ID of the opportunity required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/PatchOpportunityRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/OpportunityResult' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:opportunity:edit x-purecloud-method-name: patchWorkforcemanagementBusinessunitOpportunity ? /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations : post: tags: - Workforce Management summary: Request a daily recalculation of the performance prediction for the associated schedule description: '' operationId: postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit to which the performance prediction belongs required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/WfmProcessUploadRequest' - name: weekId in: path description: First day of schedule week in yyyy-MM-dd format required: true type: string - name: scheduleId in: path description: The ID of the schedule the performance prediction belongs to required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/PerformancePredictionRecalculationResponse' '202': description: Request Accepted schema: $ref: '#/definitions/PerformancePredictionRecalculationResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.only.authorized.for.team.access: The user is only authorized to call this route for specific teams 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' wfm.missing.team.permissions: You must have access to the requested teams 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: wfm.business.unit.not.found: Business unit 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:edit x-purecloud-method-name: postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations ? /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/{recalculationId} : get: tags: - Workforce Management summary: Get recalculated performance prediction result description: '' operationId: getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit to which the performance prediction belongs required: true type: string - name: weekId in: path description: First day of schedule week in yyyy-MM-dd format required: true type: string - name: scheduleId in: path description: The ID of the schedule the recalculation belongs to required: true type: string - name: recalculationId in: path description: The ID of the recalculation request required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/PerformancePredictionRecalculationResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.only.authorized.for.team.access: The user is only authorized to call this route for specific teams 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' wfm.missing.team.permissions: You must have access to the requested teams 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: wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:view - wfm:publishedSchedule:view x-purecloud-method-name: getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions: get: tags: - Workforce Management summary: Get the performance prediction for the associated schedule description: '' operationId: getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit to which the performance prediction belongs required: true type: string - name: weekId in: path description: First day of schedule week in yyyy-MM-dd format required: true type: string - name: scheduleId in: path description: The ID of the schedule the performance prediction belongs to required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/PerformancePredictionResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.only.authorized.for.team.access: The user is only authorized to call this route for specific teams 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' wfm.missing.team.permissions: You must have access to the requested teams 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: wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:view - wfm:publishedSchedule:view x-purecloud-method-name: getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions ? /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/uploadurl : post: tags: - Workforce Management summary: Upload daily activity changes to be able to request a performance prediction recalculation description: '' operationId: postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit to which the performance prediction belongs required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/UploadUrlRequestBody' - name: weekId in: path description: First day of schedule week in yyyy-MM-dd format required: true type: string - name: scheduleId in: path description: The ID of the schedule the performance prediction belongs to required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/PerformancePredictionRecalculationUploadResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.only.authorized.for.team.access: The user is only authorized to call this route for specific teams 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' wfm.missing.team.permissions: You must have access to the requested teams 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: wfm.business.unit.not.found: Business unit 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:edit x-purecloud-method-name: postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/summary: get: tags: - Workforce Management summary: Get summary of bid groups that belong to a schedule bid description: '' operationId: getWorkforcemanagementBusinessunitSchedulebidGroupsSummary produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The ID of the schedule bid associated with the bid groups required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ScheduleBidGroupSummaryList' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:scheduleBidGroup:view x-purecloud-method-name: getWorkforcemanagementBusinessunitSchedulebidGroupsSummary /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}: get: tags: - Workforce Management summary: Get a schedule bid group description: '' operationId: getWorkforcemanagementBusinessunitSchedulebidGroup produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The ID of the schedule bid associated with the bid groups required: true type: string - name: bidGroupId in: path description: Schedule Bid Group id required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ScheduleBidGroupResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:scheduleBidGroup:view x-purecloud-method-name: getWorkforcemanagementBusinessunitSchedulebidGroup delete: tags: - Workforce Management summary: Delete a schedule bid group by bid group Id description: '' operationId: deleteWorkforcemanagementBusinessunitSchedulebidGroup consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The ID of the schedule bid associated with the bid groups required: true type: string - name: bidGroupId in: path description: Schedule Bid Group id required: true type: string responses: '204': description: The bid group was 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 wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details '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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:scheduleBidGroup:delete x-purecloud-method-name: deleteWorkforcemanagementBusinessunitSchedulebidGroup patch: tags: - Workforce Management summary: Update a schedule bid group by bid group Id description: '' operationId: patchWorkforcemanagementBusinessunitSchedulebidGroup consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The ID of the schedule bid associated with the bid groups required: true type: string - name: bidGroupId in: path description: Schedule Bid Group id required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/ScheduleBidGroupUpdate' responses: '200': description: successful operation schema: $ref: '#/definitions/ScheduleBidGroupResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:scheduleBidGroup:edit x-purecloud-method-name: patchWorkforcemanagementBusinessunitSchedulebidGroup /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups: post: tags: - Workforce Management summary: Add a bid group in a given schedule bid description: '' operationId: postWorkforcemanagementBusinessunitSchedulebidGroups produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The ID of the schedule bid associated with the bid groups required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/ScheduleBidGroupCreate' responses: '200': description: successful operation schema: $ref: '#/definitions/ScheduleBidGroupResponse' '201': description: The schedule bid group was successfully created schema: $ref: '#/definitions/ScheduleBidGroupResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:scheduleBidGroup:add x-purecloud-method-name: postWorkforcemanagementBusinessunitSchedulebidGroups /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}/preferences: get: tags: - Workforce Management summary: Get agents schedule bid preferences for a bid group description: '' operationId: getWorkforcemanagementBusinessunitSchedulebidGroupPreferences produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The ID of the schedule bid associated with the bid groups required: true type: string - name: bidGroupId in: path description: The ID of the schedule bid group required: true type: string - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean - name: expand in: query description: Include to fetch agents' preferences with priorities required: false type: array items: type: string enum: - agentsScheduleBidPreferences.agentScheduleBidPreferencePriorities collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/AdminAgentScheduleBidPreferenceResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:scheduleBidGroup:view x-purecloud-method-name: getWorkforcemanagementBusinessunitSchedulebidGroupPreferences patch: tags: - Workforce Management summary: Overrides the assigned schedule bid for the specified agents description: '' operationId: patchWorkforcemanagementBusinessunitSchedulebidGroupPreferences consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The ID of the schedule bid associated with the bid groups required: true type: string - name: bidGroupId in: path description: The ID of the schedule bid group required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/AgentsBidAssignedScheduleSetOverrideRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AdminAgentScheduleBidPreferenceResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:scheduleBidGroup:edit x-purecloud-method-name: patchWorkforcemanagementBusinessunitSchedulebidGroupPreferences /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}: get: tags: - Workforce Management summary: Get a schedule bid description: '' operationId: getWorkforcemanagementBusinessunitSchedulebid produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The ID of the schedule bid required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ScheduleBid' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:scheduleBid:view x-purecloud-method-name: getWorkforcemanagementBusinessunitSchedulebid delete: tags: - Workforce Management summary: Delete a schedule bid description: '' operationId: deleteWorkforcemanagementBusinessunitSchedulebid consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The ID of the schedule bid required: true type: string responses: '204': description: The schedule bid was 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 wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details '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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:scheduleBid:delete x-purecloud-method-name: deleteWorkforcemanagementBusinessunitSchedulebid patch: tags: - Workforce Management summary: Update a schedule bid description: '' operationId: patchWorkforcemanagementBusinessunitSchedulebid consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The ID of the schedule bid required: true type: string - in: body name: body description: The schedule bid to be updated required: true schema: $ref: '#/definitions/UpdateScheduleBid' responses: '200': description: successful operation schema: $ref: '#/definitions/ScheduleBid' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:scheduleBid:edit x-purecloud-method-name: patchWorkforcemanagementBusinessunitSchedulebid /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids: get: tags: - Workforce Management summary: Get list of schedule bids description: '' operationId: getWorkforcemanagementBusinessunitSchedulebids produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ScheduleBidListResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:scheduleBid:view x-purecloud-method-name: getWorkforcemanagementBusinessunitSchedulebids post: tags: - Workforce Management summary: Create a new schedule bid description: '' operationId: postWorkforcemanagementBusinessunitSchedulebids consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: The schedule bid to be created required: true schema: $ref: '#/definitions/CreateScheduleBid' responses: '200': description: successful operation schema: $ref: '#/definitions/ScheduleBid' '201': description: The schedule bid was successfully created schema: $ref: '#/definitions/ScheduleBid' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:scheduleBid:add x-purecloud-method-name: postWorkforcemanagementBusinessunitSchedulebids /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/copy: post: tags: - Workforce Management summary: Copy a schedule bid description: '' operationId: postWorkforcemanagementBusinessunitSchedulebidCopy consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The ID of the schedule bid to copy required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/CopyScheduleBid' responses: '200': description: successful operation schema: $ref: '#/definitions/ScheduleBid' '201': description: The schedule bid was successfully created schema: $ref: '#/definitions/ScheduleBid' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:scheduleBid:add x-purecloud-method-name: postWorkforcemanagementBusinessunitSchedulebidCopy /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/effectiveschedulesets: post: tags: - Workforce Management summary: Fetch all the agents with effective schedule set for the given BU description: '' operationId: postWorkforcemanagementBusinessunitSchedulebidsEffectiveschedulesets consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/QueryEffectiveScheduleSetsRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AgentsEffectiveScheduleSetResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:scheduleBid:view x-purecloud-method-name: postWorkforcemanagementBusinessunitSchedulebidsEffectiveschedulesets /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs: get: tags: - Workforce Management summary: Get the list of scheduling runs description: '' operationId: getWorkforcemanagementBusinessunitSchedulingRuns produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/BuScheduleRunListing' '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' wfm.team.only.permissions.not.allowed: Team-only permissions are not allowed 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:generate - wfm:schedule:edit x-purecloud-method-name: getWorkforcemanagementBusinessunitSchedulingRuns /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}: get: tags: - Workforce Management summary: Get a scheduling run description: '' operationId: getWorkforcemanagementBusinessunitSchedulingRun produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: runId in: path description: The ID of the schedule run required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/BuScheduleRun' '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' wfm.team.only.permissions.not.allowed: Team-only permissions are not allowed 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:generate - wfm:schedule:edit x-purecloud-method-name: getWorkforcemanagementBusinessunitSchedulingRun delete: tags: - Workforce Management summary: Cancel a scheduling run description: '' operationId: deleteWorkforcemanagementBusinessunitSchedulingRun produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: runId in: path description: The ID of the schedule run required: true type: string responses: '204': description: The run was successfully canceled '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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:generate x-purecloud-method-name: deleteWorkforcemanagementBusinessunitSchedulingRun patch: tags: - Workforce Management summary: Mark a schedule run as applied description: '' operationId: patchWorkforcemanagementBusinessunitSchedulingRun produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: runId in: path description: The ID of the schedule run required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/PatchBuScheduleRunRequest' responses: '204': description: The update was successful '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.missing.one.of.permission.sets: Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets. 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:edit x-purecloud-method-name: patchWorkforcemanagementBusinessunitSchedulingRun /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}/result: get: tags: - Workforce Management summary: Get the result of a rescheduling operation description: '' operationId: getWorkforcemanagementBusinessunitSchedulingRunResult produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: runId in: path description: The ID of the schedule run required: true type: string - name: managementUnitIds in: query description: The IDs of the management units for which to fetch the reschedule results required: true type: array items: type: string collectionFormat: multi - name: expand in: query description: The fields to expand. Omitting will return an empty response required: true type: array items: type: string enum: - headcountForecast - generationResults - agentSchedules collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/BuRescheduleResult' '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: wfm.missing.one.of.permission.sets: Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets. wfm.only.authorized.for.team.access: 'Unauthorized: User only given team access permissions' 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:edit - wfm:schedule:generate x-purecloud-method-name: getWorkforcemanagementBusinessunitSchedulingRunResult /api/v2/workforcemanagement/businessunits/{businessUnitId}/agentschedules/search: post: tags: - Workforce Management summary: Search published schedules description: '' operationId: postWorkforcemanagementBusinessunitAgentschedulesSearch produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/BuSearchAgentSchedulesRequest' - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/BuAsyncAgentSchedulesSearchResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units, or is lacking the necessary team conditional permissions 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' wfm.team.only.permissions.not.allowed: Team-only permissions are not allowed 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:view - wfm:publishedSchedule:view x-purecloud-method-name: postWorkforcemanagementBusinessunitAgentschedulesSearch /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}: get: tags: - Workforce Management summary: Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route description: '' operationId: getWorkforcemanagementBusinessunitWeekSchedule produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: weekId in: path description: 'First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: scheduleId in: path description: The ID of the schedule required: true type: string - name: expand in: query description: expand required: false type: string enum: - managementUnits.agents responses: '200': description: successful operation schema: $ref: '#/definitions/BuScheduleMetadata' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:view - wfm:publishedSchedule:view x-purecloud-method-name: getWorkforcemanagementBusinessunitWeekSchedule delete: tags: - Workforce Management summary: Delete a schedule description: '' operationId: deleteWorkforcemanagementBusinessunitWeekSchedule produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: weekId in: path description: 'First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: scheduleId in: path description: The ID of the schedule required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/BuAsyncScheduleResponse' '202': description: The schedule is being deleted and updates will be sent by notification '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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 wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details '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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:delete x-purecloud-method-name: deleteWorkforcemanagementBusinessunitWeekSchedule /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule: post: tags: - Workforce Management summary: Start a rescheduling run description: '' operationId: postWorkforcemanagementBusinessunitWeekScheduleReschedule produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: weekId in: path description: 'First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: scheduleId in: path description: The ID of the schedule required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/BuRescheduleRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BuAsyncScheduleRunResponse' '202': description: The rescheduling run was started and updates will be sent by notification schema: $ref: '#/definitions/BuAsyncScheduleRunResponse' '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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.missing.one.of.permission.sets: You must have access to the division of the business unit or all requested management units for the documented permission 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:generate x-purecloud-method-name: postWorkforcemanagementBusinessunitWeekScheduleReschedule /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update/uploadurl: post: tags: - Workforce Management summary: Creates a signed upload URL for updating a schedule description: Once the upload is complete, call the /{scheduleId}/update route to start the schedule update process operationId: postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: weekId in: path description: 'First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: scheduleId in: path description: The ID of the schedule required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/UploadUrlRequestBody' responses: '200': description: successful operation schema: $ref: '#/definitions/UpdateScheduleUploadResponse' '201': description: The upload url for schedule update was successfully created schema: $ref: '#/definitions/UpdateScheduleUploadResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:edit x-purecloud-method-name: postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules: get: tags: - Workforce Management summary: Get the list of week schedules for the specified week description: Use "recent" (without quotes) for the `weekId` path parameter to fetch all schedules for up to +/- 26 weeks from the current date. Response will include any schedule which spans the specified week operationId: getWorkforcemanagementBusinessunitWeekSchedules produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: weekId in: path description: First day of schedule week in yyyy-MM-dd format, or 'recent' (without quotes) to get recent schedules required: true type: string - name: earliestWeekDate in: query description: 'If weekId == ''recent'', specify the earliest schedule start week date (inclusive) to include in the ''recent'' range, in yyyy-MM-dd format. Ignored if weekId != ''recent''. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: false type: string format: date - name: latestWeekDate in: query description: 'If weekId == ''recent'', specify the latest schedule start week date (inclusive) to include in the ''recent'' range, in yyyy-MM-dd format. Ignored if weekId != ''recent''. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: false type: string format: date - name: includeOnlyPublished in: query description: includeOnlyPublished required: false type: boolean - name: expand in: query description: expand required: false type: string enum: - shortTermForecast.description responses: '200': description: successful operation schema: $ref: '#/definitions/BuScheduleListing' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:view - wfm:publishedSchedule:view x-purecloud-method-name: getWorkforcemanagementBusinessunitWeekSchedules post: tags: - Workforce Management summary: Create a blank schedule description: '' operationId: postWorkforcemanagementBusinessunitWeekSchedules produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: weekId in: path description: 'First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - in: body name: body description: body required: true schema: $ref: '#/definitions/BuCreateBlankScheduleRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BuScheduleMetadata' '201': description: The schedule was successfully created schema: $ref: '#/definitions/BuScheduleMetadata' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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' wfm.validation.failure: VALIDATION_FAILURE 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:add x-purecloud-method-name: postWorkforcemanagementBusinessunitWeekSchedules /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import/uploadurl: post: tags: - Workforce Management summary: Creates a signed upload URL for importing a schedule description: Once the upload is complete, call the /import route to start the schedule import process operationId: postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: weekId in: path description: 'First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - in: body name: body description: body required: true schema: $ref: '#/definitions/UploadUrlRequestBody' responses: '200': description: successful operation schema: $ref: '#/definitions/ImportScheduleUploadResponse' '201': description: The upload url for import was successfully created schema: $ref: '#/definitions/ImportScheduleUploadResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:add x-purecloud-method-name: postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import: post: tags: - Workforce Management summary: Starts processing a schedule import description: Call after uploading the schedule data to the url supplied by the /import/uploadurl route operationId: postWorkforcemanagementBusinessunitWeekSchedulesImport produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: weekId in: path description: 'First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - in: body name: body required: true schema: $ref: '#/definitions/WfmProcessUploadRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ScheduleUploadProcessingResponse' '202': description: The schedule import is processing schema: $ref: '#/definitions/ScheduleUploadProcessingResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:add x-purecloud-method-name: postWorkforcemanagementBusinessunitWeekSchedulesImport /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/generate: post: tags: - Workforce Management summary: Generate a schedule description: '' operationId: postWorkforcemanagementBusinessunitWeekSchedulesGenerate produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: weekId in: path description: 'First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - in: body name: body description: body required: true schema: $ref: '#/definitions/BuGenerateScheduleRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BuAsyncScheduleRunResponse' '202': description: The schedule generation run was started and updates will be sent via notification schema: $ref: '#/definitions/BuAsyncScheduleRunResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:generate x-purecloud-method-name: postWorkforcemanagementBusinessunitWeekSchedulesGenerate /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy: post: tags: - Workforce Management summary: Copy a schedule description: '' operationId: postWorkforcemanagementBusinessunitWeekScheduleCopy produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: weekId in: path description: 'First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: scheduleId in: path description: The ID of the schedule to copy required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/BuCopyScheduleRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BuAsyncScheduleResponse' '201': description: The schedule was successfully copied schema: $ref: '#/definitions/BuAsyncScheduleResponse' '202': description: The schedule copy was started and updates will be sent via notification schema: $ref: '#/definitions/BuAsyncScheduleResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:add x-purecloud-method-name: postWorkforcemanagementBusinessunitWeekScheduleCopy /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults: get: tags: - Workforce Management summary: Get the generation results for a generated schedule description: '' operationId: getWorkforcemanagementBusinessunitWeekScheduleGenerationresults produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: weekId in: path description: 'First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: scheduleId in: path description: The ID of the schedule required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ScheduleGenerationResult' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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' wfm.team.only.permissions.not.allowed: Team-only permissions are not allowed 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:view - wfm:publishedSchedule:view x-purecloud-method-name: getWorkforcemanagementBusinessunitWeekScheduleGenerationresults /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/headcountforecast: get: tags: - Workforce Management summary: Get the headcount forecast by planning group for the schedule description: '' operationId: getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: weekId in: path description: 'First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: scheduleId in: path description: The ID of the schedule required: true type: string - name: forceDownload in: query description: Whether to force the result to come via download url. For testing purposes only required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/BuHeadcountForecastResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:view - wfm:publishedSchedule:view x-purecloud-method-name: getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/agentschedules/query: post: tags: - Workforce Management summary: Loads agent schedule data from the schedule. Used in combination with the metadata route description: '' operationId: postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: weekId in: path description: 'First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: scheduleId in: path description: The ID of the schedule required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/BuQueryAgentSchedulesRequest' - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/BuAsyncAgentSchedulesQueryResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.team.empty.or.no.members.in.management.unit: No members of the team were in a management unit, or the team was empty wfm.too.many.teams.requested: You may only request up to 10 teams in a single request 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] wfm.no.authorized.users.in.requested.teams: There are no authorized users in the requested teams constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units, or is lacking the necessary team conditional permissions 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' wfm.missing.team.permissions: You requested teams to which you do not have access wfm.management.unit.not.authorized: You are not authorized to view schedules for this management unit 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: wfm.management.unit.not.found: Management unit not found wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:view - wfm:publishedSchedule:view x-purecloud-method-name: postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/history/agents/{agentId}: get: tags: - Workforce Management summary: Loads agent's schedule history. description: '' operationId: getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: weekId in: path description: 'First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: scheduleId in: path description: The ID of the schedule required: true type: string - name: agentId in: path description: THe ID of the agent required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/BuAgentScheduleHistoryResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.only.authorized.for.team.access: The requested user is not in a team but you only have access to teams 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' wfm.missing.team.permissions: You must have access to the requested teams wfm.management.unit.not.authorized: You are not authorized to view schedule history for this management unit authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' wfm.only.authorized.for.team.required.divisions: The requested user is not in a team but you only have access to teams in the required division 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: wfm.management.unit.not.found: Management unit not found wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:view - wfm:publishedSchedule:view x-purecloud-method-name: getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update: post: tags: - Workforce Management summary: Starts processing a schedule update description: Call after uploading the schedule data to the url supplied by the /update/uploadurl route operationId: postWorkforcemanagementBusinessunitWeekScheduleUpdate produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: weekId in: path description: 'First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' required: true type: string format: date - name: scheduleId in: path description: The ID of the schedule required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/ProcessScheduleUpdateUploadRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BuAsyncScheduleResponse' '202': description: The schedule update process was started schema: $ref: '#/definitions/BuAsyncScheduleResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.team.empty.or.no.members.in.management.unit: No members of the team were in a management unit, or the team was empty wfm.too.many.teams.requested: You may only edit schedules for up to 10 teams in a single request 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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.only.authorized.for.team.access: The user is only authorized to call this route for specific teams 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' wfm.no.authorization.to.edit.schedule.for.teams: The user is not authorized to edit the schedule(s) of any of the users in the requested teams wfm.missing.team.permissions: You must have access to the requested teams 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: wfm.business.unit.not.found: Business unit 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:schedule:edit x-purecloud-method-name: postWorkforcemanagementBusinessunitWeekScheduleUpdate /api/v2/workforcemanagement/managementunits/{managementUnitId}/schedules/search: post: tags: - Workforce Management summary: Query published schedules for given given time range for set of users description: '' operationId: postWorkforcemanagementManagementunitSchedulesSearch produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/UserListScheduleRequestBody' responses: '200': description: successful operation schema: $ref: '#/definitions/UserScheduleContainer' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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' wfm.team.only.permissions.not.allowed: Team-only permissions are not allowed 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.deprecated.api.timeout: The response of this deprecated route needed to come via notification, instead please use /agentschedules/search '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: - workforce-management - workforce-management:readonly deprecated: true x-inin-requires-permissions: type: ANY permissions: - wfm:publishedSchedule:view - wfm:schedule:view x-purecloud-method-name: postWorkforcemanagementManagementunitSchedulesSearch /api/v2/workforcemanagement/managementunits/{managementUnitId}/agentschedules/search: post: tags: - Workforce Management summary: Query published schedules for given given time range for set of users description: '' operationId: postWorkforcemanagementManagementunitAgentschedulesSearch produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/BuSearchAgentSchedulesRequest' - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/BuAsyncAgentSchedulesSearchResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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' wfm.team.only.permissions.not.allowed: Team-only permissions are not allowed 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:publishedSchedule:view - wfm:schedule:view x-purecloud-method-name: postWorkforcemanagementManagementunitAgentschedulesSearch /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules: get: tags: - Workforce Management summary: Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit description: '' operationId: getWorkforcemanagementManagementunitWeekSchedules produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: weekId in: path description: First day of schedule week in yyyy-MM-dd format. required: true type: string - name: includeOnlyPublished in: query description: Return only published schedules required: false type: boolean - name: earliestWeekDate in: query description: The start date of the earliest week to query in yyyy-MM-dd format required: false type: string - name: latestWeekDate in: query description: The start date of the latest week to query in yyyy-MM-dd format required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WeekScheduleListResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly deprecated: true x-inin-requires-permissions: type: ANY permissions: - wfm:publishedSchedule:view - wfm:schedule:view x-purecloud-method-name: getWorkforcemanagementManagementunitWeekSchedules /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}: get: tags: - Workforce Management summary: Deprecated. Use the equivalent business unit resource instead. Get a week schedule description: '' operationId: getWorkforcemanagementManagementunitWeekSchedule produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: weekId in: path description: First day of schedule week in yyyy-MM-dd format. required: true type: string - name: scheduleId in: path description: The ID of the schedule to fetch required: true type: string - name: expand in: query description: Which fields, if any, to expand required: false type: string enum: - generationResults - headcountForecast - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/WeekScheduleResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly deprecated: true x-inin-requires-permissions: type: ANY permissions: - wfm:publishedSchedule:view - wfm:schedule:view x-purecloud-method-name: getWorkforcemanagementManagementunitWeekSchedule /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduler/settings: get: tags: - Workforce Management summary: Get scheduler settings for a business unit description: '' operationId: getWorkforcemanagementBusinessunitSchedulerSettings produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/BuSchedulerSettingsResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:schedulerSettings:view x-purecloud-method-name: getWorkforcemanagementBusinessunitSchedulerSettings patch: tags: - Workforce Management summary: Update scheduler settings for a business unit description: '' operationId: patchWorkforcemanagementBusinessunitSchedulerSettings produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/BuSchedulerSettingsRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BuSchedulerSettingsResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:schedulerSettings:edit x-purecloud-method-name: patchWorkforcemanagementBusinessunitSchedulerSettings /api/v2/workforcemanagement/schedulingjobs/{jobId}: get: tags: - Workforce Management summary: Get status of the scheduling job description: '' operationId: getWorkforcemanagementSchedulingjob produces: - application/json parameters: - name: jobId in: path description: The id of the scheduling job required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/SchedulingStatusResponse' '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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:schedulingrequest:view x-purecloud-method-name: getWorkforcemanagementSchedulingjob /api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/query/jobs: post: tags: - Workforce Management summary: Queries shift trades in a management unit per user description: '' operationId: postWorkforcemanagementBusinessunitShifttradingTradesQueryJobs consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean - in: body name: body description: The request body required: true schema: $ref: '#/definitions/QueryShiftTradeListJobRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeQueryTradesBuJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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] wfm.validation.management.unit.not.found: Management unit not found constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: Business unit not found wfm.business.unit.not.found: Business unit 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:shiftTradeRequest:view - wfm:shiftTradeRequest:edit x-purecloud-method-name: postWorkforcemanagementBusinessunitShifttradingTradesQueryJobs /api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/query/jobs/{jobId}: get: tags: - Workforce Management summary: View results of the query shift trades in a management unit per user operation. Only the user who started the operation can query the status description: Job details are only retained if the initial request returned a 202 ACCEPTED response operationId: getWorkforcemanagementBusinessunitShifttradingTradesQueryJob produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: jobId in: path description: The ID of the job required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeQueryTradesBuJobResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:shiftTradeRequest:view - wfm:shiftTradeRequest:edit x-purecloud-method-name: getWorkforcemanagementBusinessunitShifttradingTradesQueryJob /api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs: post: tags: - Workforce Management summary: Queries and evaluates against shift trade configuration shift trades in a management unit per week description: '' operationId: postWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobs consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean - in: body name: body description: The request body required: true schema: $ref: '#/definitions/EvaluateShiftTradeListJobRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeEvaluateTradesBuJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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] wfm.validation.management.unit.not.found: Management unit not found constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: Business unit not found wfm.business.unit.not.found: Business unit 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:shiftTradeRequest:view - wfm:shiftTradeRequest:edit x-purecloud-method-name: postWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobs /api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs/{jobId}: get: tags: - Workforce Management summary: View results of the evaluate shift trades in a management unit per week operation. Only the user who started the operation can query the status description: Job details are only retained if the initial request returned a 202 ACCEPTED response operationId: getWorkforcemanagementBusinessunitShifttradingTradesEvaluateJob produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: jobId in: path description: The ID of the job required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeEvaluateTradesBuJobResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:shiftTradeRequest:view - wfm:shiftTradeRequest:edit x-purecloud-method-name: getWorkforcemanagementBusinessunitShifttradingTradesEvaluateJob /api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs: post: tags: - Workforce Management summary: Retrieves the summary of shift trades in a matched state per week description: '' operationId: postWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobs consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean - in: body name: body description: The request body required: true schema: $ref: '#/definitions/QueryWeekSummaryListJobRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeQueryWeekSummariesBuJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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] wfm.validation.management.unit.not.found: Management unit not found constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: Business unit not found wfm.business.unit.not.found: Business unit 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:shiftTradeRequest:view - wfm:shiftTradeRequest:edit x-purecloud-method-name: postWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobs /api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs/{jobId}: get: tags: - Workforce Management summary: View results of the retrieve the summary of shift trades in a matched state per week operation. Only the user who started the operation can query the status description: Job details are only retained if the initial request returned a 202 ACCEPTED response operationId: getWorkforcemanagementBusinessunitShifttradingWeeksSummaryJob produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: jobId in: path description: The ID of the job required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeQueryWeekSummariesBuJobResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:shiftTradeRequest:view - wfm:shiftTradeRequest:edit x-purecloud-method-name: getWorkforcemanagementBusinessunitShifttradingWeeksSummaryJob /api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs: post: tags: - Workforce Management summary: Start an async job to find potential shift trade matches for the current receiving user description: '' operationId: postWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobs consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean - in: body name: body description: The request body required: true schema: $ref: '#/definitions/SearchUnmatchedShiftTradeListJobRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeSearchUnmatchedTradesBuJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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] wfm.validation.management.unit.not.found: Management unit not found constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: Business unit not found wfm.business.unit.not.found: Business unit 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:agentShiftTradeRequest:participate x-purecloud-method-name: postWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobs /api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs/{jobId}: get: tags: - Workforce Management summary: View result of potential shift trade matches for the current user. Only the user who started the operation can query the status description: Job details are only retained if the initial request returned a 202 ACCEPTED response operationId: getWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJob produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: jobId in: path description: The ID of the job required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeSearchUnmatchedTradesBuJobResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentShiftTradeRequest:participate x-purecloud-method-name: getWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJob /api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/state/bulk/jobs: post: tags: - Workforce Management summary: Bulk update multiple trade states. Permits a supervisor to approve or deny multiple trades. description: '' operationId: postWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobs consumes: - application/json produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean - in: body name: body description: The request body required: true schema: $ref: '#/definitions/BulkUpdateShiftTradeListJobRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeBulkUpdateTradeStateBuJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] wfm.validation.management.unit.not.found: Management unit not found constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: Business unit not found wfm.business.unit.not.found: Business unit 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:shiftTradeRequest:edit x-purecloud-method-name: postWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobs /api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/state/bulk/jobs/{jobId}: get: tags: - Workforce Management summary: View results of bulk update trades states operation. Only the user who started the operation can query the status. description: Job details are only retained if the initial request returned a 202 ACCEPTED response operationId: getWorkforcemanagementBusinessunitShifttradingTradesStateBulkJob produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: jobId in: path description: The ID of the job required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeBulkUpdateTradeStateBuJobResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:shiftTradeRequest:edit x-purecloud-method-name: getWorkforcemanagementBusinessunitShifttradingTradesStateBulkJob /api/v2/workforcemanagement/shifttrading/trades/jobs: post: tags: - Workforce Management summary: Add a shift trade job description: '' operationId: postWorkforcemanagementShifttradingTradesJobs consumes: - application/json produces: - application/json parameters: - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean - in: body name: body description: The request body required: true schema: $ref: '#/definitions/AddShiftTradeJobRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeAddTradeJobResponse' '201': description: Shift trade job created. schema: $ref: '#/definitions/ShiftTradeAddTradeJobResponse' '202': description: Shift trade job accepted for asynchronous processing. schema: $ref: '#/definitions/ShiftTradeAddTradeJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:agentShiftTradeRequest:participate x-purecloud-method-name: postWorkforcemanagementShifttradingTradesJobs /api/v2/workforcemanagement/shifttrading/trades/jobs/{jobId}: get: tags: - Workforce Management summary: View result of create trade operation. Only the user who started the operation can query the status description: Job details are only retained if the initial request returned a 202 ACCEPTED response operationId: getWorkforcemanagementShifttradingTradesJob produces: - application/json parameters: - name: jobId in: path description: The ID of the job required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeAddTradeJobResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentShiftTradeRequest:participate x-purecloud-method-name: getWorkforcemanagementShifttradingTradesJob /api/v2/workforcemanagement/shifttrading/trades/mine/query/jobs: post: tags: - Workforce Management summary: Retrieve all my shift trades where I am either the initiating or receiving user description: '' operationId: postWorkforcemanagementShifttradingTradesMineQueryJobs consumes: - application/json produces: - application/json parameters: - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean - in: body name: body description: The request body required: true schema: $ref: '#/definitions/QueryAgentShiftTradeListJobRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeQueryAgentTradesJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:agentShiftTradeRequest:participate x-purecloud-method-name: postWorkforcemanagementShifttradingTradesMineQueryJobs /api/v2/workforcemanagement/shifttrading/trades/mine/query/jobs/{jobId}: get: tags: - Workforce Management summary: View results of retrieve all my shift trade operation. Only the user who started the operation can query the status description: Job details are only retained if the initial request returned a 202 ACCEPTED response operationId: getWorkforcemanagementShifttradingTradesMineQueryJob produces: - application/json parameters: - name: jobId in: path description: The ID of the job required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeQueryAgentTradesJobResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentShiftTradeRequest:participate x-purecloud-method-name: getWorkforcemanagementShifttradingTradesMineQueryJob /api/v2/workforcemanagement/shifttrading/trades/{tradeId}/jobs: post: tags: - Workforce Management summary: Updates a shift trade. This route can only be called by the initiating user description: '' operationId: postWorkforcemanagementShifttradingTradeJobs consumes: - application/json produces: - application/json parameters: - name: tradeId in: path description: The ID of the shift trade to update required: true type: string - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean - in: body name: body description: The request body required: true schema: $ref: '#/definitions/UpdateShiftTradeJobRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeUpdateTradeJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:agentShiftTradeRequest:participate x-purecloud-method-name: postWorkforcemanagementShifttradingTradeJobs /api/v2/workforcemanagement/shifttrading/trades/{tradeId}/jobs/{jobId}: get: tags: - Workforce Management summary: View result of update trade operation. Only the user who started the operation can query the status description: Job details are only retained if the initial request returned a 202 ACCEPTED response operationId: getWorkforcemanagementShifttradingTradeJob produces: - application/json parameters: - name: tradeId in: path description: The ID of the shift trade to update required: true type: string - name: jobId in: path description: The ID of the job required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeUpdateTradeJobResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentShiftTradeRequest:participate x-purecloud-method-name: getWorkforcemanagementShifttradingTradeJob /api/v2/workforcemanagement/shifttrading/trades/{tradeId}/state/jobs: post: tags: - Workforce Management summary: Update trade state by a user description: '' operationId: postWorkforcemanagementShifttradingTradeStateJobs consumes: - application/json produces: - application/json parameters: - name: tradeId in: path description: The ID of the shift trade to update state required: true type: string - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean - in: body name: body description: The request body required: true schema: $ref: '#/definitions/UpdateShiftTradeStateJobRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeUpdateTradeStateJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:agentShiftTradeRequest:participate x-purecloud-method-name: postWorkforcemanagementShifttradingTradeStateJobs /api/v2/workforcemanagement/shifttrading/trades/{tradeId}/state/jobs/{jobId}: get: tags: - Workforce Management summary: View result of update trade state operation. Only the user who started the operation can query the status. description: Job details are only retained if the initial request returned a 202 ACCEPTED response operationId: getWorkforcemanagementShifttradingTradeStateJob produces: - application/json parameters: - name: tradeId in: path description: The ID of the shift trade to update required: true type: string - name: jobId in: path description: The ID of the job required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeUpdateTradeStateJobResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentShiftTradeRequest:participate x-purecloud-method-name: getWorkforcemanagementShifttradingTradeStateJob /api/v2/workforcemanagement/shifttrading/trades/{tradeId}/match/jobs: post: tags: - Workforce Management summary: Matches a shift trade. This route can only be called by the receiving user description: '' operationId: postWorkforcemanagementShifttradingTradeMatchJobs consumes: - application/json produces: - application/json parameters: - name: tradeId in: path description: The ID of the shift trade to match required: true type: string - name: forceAsync in: query description: Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes required: false type: boolean - in: body name: body description: The request body required: true schema: $ref: '#/definitions/MatchShiftTradeJobRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeMatchTradeJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:agentShiftTradeRequest:participate x-purecloud-method-name: postWorkforcemanagementShifttradingTradeMatchJobs /api/v2/workforcemanagement/shifttrading/trades/{tradeId}/match/jobs/{jobId}: get: tags: - Workforce Management summary: View result of match shift trade operation. Only the receiving user who started the operation can query the status. description: Job details are only retained if the initial request returned a 202 ACCEPTED response operationId: getWorkforcemanagementShifttradingTradeMatchJob produces: - application/json parameters: - name: tradeId in: path description: The ID of the shift trade to update required: true type: string - name: jobId in: path description: The ID of the job required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ShiftTradeMatchTradeJobResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentShiftTradeRequest:participate x-purecloud-method-name: getWorkforcemanagementShifttradingTradeMatchJob /api/v2/workforcemanagement/shrinkage/jobs/{jobId}: get: tags: - Workforce Management summary: Request to fetch the status of the historical shrinkage query description: '' operationId: getWorkforcemanagementShrinkageJob produces: - application/json parameters: - name: jobId in: path description: jobId required: true type: string responses: '200': description: Accepted schema: $ref: '#/definitions/WfmHistoricalShrinkageResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: job.not.found: The requested job could not be 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: - workforce-management - workforce-management:readonly x-purecloud-method-name: getWorkforcemanagementShrinkageJob /api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs: post: tags: - Workforce Management summary: Request a historical shrinkage report description: 'The maximum supported range for historical shrinkage queries is up to 32 days. Historical Shrinkage for a given date range can be queried in two modes - granular and aggregated. To see granular shrinkage information, provide granularity in the request body. ' operationId: postWorkforcemanagementManagementunitShrinkageJobs produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/WfmHistoricalShrinkageRequest' responses: '202': description: Processing request schema: $ref: '#/definitions/WfmHistoricalShrinkageResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:shrinkage:view x-purecloud-method-name: postWorkforcemanagementManagementunitShrinkageJobs /api/v2/workforcemanagement/teams/{teamId}/shrinkage/jobs: post: tags: - Workforce Management summary: Request a historical shrinkage report description: The maximum supported range for historical shrinkage queries is up to 32 days operationId: postWorkforcemanagementTeamShrinkageJobs produces: - application/json parameters: - name: teamId in: path description: The ID of the team required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/WfmHistoricalShrinkageTeamsRequest' responses: '202': description: Processing request schema: $ref: '#/definitions/WfmHistoricalShrinkageResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.team.empty.or.no.members.in.management.unit: No members of the team were in a management unit, or the team was empty 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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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' wfm.unauthorized.for.any.team.members: You are not authorized for any members of the team 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:shrinkage:view x-purecloud-method-name: postWorkforcemanagementTeamShrinkageJobs /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query: post: tags: - Workforce Management summary: Fetches time off requests matching the conditions specified in the request body description: 'Request body requires one of the following: statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters' operationId: postWorkforcemanagementManagementunitTimeoffrequestsQuery produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/TimeOffRequestQueryBody' - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffRequestListing' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffRequest:view x-purecloud-method-name: postWorkforcemanagementManagementunitTimeoffrequestsQuery /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests: get: tags: - Workforce Management summary: Get a list of time off requests for a given user description: '' operationId: getWorkforcemanagementManagementunitUserTimeoffrequests produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: userId in: path description: The userId to whom the Time Off Request applies. required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffRequestList' '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffRequest:view x-purecloud-method-name: getWorkforcemanagementManagementunitUserTimeoffrequests /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}: get: tags: - Workforce Management summary: Get a time off request description: '' operationId: getWorkforcemanagementManagementunitUserTimeoffrequest produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: userId in: path description: The userId to whom the Time Off Request applies. required: true type: string - name: timeOffRequestId in: path description: Time Off Request Id required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffRequestResponse' '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffRequest:view x-purecloud-method-name: getWorkforcemanagementManagementunitUserTimeoffrequest patch: tags: - Workforce Management summary: Update a time off request description: '' operationId: patchWorkforcemanagementManagementunitUserTimeoffrequest produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - name: userId in: path description: The id of the user the requested time off request belongs to required: true type: string - name: timeOffRequestId in: path description: The id of the time off request to update required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/AdminTimeOffRequestPatch' responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffRequestResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffRequest:edit x-purecloud-method-name: patchWorkforcemanagementManagementunitUserTimeoffrequest /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests: post: tags: - Workforce Management summary: Create a new time off request description: '' operationId: postWorkforcemanagementManagementunitTimeoffrequests produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit, or 'mine' for the management unit of the logged-in user. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/CreateAdminTimeOffRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffRequestList' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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. wfm.not.allowed: One of the attempted actions was not allowed, please check the error details for more information invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffRequest:add x-purecloud-method-name: postWorkforcemanagementManagementunitTimeoffrequests /api/v2/workforcemanagement/timeoffbalance/jobs: post: tags: - Workforce Management summary: Query time off balances for the current user for specified activity code and dates description: '' operationId: postWorkforcemanagementTimeoffbalanceJobs produces: - application/json parameters: - in: body name: body description: The request body required: true schema: $ref: '#/definitions/TimeOffBalanceRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffBalancesResponse' '202': description: The current user time off balance query is processing schema: $ref: '#/definitions/TimeOffBalancesResponse' '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. wfm.configuration.conflict: The request failed due to existing configuration conflict invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentTimeOffRequest:submit x-purecloud-method-name: postWorkforcemanagementTimeoffbalanceJobs /api/v2/workforcemanagement/timeoffbalance/jobs/{jobId}: get: tags: - Workforce Management summary: Query the results of time off types job description: '' operationId: getWorkforcemanagementTimeoffbalanceJob produces: - application/json parameters: - name: jobId in: path description: The ID of the job. required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffBalanceJobResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: The job with the requested ID was 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: - workforce-management - workforce-management:readonly x-purecloud-method-name: getWorkforcemanagementTimeoffbalanceJob ? /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeoffbalance/jobs : post: tags: - Workforce Management summary: Query time off balances for dates spanned by a given time off request description: '' operationId: postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit. required: true type: string - name: userId in: path description: The userId to whom the time off request applies. required: true type: string - name: timeOffRequestId in: path description: The time off request id. required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffBalancesResponse' '202': description: The time off balance query is processing schema: $ref: '#/definitions/TimeOffBalancesResponse' '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. wfm.configuration.conflict: The request failed due to existing configuration conflict invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffRequest:view x-purecloud-method-name: postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffbalance/jobs: post: tags: - Workforce Management summary: Query time off balances for a given user for specified activity code and dates description: '' operationId: postWorkforcemanagementManagementunitUserTimeoffbalanceJobs produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit required: true type: string - name: userId in: path description: The ID of the user required: true type: string - in: body name: body description: The request body required: true schema: $ref: '#/definitions/TimeOffBalanceRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffBalancesResponse' '202': description: The user time off balance query is processing schema: $ref: '#/definitions/TimeOffBalancesResponse' '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. wfm.configuration.conflict: The request failed due to existing configuration conflict invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffRequest:view x-purecloud-method-name: postWorkforcemanagementManagementunitUserTimeoffbalanceJobs /api/v2/workforcemanagement/timeoffrequests/estimate: post: tags: - Workforce Management summary: Estimates available time off for current user description: '' operationId: postWorkforcemanagementTimeoffrequestsEstimate produces: - application/json parameters: - in: body name: body description: body required: true schema: $ref: '#/definitions/EstimateAvailableTimeOffRequest' - name: includeOnly in: query description: Limit response to the specified field required: false type: string enum: - overrideDateType responses: '200': description: successful operation schema: $ref: '#/definitions/EstimateAvailableTimeOffResponse' '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. wfm.configuration.conflict: The request failed due to existing configuration conflict invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:agentTimeOffRequest:submit x-purecloud-method-name: postWorkforcemanagementTimeoffrequestsEstimate /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate: post: tags: - Workforce Management summary: Estimates available time off for an agent description: '' operationId: postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit required: true type: string - name: userId in: path description: The id of the user for whom the time off request estimate is requested required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/EstimateAvailableTimeOffRequest' - name: includeOnly in: query description: Limit response to the specified field required: false type: string enum: - overrideDateType responses: '200': description: successful operation schema: $ref: '#/definitions/EstimateAvailableTimeOffResponse' '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. wfm.configuration.conflict: The request failed due to existing configuration conflict invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffRequest:view x-purecloud-method-name: postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query: post: tags: - Workforce Management summary: Retrieves integration statuses for a list of time off requests description: '' operationId: postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/QueryTimeOffIntegrationStatusRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/UserTimeOffIntegrationStatusResponseListing' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffRequest:view x-purecloud-method-name: postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery ? /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus : patch: tags: - Workforce Management summary: Set integration status for a time off request. description: '' operationId: patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/SetTimeOffIntegrationStatusRequest' - name: timeOffRequestId in: path description: The ID of the time off request. required: true type: string - name: userId in: path description: The ID of user to whom the time off request belongs. required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/UserTimeOffIntegrationStatusResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffRequest:edit x-purecloud-method-name: patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits: get: tags: - Workforce Management summary: Gets a list of time-off limit objects description: '' operationId: getWorkforcemanagementBusinessunitTimeofflimits produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: managementUnitId in: query description: The ID of the management unit to get management unit specific time-off limit objects required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/BuTimeOffLimitListing' '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] wfm.validation.management.unit.not.found: Management unit not found 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffLimit:view - wfm:timeOffPlan:view x-purecloud-method-name: getWorkforcemanagementBusinessunitTimeofflimits post: tags: - Workforce Management summary: Creates a new time-off limit object description: '' operationId: postWorkforcemanagementBusinessunitTimeofflimits produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/BuCreateTimeOffLimitRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BuTimeOffLimitResponse' '201': description: The time-off limit was successfully created schema: $ref: '#/definitions/BuTimeOffLimitResponse' '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] wfm.validation.management.unit.not.found: Management unit not found constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffLimit:add x-purecloud-method-name: postWorkforcemanagementBusinessunitTimeofflimits /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}: get: tags: - Workforce Management summary: Gets a time-off limit object description: Returns properties of time-off limit object, but not daily values operationId: getWorkforcemanagementBusinessunitTimeofflimit produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: timeOffLimitId in: path description: The ID of the time-off limit to fetch required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/BuTimeOffLimitResponse' '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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffLimit:view x-purecloud-method-name: getWorkforcemanagementBusinessunitTimeofflimit delete: tags: - Workforce Management summary: Deletes a time-off limit object description: '' operationId: deleteWorkforcemanagementBusinessunitTimeofflimit produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: timeOffLimitId in: path description: The ID of the time-off limit object to delete required: true type: string responses: '204': description: The time-off limit object 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 '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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffLimit:delete x-purecloud-method-name: deleteWorkforcemanagementBusinessunitTimeofflimit /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values: put: tags: - Workforce Management summary: Sets daily values for a date range of time-off limit object description: Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API operationId: putWorkforcemanagementBusinessunitTimeofflimitValues produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: timeOffLimitId in: path description: The ID of the time-off limit object to set values for required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/BuSetTimeOffLimitValuesRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BuTimeOffLimitResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffLimit:edit x-purecloud-method-name: putWorkforcemanagementBusinessunitTimeofflimitValues /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query: post: tags: - Workforce Management summary: Retrieves time-off limit related values based on a given set of filters. description: '' operationId: postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/QueryTimeOffLimitValuesRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BuTimeOffLimitValuesResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffLimit:view x-purecloud-method-name: postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits: get: tags: - Workforce Management summary: Gets a list of time off limit objects under management unit. description: Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element. operationId: getWorkforcemanagementManagementunitTimeofflimits produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit. required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffLimitListing' '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffLimit:view - wfm:timeOffPlan:view x-purecloud-method-name: getWorkforcemanagementManagementunitTimeofflimits post: tags: - Workforce Management summary: Creates a new time off limit object under management unit. description: Only one limit object is allowed under management unit, so an attempt to create second object will fail. operationId: postWorkforcemanagementManagementunitTimeofflimits produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/CreateTimeOffLimitRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffLimit' '201': description: The time off limit was successfully created schema: $ref: '#/definitions/TimeOffLimit' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffLimit:add x-purecloud-method-name: postWorkforcemanagementManagementunitTimeofflimits /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}: get: tags: - Workforce Management summary: Gets a time off limit object description: Returns properties of time off limit object, but not daily values. operationId: getWorkforcemanagementManagementunitTimeofflimit produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit. required: true type: string - name: timeOffLimitId in: path description: The ID of the time off limit to fetch required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffLimit' '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffLimit:view x-purecloud-method-name: getWorkforcemanagementManagementunitTimeofflimit delete: tags: - Workforce Management summary: Deletes a time off limit object description: '' operationId: deleteWorkforcemanagementManagementunitTimeofflimit produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit. required: true type: string - name: timeOffLimitId in: path description: The ID of the time off limit object to delete required: true type: string responses: '204': description: The time off limit object 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 '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffLimit:delete x-purecloud-method-name: deleteWorkforcemanagementManagementunitTimeofflimit patch: tags: - Workforce Management summary: Updates a time off limit object. description: Updates time off limit object properties, but not daily values. operationId: patchWorkforcemanagementManagementunitTimeofflimit produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit. required: true type: string - name: timeOffLimitId in: path description: The id of time off limit object to update required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/UpdateTimeOffLimitRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffLimit' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffLimit:edit x-purecloud-method-name: patchWorkforcemanagementManagementunitTimeofflimit /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values: put: tags: - Workforce Management summary: Sets daily values for a date range of time off limit object description: Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API operationId: putWorkforcemanagementManagementunitTimeofflimitValues produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit. required: true type: string - name: timeOffLimitId in: path description: The ID of the time off limit object to set values for required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/SetTimeOffLimitValuesRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffLimit' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffLimit:edit x-purecloud-method-name: putWorkforcemanagementManagementunitTimeofflimitValues /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query: post: tags: - Workforce Management summary: Retrieves time off limit related values based on a given set of filters. description: '' operationId: postWorkforcemanagementManagementunitTimeofflimitsValuesQuery produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/QueryTimeOffLimitValuesRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/QueryTimeOffLimitValuesResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffLimit:view x-purecloud-method-name: postWorkforcemanagementManagementunitTimeofflimitsValuesQuery ? /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeofflimits : get: tags: - Workforce Management summary: Retrieves time off limit, allocated and waitlisted values according to specific time off request description: '' operationId: getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit. required: true type: string - name: userId in: path description: The userId to whom the time off request applies. required: true type: string - name: timeOffRequestId in: path description: The ID of the time off request, which dates and activityCodeId determine limit values to retrieve required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/QueryTimeOffLimitValuesResponse' '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ALL permissions: - wfm:timeOffRequest:view - wfm:timeOffLimit:view x-purecloud-method-name: getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans: get: tags: - Workforce Management summary: Gets a list of time-off plans description: '' operationId: getWorkforcemanagementBusinessunitTimeoffplans produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: managementUnitId in: query description: The ID of the management unit to get management unit specific staffing groups required: false type: string - name: forceDownloadService in: query description: Force the result of this operation to be sent via download service. For testing/app development purposes required: false type: boolean - name: expand in: query description: Include to access additional data for the time-off plans required: false type: array items: type: string enum: - overrideDates collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/BuTimeOffPlanListing' '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] wfm.validation.management.unit.not.found: Management unit not found 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.business.unit.not.found: Business unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffPlan:view x-purecloud-method-name: getWorkforcemanagementBusinessunitTimeoffplans post: tags: - Workforce Management summary: Creates a new time-off plan description: '' operationId: postWorkforcemanagementBusinessunitTimeoffplans produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/BuCreateTimeOffPlanRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BuTimeOffPlanResponse' '201': description: The time-off plan was successfully created schema: $ref: '#/definitions/BuTimeOffPlanResponse' '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. wfm.configuration.conflict: The request failed due to existing configuration conflict invalid.property: Value [%s] is not a valid property for object [%s] wfm.validation.management.unit.not.found: Management unit not found constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.business.unit.not.found: Business unit 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffPlan:add x-purecloud-method-name: postWorkforcemanagementBusinessunitTimeoffplans /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}: get: tags: - Workforce Management summary: Gets a time-off plan description: '' operationId: getWorkforcemanagementBusinessunitTimeoffplan produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: timeOffPlanId in: path description: The ID of the time-off plan to fetch required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/BuTimeOffPlanResponse' '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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffPlan:view x-purecloud-method-name: getWorkforcemanagementBusinessunitTimeoffplan delete: tags: - Workforce Management summary: Deletes a time-off plan description: '' operationId: deleteWorkforcemanagementBusinessunitTimeoffplan produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: timeOffPlanId in: path description: The ID of the time-off plan to delete required: true type: string responses: '204': description: The time-off plan was 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffPlan:delete x-purecloud-method-name: deleteWorkforcemanagementBusinessunitTimeoffplan patch: tags: - Workforce Management summary: Updates a time-off plan description: '' operationId: patchWorkforcemanagementBusinessunitTimeoffplan produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: timeOffPlanId in: path description: The ID of the time-off plan to update required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/BuUpdateTimeOffPlanRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BuTimeOffPlanResponse' '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. wfm.configuration.conflict: The request failed due to existing configuration conflict invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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). wfm.permission.failure: The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffPlan:edit x-purecloud-method-name: patchWorkforcemanagementBusinessunitTimeoffplan /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans: get: tags: - Workforce Management summary: Gets a list of time off plans description: '' operationId: getWorkforcemanagementManagementunitTimeoffplans produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffPlanListing' '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: wfm.management.unit.not.found: Management unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffPlan:view x-purecloud-method-name: getWorkforcemanagementManagementunitTimeoffplans post: tags: - Workforce Management summary: Creates a new time off plan description: '' operationId: postWorkforcemanagementManagementunitTimeoffplans produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/CreateTimeOffPlanRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffPlan' '201': description: The time off plan was successfully created schema: $ref: '#/definitions/TimeOffPlan' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffPlan:add x-purecloud-method-name: postWorkforcemanagementManagementunitTimeoffplans /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}: get: tags: - Workforce Management summary: Gets a time off plan description: '' operationId: getWorkforcemanagementManagementunitTimeoffplan produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit required: true type: string - name: timeOffPlanId in: path description: The ID of the time off plan to fetch required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffPlan' '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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffPlan:view x-purecloud-method-name: getWorkforcemanagementManagementunitTimeoffplan delete: tags: - Workforce Management summary: Deletes a time off plan description: '' operationId: deleteWorkforcemanagementManagementunitTimeoffplan produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit required: true type: string - name: timeOffPlanId in: path description: The ID of the time off plan to delete required: true type: string responses: '204': description: The time off plan was 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffPlan:delete x-purecloud-method-name: deleteWorkforcemanagementManagementunitTimeoffplan patch: tags: - Workforce Management summary: Updates a time off plan description: '' operationId: patchWorkforcemanagementManagementunitTimeoffplan produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit required: true type: string - name: timeOffPlanId in: path description: The ID of the time off plan to update required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/UpdateTimeOffPlanRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/TimeOffPlan' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffPlan:edit x-purecloud-method-name: patchWorkforcemanagementManagementunitTimeoffplan /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query: post: tags: - Workforce Management summary: Retrieves daily waitlist position for a list of time off requests description: '' operationId: postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery produces: - application/json parameters: - name: managementUnitId in: path description: The ID of the management unit. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/QueryWaitlistPositionsRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/WaitlistPositionListing' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.management.unit.not.found: Management unit 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:timeOffRequest:view x-purecloud-method-name: postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/summary: get: tags: - Workforce Management summary: Get summary of bid groups that belong to a work plan bid description: '' operationId: getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The work plan bid id of the bid groups required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlanBidGroupSummaryList' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanBidGroup:view x-purecloud-method-name: getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups: post: tags: - Workforce Management summary: Add a bid group in a given work plan bid description: '' operationId: postWorkforcemanagementBusinessunitWorkplanbidGroups produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The work plan bid id of the bid groups required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/WorkPlanBidGroupCreate' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlanBidGroupResponse' '201': description: The work plan bid group was successfully created schema: $ref: '#/definitions/WorkPlanBidGroupResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanBidGroup:add x-purecloud-method-name: postWorkforcemanagementBusinessunitWorkplanbidGroups /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}: get: tags: - Workforce Management summary: Get a bid group by bid group Id description: '' operationId: getWorkforcemanagementBusinessunitWorkplanbidGroup produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The work plan bid id of the bid groups required: true type: string - name: bidGroupId in: path description: Work Plan Bid Group id required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlanBidGroupResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanBidGroup:view x-purecloud-method-name: getWorkforcemanagementBusinessunitWorkplanbidGroup delete: tags: - Workforce Management summary: Delete a bid group by bid group Id description: '' operationId: deleteWorkforcemanagementBusinessunitWorkplanbidGroup produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The work plan bid id of the bid groups required: true type: string - name: bidGroupId in: path description: Work Plan Bid Group id required: true type: string responses: '204': description: The bid group was 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 wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details '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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanBidGroup:delete x-purecloud-method-name: deleteWorkforcemanagementBusinessunitWorkplanbidGroup patch: tags: - Workforce Management summary: Update a bid group by bid group Id description: '' operationId: patchWorkforcemanagementBusinessunitWorkplanbidGroup produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The work plan bid id of the bid groups required: true type: string - name: bidGroupId in: path description: Work Plan Bid Group id required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/WorkPlanBidGroupUpdate' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlanBidGroupResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanBidGroup:edit x-purecloud-method-name: patchWorkforcemanagementBusinessunitWorkplanbidGroup /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences: get: tags: - Workforce Management summary: Gets the work plan preferences of all the agents in the work plan bid group description: '' operationId: getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The work plan bid id of the bid groups required: true type: string - name: bidGroupId in: path description: The ID of the work plan bid group required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AdminAgentWorkPlanPreferenceResponse' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanBidGroup:view x-purecloud-method-name: getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences patch: tags: - Workforce Management summary: Overrides the assigned work plan for the specified agents description: '' operationId: patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The work plan bid id of the bid groups required: true type: string - name: bidGroupId in: path description: The ID of the work plan bid group required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/AgentsBidAssignedWorkPlanOverrideRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AdminAgentWorkPlanPreferenceResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: wfm.entity.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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. wfm.transaction.conflict: Entity was modified by another request '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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanBidGroup:edit x-purecloud-method-name: patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences /api/v2/workforcemanagement/users/workplanbidranks/bulk: patch: tags: - Workforce Management summary: Update bulk work plan bid ranks on users. Max 50 users can be updated at a time. description: '' operationId: patchWorkforcemanagementUsersWorkplanbidranksBulk produces: - application/json parameters: - in: body name: body description: Users required: true schema: type: array items: $ref: '#/definitions/WorkPlanBidRanks' responses: '200': description: successful operation schema: $ref: '#/definitions/EntityListing' '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: general.resource.not.found: One of the requested resources in the request body was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanBid:edit x-purecloud-method-name: patchWorkforcemanagementUsersWorkplanbidranksBulk /api/v2/workforcemanagement/users/{userId}/workplanbidranks: get: tags: - Workforce Management summary: Get work plan bid ranks for a user description: '' operationId: getWorkforcemanagementUserWorkplanbidranks produces: - application/json parameters: - name: userId in: path description: The userId to whom the work plan bid ranks apply. required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlanBidRanks' '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: general.resource.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: division.authorization.timeout: Division authorization timed out. authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanBid:view x-purecloud-method-name: getWorkforcemanagementUserWorkplanbidranks patch: tags: - Workforce Management summary: Update work plan bid ranks for a user description: '' operationId: patchWorkforcemanagementUserWorkplanbidranks produces: - application/json parameters: - name: userId in: path description: The userId to whom the work plan bid ranks apply. required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/WorkPlanBidRanks' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlanBidRanks' '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: general.resource.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: division.authorization.timeout: Division authorization timed out. authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanBid:edit x-purecloud-method-name: patchWorkforcemanagementUserWorkplanbidranks /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}: get: tags: - Workforce Management summary: Get a work plan bid description: '' operationId: getWorkforcemanagementBusinessunitWorkplanbid produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The id of the workplanbid required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlanBid' '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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanBid:view x-purecloud-method-name: getWorkforcemanagementBusinessunitWorkplanbid delete: tags: - Workforce Management summary: Delete a work plan bid description: '' operationId: deleteWorkforcemanagementBusinessunitWorkplanbid produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The ID of the work plan bid required: true type: string responses: '204': description: The work plan bid was 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 wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details '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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanBid:delete x-purecloud-method-name: deleteWorkforcemanagementBusinessunitWorkplanbid patch: tags: - Workforce Management summary: Update work plan bid description: '' operationId: patchWorkforcemanagementBusinessunitWorkplanbid produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The id of the workplanbid required: true type: string - in: body name: body description: The work plan bid to be updated required: true schema: $ref: '#/definitions/UpdateWorkPlanBid' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlanBid' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanBid:edit x-purecloud-method-name: patchWorkforcemanagementBusinessunitWorkplanbid /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids: get: tags: - Workforce Management summary: Get list of work plan bids description: '' operationId: getWorkforcemanagementBusinessunitWorkplanbids produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlanBidListResponse' '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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management - workforce-management:readonly x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanBid:view x-purecloud-method-name: getWorkforcemanagementBusinessunitWorkplanbids post: tags: - Workforce Management summary: Create a new work plan bid description: '' operationId: postWorkforcemanagementBusinessunitWorkplanbids produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - in: body name: body description: The work plan bid to be created required: true schema: $ref: '#/definitions/CreateWorkPlanBid' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlanBid' '201': description: The work plan bid was successfully created schema: $ref: '#/definitions/WorkPlanBid' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanBid:add x-purecloud-method-name: postWorkforcemanagementBusinessunitWorkplanbids /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/copy: post: tags: - Workforce Management summary: Copy a work plan bid description: '' operationId: postWorkforcemanagementBusinessunitWorkplanbidCopy produces: - application/json parameters: - name: businessUnitId in: path description: The ID of the business unit required: true type: string - name: bidId in: path description: The ID of the work plan bid to copy required: true type: string - in: body name: body description: body required: true schema: $ref: '#/definitions/CopyWorkPlanBid' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkPlanBid' '201': description: The work plan bid was successfully created schema: $ref: '#/definitions/WorkPlanBid' '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' wfm.validation.failure: One or more of the request's fields did not pass validation. See userParams and the error message for more details 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: wfm.business.unit.not.found: Business unit not found wfm.entity.not.found: One of the requested resources in the path variables was not found, please check the error details for more information 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: - workforce-management x-inin-requires-permissions: type: ANY permissions: - wfm:workPlanBid:add x-purecloud-method-name: postWorkforcemanagementBusinessunitWorkplanbidCopy definitions: RequiredDateRange: type: object required: - endDate - startDate properties: startDate: type: string format: date-time description: The start of a date range in ISO-8601 format endDate: type: string format: date-time description: The end of a date range in ISO-8601 format SchedulingPeriodBase: type: object required: - latestEndDate properties: latestEndDate: type: string format: date description: 'The latest date the associated activity plan can end, in YYYY-MM-DD format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' WeekShiftTradeListResponse: type: object properties: entities: type: array items: $ref: '#/definitions/WeekShiftTradeResponse' downloadUrl: type: string description: URL from which to fetch results for requests with a large result set. If populated, the downloaded data will conform to the same schema as would normally be returned, excepting downloaded data will never itself contain a downloadUrl BuAgentScheduleHistoryDeletedChange: type: object properties: shiftIds: type: array description: The IDs of deleted shifts uniqueItems: true items: type: string fullDayTimeOffMarkerDates: type: array description: The dates of any deleted full day time off markers uniqueItems: true items: type: string format: date agentSchedule: type: boolean description: Whether the entire agent schedule was deleted UploadUrlRequestBody: type: object required: - contentLengthBytes properties: contentLengthBytes: type: integer format: int64 description: The expected content length (in bytes) of the gzip-encoded data that will be PUT to the returned signed URL AdherenceSettings: type: object properties: severeAlertThresholdMinutes: type: integer format: int32 description: The threshold in minutes where an alert will be triggered when an agent is considered severely out of adherence adherenceTargetPercent: type: integer format: int32 description: Target adherence percentage adherenceExceptionThresholdSeconds: type: integer format: int32 description: The threshold in seconds for which agents should not be penalized for being momentarily out of adherence nonOnQueueActivitiesEquivalent: type: boolean description: Whether to treat all non-on-queue activities as equivalent for adherence purposes trackOnQueueActivity: type: boolean description: Whether to track on-queue activities ignoredActivityCategories: description: Activity categories that should be ignored for adherence purposes $ref: '#/definitions/IgnoredActivityCategories' ignoredActivityCodeIds: description: Activity code IDs that should be ignored for adherence purposes $ref: '#/definitions/IgnoredActivityCodeIds' CreateStaffingGroupRequest: type: object required: - name properties: name: type: string description: The name of the staffing group userIds: type: array description: The set of user IDs to associate with the staffing group uniqueItems: true items: type: string managementUnitId: type: string description: The ID of the management unit to which the staffing group users belong. If undefined the staffing group can include users from the entire business unit planningGroupIds: type: array description: The set of planning group IDs to associate with the staffing group uniqueItems: true items: type: string CreateTimeOffPlanRequest: type: object required: - active - autoApprovalRule - name properties: name: type: string description: The name of this time off plan. activityCodeIds: type: array description: The set of activity code IDs to associate with this time off plan. uniqueItems: true items: type: string timeOffLimitIds: type: array description: The set of time off limit IDs to associate with this time off plan. uniqueItems: true items: type: string autoApprovalRule: type: string description: Auto approval rule for the time off plan. enum: - Never - Always - CheckLimits - CheckActivityCodes - CheckLimitsAndActivityCodes daysBeforeStartToExpireFromWaitlist: type: integer format: int32 description: The number of days before the time off request start date for when the request will be expired from the waitlist. hrisTimeOffType: description: Time off type, if this time off plan is associated with the integration. $ref: '#/definitions/HrisTimeOffType' active: type: boolean description: Whether this time off plan should be used by agents. MuRescheduleResultWrapper: type: object properties: agentSchedules: type: array description: The list of agent schedules items: $ref: '#/definitions/BuAgentScheduleRescheduleResponse' BuUpdateAgentScheduleUploadSchema: type: object required: - userId properties: userId: type: string description: The ID of the user to whom this agent schedule applies workPlanId: description: The ID of the work plan for this user. Mutually exclusive with workPlanIdsPerWeek $ref: '#/definitions/ValueWrapperString' workPlanIdsPerWeek: description: The IDs of the work plans per week for this user. Mutually exclusive with workPlanId $ref: '#/definitions/ListWrapperString' shifts: type: array description: The shift definitions for this agent schedule items: $ref: '#/definitions/BuUpdateAgentScheduleShift' fullDayTimeOffMarkers: type: array description: Any full day time off markers that apply to this agent schedule items: $ref: '#/definitions/BuFullDayTimeOffMarker' metadata: description: Version metadata for this agent schedule. Required if updating or deleting an existing agent schedule, otherwise should be omitted $ref: '#/definitions/WfmVersionedEntityMetadata' delete: type: boolean description: Whether to delete this agent's schedule. Defaults to false if not set GenerateBuForecastRequest: type: object required: - description properties: description: type: string description: The description for the forecast weekCount: type: integer format: int32 description: The number of weeks this forecast covers canUseForScheduling: type: boolean description: Whether this forecast can be used for scheduling ValidationServiceRequest: type: object required: - dateImportEnded - uploadKey properties: dateImportEnded: type: string format: date-time description: 'The last day of the data you are importing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' uploadKey: type: string description: S3 key for the uploaded file IgnoredActivityCodeIds: type: object properties: values: type: array description: List of activity code IDs items: type: string OpportunityResult: type: object required: - activityCodeId - agentCount - approvalType - capacity - deadlineDate - endDate - enrollmentCounts - enrollmentProcessingCount - id - metadata - name - startDate - status properties: id: type: string description: The globally unique identifier for the object. startDate: type: string format: date-time description: The start date and time of the opportunity in ISO-8601 format endDate: type: string format: date-time description: The end date and time of the opportunity in ISO-8601 format status: type: string description: The current status of the opportunity enum: - Draft - Published - Open - Pending - Closed openDate: type: string format: date-time description: The date and time when the opportunity opens for enrollment in ISO-8601 format. If not provided or in the past, it will be automatically updated to the current time when the opportunity is published deadlineDate: type: string format: date-time description: The deadline date and time for enrollment in the opportunity in ISO-8601 format name: type: string description: The name of the opportunity description: type: string description: Additional details describing the purpose or context of this opportunity activityCodeId: type: string description: The ID of the activity code associated with the opportunity approvalType: type: string description: The approval type for enrollments enum: - Automatic - Manual agentCount: type: integer format: int32 description: The total number of agents invited to this opportunity capacity: type: integer format: int32 description: The maximum capacity (enrollment slots) for this opportunity enrollmentProcessingCount: type: integer format: int32 description: The number of enrollments currently being processed enrollmentCounts: description: The counts for enrollment statuses $ref: '#/definitions/OpportunityEnrollmentCounts' publishedDate: type: string format: date-time description: The date and time when the opportunity was published in ISO-8601 format closedDate: type: string format: date-time description: The date and time when the opportunity was closed in ISO-8601 format systemMessageCode: type: string description: The system-generated message code about opportunity processing issues or validation failures enum: - ActivityChanged - AgentEnrollmentsHourlyLimitExceeded - BatchLimitExceeded - BusinessUnitEnrollmentsHourlyLimitExceeded - BusinessUnitNotFound - BusinessUnitOpportunityHourlyLimitExceeded - CapacityFull - Conflict - DateMustBeInFuture - DeadlineMustBeAfterOpenTime - DeadlineMustBeBeforeOrEqualToStartTime - EndTimeMustBeAfterStartTime - EnrollmentNotFound - InternalError - InternalErrorAutoApproval - InternalErrorDenial - InternalErrorScheduleUpdate - InvalidOpportunityLength - InvalidOpportunityStatus - InvalidRequest - InvalidStatusTransition - InvalidTime - NoInvitationsForPublish - OpenTimeMustBeBeforeStartTime - OpportunityClosed - OpportunityNotFound - OpportunityNotOpen - ScheduleConflict - ScheduleNotFound - ServiceUnavailable - StartTimeMustBeWithinOneYear - StatusNotDraft metadata: description: The metadata for the opportunity $ref: '#/definitions/WfmVersionedEntityMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true ActivityPlanServiceGoalImpactOverrides: type: object required: - abandonRate - averageSpeedOfAnswer - serviceLevel properties: abandonRate: description: Abandon rate service goal override for the associated activity plan $ref: '#/definitions/ActivityPlanAbandonRateImpactOverride' serviceLevel: description: Service level goal override for the associated activity plan $ref: '#/definitions/ActivityPlanServiceLevelImpactOverride' averageSpeedOfAnswer: description: Average speed of answer service goal override for the associated activity plan $ref: '#/definitions/ActivityPlanAsaImpactOverride' WeekScheduleResponse: type: object properties: result: description: The result of the request. The value will be null if response is large $ref: '#/definitions/WeekSchedule' downloadUrl: type: string description: The url to fetch the result for large responses. The value is null if result contains the data ActivityPlanListing: type: object properties: entities: type: array items: $ref: '#/definitions/ActivityPlanListItem' BulkUpdateShiftTradeListJobRequest: type: object required: - entities - managementUnitIds - weekDates properties: managementUnitIds: type: array description: The IDs of the management units from which to update shift trades uniqueItems: true items: type: string weekDates: type: array description: The start week dates in which the shift trades being updated occur in the business unit time zone (yyyy-MM-dd format) uniqueItems: true items: type: string format: date entities: type: array description: The shift trades that are being updated items: $ref: '#/definitions/BulkUpdateShiftTradeStateRequestItem' AlternativeShiftAsyncResponse: type: object required: - job properties: job: description: The job related to the async request $ref: '#/definitions/AlternativeShiftJobReference' TimeOffIntegrationStatusResponse: type: object required: - integrationStatus - timeOffRequest properties: timeOffRequest: description: The time off request associated with this integration status $ref: '#/definitions/TimeOffRequestReference' integrationStatus: type: string description: The value of integration status for the time off request enum: - Processing - Error - AutomaticallyComplete - ManuallyComplete ShrinkageOverride: type: object required: - intervalIndex properties: intervalIndex: type: integer format: int32 description: Index of shrinkage override interval. Starting index is 0 and indexes are based on 15 minute intervals for a 7 day week shrinkagePercent: type: number format: double description: Shrinkage override percent. Setting a null value will reset the interval to the default ReschedulingOptionsRunResponse: type: object properties: existingSchedule: description: The existing schedule to which this reschedule run applies $ref: '#/definitions/BuScheduleReference' startDate: type: string format: date-time description: 'The start date of the period to reschedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endDate: type: string format: date-time description: 'The end date of the period to reschedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' managementUnits: type: array description: Per-management unit rescheduling options items: $ref: '#/definitions/ReschedulingManagementUnitResponse' agentCount: type: integer format: int32 description: The number of agents to be considered in the reschedule activityCodeIds: type: array description: The IDs of the activity codes being considered for reschedule uniqueItems: true items: type: string doNotChangeWeeklyPaidTime: type: boolean description: Whether weekly paid time is allowed to be changed doNotChangeDailyPaidTime: type: boolean description: Whether daily paid time is allowed to be changed doNotChangeShiftStartTimes: type: boolean description: Whether shift start times are allowed to be changed doNotChangeManuallyEditedShifts: type: boolean description: Whether manually edited shifts are allowed to be changed ShiftTradeEvaluateTradesBuJobResponse: type: object required: - id - status - type properties: id: type: string description: The globally unique identifier for the object. status: type: string description: The status of the job enum: - Processing - Complete - Canceled - Error type: type: string description: The type of the job enum: - AddTrade - BulkUpdateTradeStates - EvaluateTrades - MatchTrade - QueryAgentTrades - QueryTrades - QueryWeekSummaries - SearchUnmatchedTrades - UpdateTrade - UpdateTradeState downloadUrl: type: string description: The URL where completed results might be available for download in case the result body for that job type is too large error: description: Any error information, only set if the status == 'Error' $ref: '#/definitions/ErrorBody' evaluateTradesResult: description: Results for EvaluateTrades job type $ref: '#/definitions/EvaluateShiftTradeListJobResponseItem' selfUri: type: string format: uri description: The URI for this object readOnly: true WfmUserEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/UserReference' BulkOpportunityEnrollmentsStatusUpdateRequest: type: object required: - enrollmentIds - status properties: enrollmentIds: type: array description: The IDs of the enrollments to update items: type: string status: type: string description: The status to set for all enrollments specified in this request enum: - Approved - Denied reviewNote: type: string description: Supervisor's note explaining the agent's enrollment status change ShiftTradeResponseItem: type: object required: - acceptableIntervals - id - initiating - metadata - oneSided - state properties: id: type: string description: The ID of this shift trade state: type: string description: The state of this shift trade enum: - Unmatched - Matched - Approved - Denied - Expired - Canceled expirationDate: type: string format: date-time description: When this shift trade will expire. Date time is represented as an ISO-8601 string initiating: description: Details about the initiating user involved in this shift trade $ref: '#/definitions/ShiftTradeInitiatingSideResponseItem' receiving: description: Details about the receiving user involved in this shift trade $ref: '#/definitions/ShiftTradeReceivingSideResponseItem' acceptableIntervals: type: array description: Time frames when the initiating user is willing to accept trades. Empty means giving up the shift items: $ref: '#/definitions/RequiredDateRange' oneSided: type: boolean description: Whether this is a one-sided shift trade (e.g. the initiating user is not asking for a shift in return) target: description: The user to whom the shift trade request was sent in a direct trade, or the user with whom a shift trade was Matched $ref: '#/definitions/ShiftTradeTargetResponseItem' reviewedBy: description: The admin who approved or denied this shift trade $ref: '#/definitions/UserReference' reviewedDate: type: string format: date-time description: The timestamp of when the trade request was reviewed by an admin in ISO-8601 format metadata: description: Version metadata for this shift trade $ref: '#/definitions/WfmVersionedEntityMetadata' BuUpdateAgentScheduleShift: type: object properties: id: type: string description: The ID of the shift startDate: type: string format: date-time description: 'The start date of this shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true lengthMinutes: type: integer format: int32 description: The length of this shift in minutes readOnly: true activities: type: array description: The activities associated with this shift items: $ref: '#/definitions/BuAgentScheduleActivity' manuallyEdited: type: boolean description: Whether this shift was manually edited. This is only set by clients and is used for rescheduling schedule: description: The schedule to which this shift belongs readOnly: true $ref: '#/definitions/BuScheduleReference' workPlanId: description: The ID of the work plan for which the work plan shift emanates from $ref: '#/definitions/ValueWrapperString' workPlanShiftId: description: The ID of the work plan shift that was used in schedule generation $ref: '#/definitions/ValueWrapperString' delete: type: boolean description: Set to true to delete the shift from the agent's schedule CreateBusinessUnitSettingsRequest: type: object required: - startDayOfWeek - timeZone properties: startDayOfWeek: type: string description: The start day of week for this business unit enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday timeZone: type: string description: The time zone for this business unit, using the Olsen tz database format shortTermForecasting: description: Short term forecasting settings $ref: '#/definitions/BuShortTermForecastingSettings' scheduling: description: Scheduling settings $ref: '#/definitions/BuSchedulingSettingsRequest' notifications: description: Notification settings $ref: '#/definitions/BuNotificationSettingsRequest' learning: description: Learning settings $ref: '#/definitions/BuActivitySettingsRequest' coaching: description: Coaching settings $ref: '#/definitions/BuActivitySettingsRequest' WfmAgentHistoricalAdherenceResult: type: object required: - calculationsCompletedDate - dayMetrics - endDate - impact - secondaryPresenceLookupItems - startDate - targetAdherencePercentage properties: user: description: The user who submitted the agent historical adherence query $ref: '#/definitions/UserReference' startDate: type: string format: date-time description: Beginning of the date range that was queried, in ISO-8601 format endDate: type: string format: date-time description: End of the date range that was queried, in ISO-8601 format. If it was not set, end date will be set to the queried time calculationsCompletedDate: type: string format: date-time description: Completed date of calculations that was queried, in ISO-8601 format. targetAdherencePercentage: type: number format: double description: Target percentage for this user, in the scale of 0 - 100 adherencePercentage: type: number format: double description: Adherence percentage for this user, in the scale of 0 - 100 conformancePercentage: type: number format: double description: Conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period. impact: type: string description: The impact of the current adherence state for this user enum: - Positive - Negative - Neutral - Unknown exceptionInfo: type: array description: List of adherence exceptions for this user items: $ref: '#/definitions/HistoricalAdherenceExceptionInfo' dayMetrics: type: array description: Adherence and conformance metrics for days in query range items: $ref: '#/definitions/AgentAdherenceDayMetrics' actuals: type: array description: List of actual activity with offset for this user items: $ref: '#/definitions/HistoricalAdherenceActuals' scheduledActivities: type: array description: List of scheduled activities for this user items: $ref: '#/definitions/AgentAdherenceScheduledActivity' secondaryPresenceLookupItems: type: array description: List of secondary presence lookup ID to corresponding secondary presence ID item items: $ref: '#/definitions/SecondaryPresenceLookupItem' UpdateMuAgentsRequest: type: object properties: entities: type: array description: List of agents to update items: $ref: '#/definitions/UpdateMuAgentRequest' TimeOffRequestLookup: type: object required: - timeOffRequestId - userId properties: timeOffRequestId: type: string description: The ID of the time off request userId: type: string description: The ID of the user to whom the time off request belongs AlternativeShiftTradeListing: type: object properties: entities: type: array items: $ref: '#/definitions/AlternativeShiftTradeResponse' BuQueryAdherenceExplanationsRequest: type: object required: - endDate - startDate properties: startDate: type: string format: date-time description: 'The start date of the range to query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endDate: type: string format: date-time description: 'The end date of the range to query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' managementUnitIds: type: array description: A filter for which management units to query. Leave empty or omit entirely for all management units in the business unit items: type: string agentIds: type: array description: A filter for which agents within the business unit to query. Leave empty or omit entirely for all agents in the business unit (or management units if specified) items: type: string OverrideDate: type: object required: - date - type properties: date: type: string format: date description: 'The date in yyyy-MM-dd format, interpreted in the business unit’s time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' type: type: string description: The type of override date enum: - Blocked - ManualReview SetWrapperDayOfWeek: type: object properties: values: type: array uniqueItems: true items: type: string enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday BuIntradayDataGroup: type: object properties: mediaType: type: string description: The media type associated with this intraday group enum: - Voice - Chat - Email - Callback - Message - Workitem forecastDataSummary: description: Forecast data summary for this date range $ref: '#/definitions/BuIntradayForecastData' forecastDataPerInterval: type: array description: Forecast data per interval for this date range items: $ref: '#/definitions/BuIntradayForecastData' scheduleDataSummary: description: Schedule data summary for this date range $ref: '#/definitions/BuIntradayScheduleData' scheduleDataPerInterval: type: array description: Schedule data per interval for this date range items: $ref: '#/definitions/BuIntradayScheduleData' performancePredictionDataSummary: description: Performance prediction data summary for this date range $ref: '#/definitions/IntradayPerformancePredictionData' performancePredictionDataPerInterval: type: array description: Performance prediction data per interval for this date range items: $ref: '#/definitions/IntradayPerformancePredictionData' UserStaffingGroupResponse: type: object properties: user: description: The user associated with the staffing group $ref: '#/definitions/UserReference' staffingGroup: description: The current staffing group of the user $ref: '#/definitions/StaffingGroupReference' ShiftTradeQueryWeekSummariesBuJobResponse: type: object required: - id - status - type properties: id: type: string description: The globally unique identifier for the object. status: type: string description: The status of the job enum: - Processing - Complete - Canceled - Error type: type: string description: The type of the job enum: - AddTrade - BulkUpdateTradeStates - EvaluateTrades - MatchTrade - QueryAgentTrades - QueryTrades - QueryWeekSummaries - SearchUnmatchedTrades - UpdateTrade - UpdateTradeState downloadUrl: type: string description: The URL where completed results might be available for download in case the result body for that job type is too large error: description: Any error information, only set if the status == 'Error' $ref: '#/definitions/ErrorBody' queryWeekSummariesResult: description: Results for QueryWeekSummaries job type $ref: '#/definitions/QueryWeekSummaryListJobResponseItem' selfUri: type: string format: uri description: The URI for this object readOnly: true ValidateAgentUnavailableTimesResponse: type: object required: - status properties: id: type: string description: The globally unique identifier for the object. readOnly: true status: type: string description: The current status of the job enum: - Processing - Complete - Canceled - Error result: description: Validation results if status == 'Complete' $ref: '#/definitions/UnavailableTimesValidationResult' UpdateNotificationsRequest: type: object required: - entities properties: entities: type: array description: The notifications to update items: $ref: '#/definitions/WfmUserNotification' StaffingGroupReference: type: object required: - id 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 TeamReference: 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 BuHeadcountForecastBuPlanningGroupHeadcountForecastResult: type: object properties: entities: type: array items: $ref: '#/definitions/BuPlanningGroupHeadcountForecastResult' referenceStartDate: type: string format: date-time description: 'Reference start date for the interval values in each forecast entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' ScheduleSetError: type: object required: - errorCode properties: errorCode: type: string description: Error code that indicates why schedule set optimization failed. At least one of workPlans or workPlanRotations is set if there is an error during optimization enum: - InvalidWorkPlans - InvalidWorkPlanRotations workPlans: type: array description: Work plans involved in the optimization failure items: $ref: '#/definitions/WorkPlanReference' workPlanRotations: type: array description: Work plan rotations involved in the optimization failure items: $ref: '#/definitions/WorkPlanRotationReference' UpdateAgentWorkPlanBiddingPreference: type: object required: - agentWorkPlanBidPreferences - submitted properties: submitted: type: boolean description: Whether the preference is submitted agentWorkPlanBidPreferences: type: array description: The list of work plan bidding preferences items: $ref: '#/definitions/AgentWorkPlanBiddingPreferenceRequest' CapacityPlanDeleteRequest: type: object required: - capacityPlanIds properties: capacityPlanIds: type: array description: The IDs of the capacity plans to be deleted items: type: string SearchShiftTradeResponse: type: object properties: trade: description: A trade which matches search criteria $ref: '#/definitions/ShiftTradeResponse' matchingReceivingShiftIds: type: array description: IDs of shifts which match the search criteria items: type: string preview: description: A preview of what the shift trade would look like if matched $ref: '#/definitions/ShiftTradePreviewResponse' AddOpportunityBody: type: object required: - activityCodeId - approvalType - capacity - deadlineDate - endDate - name - startDate properties: startDate: type: string format: date-time description: The start date and time of the opportunity in ISO-8601 format endDate: type: string format: date-time description: The end date and time of the opportunity in ISO-8601 format openDate: type: string format: date-time description: The date and time when the opportunity opens for enrollment in ISO-8601 format. If not provided or in the past, it will be automatically updated to the current time when the opportunity is published deadlineDate: type: string format: date-time description: The deadline date and time for enrollment in the opportunity in ISO-8601 format name: type: string description: The name of the opportunity description: type: string description: Additional details describing the purpose or context of this opportunity activityCodeId: type: string description: The ID of the activity code associated with the opportunity approvalType: type: string description: The approval type for enrollments enum: - Automatic - Manual capacity: type: integer format: int32 description: The maximum capacity (enrollment slots) for this opportunity BuAgentScheduleQueryResponse: type: object properties: user: description: The user to whom this agent schedule applies $ref: '#/definitions/UserReference' shifts: type: array description: The shift definitions for this agent schedule items: $ref: '#/definitions/BuAgentScheduleShift' fullDayTimeOffMarkers: type: array description: Full day time off markers which apply to this agent schedule items: $ref: '#/definitions/BuFullDayTimeOffMarker' workPlan: description: The work plan for this user $ref: '#/definitions/WorkPlanReference' workPlansPerWeek: type: array description: The work plans per week for this user from the work plan rotation. Null values in the list denotes that user is not part of any work plan for that week items: $ref: '#/definitions/WorkPlanReference' metadata: description: Versioned entity metadata for this agent schedule $ref: '#/definitions/WfmVersionedEntityMetadata' BuScheduleRunListing: type: object properties: entities: type: array items: $ref: '#/definitions/BuScheduleRun' CapacityPlanMetricsSummary: type: object required: - attritionFullTimeEquivalentCount - attritionPercentage - extraTimeUnderTimeFullTimeEquivalentCount - netFullTimeEquivalentCount - newHireFullTimeEquivalentCount - plannedFullTimeEquivalentCount - requiredStaffFullTimeEquivalentCount - shrinkageFullTimeEquivalentCount - shrinkagePercentage - staffingOverUnderFullTimeEquivalentCount - startingFullTimeEquivalentCount - transfersFullTimeEquivalentCount properties: requiredStaffFullTimeEquivalentCount: type: array description: The total staff requirements for all planning groups in the capacity plan, aggregated by the selected time granularity items: type: number format: double plannedFullTimeEquivalentCount: type: array description: The planned full time equivalent for all staffing groups in the capacity plan, aggregated by the selected time granularity items: type: number format: double staffingOverUnderFullTimeEquivalentCount: type: array description: The difference between the summary of planning group required full time equivalent and planned full time equivalent, aggregated by the selected time granularity items: type: number format: double startingFullTimeEquivalentCount: type: array description: The total starting full time equivalent for all staffing groups in the capacity plan, aggregated by the selected time granularity items: type: number format: double attritionFullTimeEquivalentCount: type: array description: The sum of all staffing group attrition full time equivalent in the capacity plan, aggregated by the selected time granularity items: type: number format: double attritionPercentage: type: array description: The total attrition percentage of staffing groups in the capacity plan in the scale of 0.0-100.0, aggregated by the selected time granularity items: type: number format: double newHireFullTimeEquivalentCount: type: array description: The sum of all staffing group new hire full time equivalent in the capacity plan, aggregated by the selected time granularity items: type: number format: double transfersFullTimeEquivalentCount: type: array description: The sum of all staffing group projected transfers of agents into or out of this capacity plan, aggregated by the selected time granularity items: type: number format: double extraTimeUnderTimeFullTimeEquivalentCount: type: array description: The sum of all staffing group extra or under time full time equivalent count in the capacity plan, aggregated by the selected time granularity items: type: number format: double shrinkageFullTimeEquivalentCount: type: array description: The sum of all staffing groups shrinkage full time equivalent, aggregated by the selected time granularity items: type: number format: double shrinkagePercentage: type: array description: The total shrinkage percentage of all staffing groups in the capacity plan in the scale of 0.0-100.0, aggregated by the selected time granularity items: type: number format: double endOfMonthPlannedFullTimeEquivalentCount: type: array description: The total sum of all staffing group end of month planned full time equivalent for this capacity plan, aggregated by the selected time granularity items: type: number format: double netFullTimeEquivalentCount: type: array description: The sum of all staffing groups net full time equivalent in the capacity plan, aggregated by the selected time granularity items: type: number format: double ShiftTradePreviewResponse: type: object properties: activities: type: array description: List of activities that will make up the new shift if this shift trade is approved items: $ref: '#/definitions/ShiftTradeActivityPreviewResponse' BuQueryAgentSchedulesRequest: type: object required: - managementUnitId properties: managementUnitId: type: string description: The ID of the management unit to query userIds: type: array description: 'The IDs of the users to query. Omit to query all user schedules in the management unit. Note: If teamIds is also specified, only schedules for users in the requested teams will be returned' uniqueItems: true items: type: string teamIds: type: array description: The teamIds to request. If null or not set, results will be queried for requested users if applicable or otherwise all users in the management unit uniqueItems: true items: type: string HistoricalShrinkageAggregateResponse: type: object properties: scheduledShrinkageSeconds: type: integer format: int32 description: Aggregated shrinkage value in seconds for scheduled activities scheduledShrinkagePercent: type: number format: double description: Aggregated shrinkage value in percent from 0.0 to 100.0 for scheduled activities actualShrinkageSeconds: type: integer format: int32 description: Aggregated actual value in seconds for scheduled activities actualShrinkagePercent: type: number format: double description: Aggregated actual value in percent from 0.0 to 100.0 for scheduled activities paidShrinkageSeconds: type: integer format: int32 description: Aggregated shrinkage value in seconds for paid activities unpaidShrinkageSeconds: type: integer format: int32 description: Aggregated shrinkage value in seconds for unpaid activities plannedShrinkageSeconds: type: integer format: int32 description: Aggregated shrinkage value in seconds for planned activities unplannedShrinkageSeconds: type: integer format: int32 description: Aggregated shrinkage value in seconds for unplanned activities WorkPlanShift: type: object required: - name properties: name: type: string description: Name of the shift days: description: Days of the week applicable for this shift $ref: '#/definitions/SetWrapperDayOfWeek' flexibleStartTime: type: boolean description: Whether the start time of the shift is flexible exactStartTimeMinutesFromMidnight: type: integer format: int32 description: Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false earliestStartTimeMinutesFromMidnight: type: integer format: int32 description: Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true latestStartTimeMinutesFromMidnight: type: integer format: int32 description: Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true constrainStopTime: type: boolean description: Whether the latest stop time constraint for the shift is enabled. Deprecated, use constrainLatestStopTime instead constrainLatestStopTime: type: boolean description: Whether the latest stop time constraint for the shift is enabled latestStopTimeMinutesFromMidnight: type: integer format: int32 description: Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true constrainEarliestStopTime: type: boolean description: Whether the earliest stop time constraint for the shift is enabled earliestStopTimeMinutesFromMidnight: type: integer format: int32 description: This is the earliest time a shift can end startIncrementMinutes: type: integer format: int32 description: Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true flexiblePaidTime: type: boolean description: Whether the paid time setting for the shift is flexible exactPaidTimeMinutes: type: integer format: int32 description: Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false minimumPaidTimeMinutes: type: integer format: int32 description: Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true maximumPaidTimeMinutes: type: integer format: int32 description: Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true constrainContiguousWorkTime: type: boolean description: Whether the contiguous time constraint for the shift is enabled minimumContiguousWorkTimeMinutes: type: integer format: int32 description: Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true maximumContiguousWorkTimeMinutes: type: integer format: int32 description: Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true constrainDayOff: type: boolean description: Whether day off rule is enabled dayOffRule: type: string description: The day off rule for agents to have next day off or previous day off. used if constrainDayOff = true enum: - NextDayOff - PreviousDayOff planningPeriodConstraints: description: Planning period constraints $ref: '#/definitions/PlanningPeriodShiftConstraints' activities: type: array description: Activities configured for this shift items: $ref: '#/definitions/WorkPlanActivity' id: type: string description: ID of the shift. This is required only for the case of updating an existing shift delete: type: boolean description: If marked true for updating an existing shift, the shift will be permanently deleted validationId: type: string description: ID of shift in the context of work plan validation HistoricalShrinkageResultListing: type: object properties: entities: type: array items: $ref: '#/definitions/HistoricalShrinkageResult' BulkAddOpportunitiesRequest: type: object required: - opportunities properties: opportunities: type: array description: The opportunities to add items: $ref: '#/definitions/AddOpportunityBody' agentIds: type: array description: The IDs of the agents who are invited to the opportunities being added items: type: string SetTimeOffLimitValuesRequest: type: object required: - metadata properties: values: type: array items: $ref: '#/definitions/TimeOffLimitRange' metadata: description: Version metadata for the time off limit $ref: '#/definitions/WfmVersionedEntityMetadata' UpdateTimeOffPlanBusinessUnitAssociation: type: object properties: managementUnitIds: description: The IDs of management units to which this time-off plan applies. This must not be set if staffingGroupIds is populated $ref: '#/definitions/SetWrapperString' staffingGroupIds: description: The IDs of staffing groups to which this time-off plan applies. This must not be set if managementUnitIds is populated $ref: '#/definitions/SetWrapperString' ValidateWorkPlanMessages: type: object properties: violationMessages: type: array description: Messages for work plan violating some rules such as no shifts in a work plan items: $ref: '#/definitions/WorkPlanConfigurationViolationMessage' constraintConflictMessage: description: This field is not null when there is a set of work plan constraints that conflict thus agent schedules cannot be generated $ref: '#/definitions/ConstraintConflictMessage' WorkPlanBid: type: object required: - agentRankingType - bidType - bidWindowEndDate - bidWindowStartDate - effectiveDate - endOverridesAndRotations - id - name - rankingTiebreakerType - status - workPlanFieldsVisibleToAgents properties: id: type: string description: The ID of the work plan bid name: type: string description: The name of the work plan bid forecast: description: The selected forecast in this work plan bid $ref: '#/definitions/BuShortTermForecastWeekReference' bidWindowStartDate: type: string format: date description: 'The bid start date where agents start participate in work plan bidding. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' bidWindowEndDate: type: string format: date description: 'The bid end date. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' effectiveDate: type: string format: date description: 'The date when agents will be assigned to the new work plan. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' status: type: string description: The state of the bid enum: - Draft - Locked - Optimized - Scheduled - Open - Closed - Processed - Published agentRankingType: type: string description: The type of agent ranking selected for this bid enum: - HireDate - Performance rankingTiebreakerType: type: string description: Ranking tiebreaker enum: - HireDate - Performance - Custom - RandomlyAssign publishedDate: type: string format: date-time description: 'The date the work plan bid published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' bidType: type: string description: The type of bid created enum: - WorkPlanBid - ScheduleBid endOverridesAndRotations: type: boolean description: If true, all existing overrides, workplan rotations will be ended one day before effective date of this bid workPlanFieldsVisibleToAgents: type: array description: The work plan fields visible to agents whenever work plan preferences are made items: type: string enum: - Name - PaidHours metadata: description: The meta data of this bid $ref: '#/definitions/WorkPlanBidMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true description: Work plan bid response StaffingRequirementsPlanningGroupData: type: object required: - planningGroupId - staffingRequirementsPerInterval properties: planningGroupId: type: string description: The ID of the planning group to which this data applies staffingRequirementsPerInterval: type: array description: Staffing requirements per interval for this week forecast items: type: number format: double minimumStaffPerInterval: type: array description: Minimum Staff per interval for this week forecast items: type: number format: double effectiveStaffPerInterval: type: array description: Effective Staff per interval for this week forecast items: type: number format: double TimeOffLimitReference: type: object required: - id 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 PlanningGroupOutputs: type: object required: - abandonRatePerInterval - averageSpeedOfAnswerSecondsPerInterval - occupancyPerInterval - planningGroupId - serviceLevelPerInterval properties: planningGroupId: type: string description: The ID for for the associated planning group result serviceLevelPerInterval: type: array description: List of Service Level percentage (0.0-100.0) results per interval items: type: number format: double occupancyPerInterval: type: array description: List of Occupancy percentage (0.0-100.0) results per interval items: type: number format: double averageSpeedOfAnswerSecondsPerInterval: type: array description: List of Average Speed of Answer (in seconds) results per interval items: type: number format: double abandonRatePerInterval: type: array description: List of Abandon rate percentage (0.0-100.0) results per interval items: type: number format: double CreateTimeOffPlanManagementUnitAssociation: type: object required: - managementUnitId properties: managementUnitId: type: string description: The ID of the management unit to which this time-off plan belongs staffingGroupIds: type: array description: A IDs of staffing groups to which this time-off plan applies. If not defined, the plan is applied to the management unit uniqueItems: true items: type: string TimeOffLimitRange: type: object required: - granularity - limitMinutesPerInterval - startDate properties: startDate: type: string format: date description: 'Start date of the range. The end date is determined by ''granularity'' and the size of ''limitMinutesPerInterval''. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' granularity: type: string description: Granularity choice for the time-off limit enum: - Daily - FifteenMinutes limitMinutesPerInterval: type: array description: The list of time off limit values in minutes per granularity interval. If 'null' is specified, then interval specific value is cleared. Such interval will have 'defaultLimitMinutes' value items: type: integer format: int32 UserScheduleAdherenceListing: type: object properties: entities: type: array items: $ref: '#/definitions/UserScheduleAdherence' downloadUrl: type: string description: The downloadUrl if the response is too large to send directly via http response readOnly: true AgentAssignedShiftSet: type: object required: - agents - effectiveWorkPlan - id - shifts properties: id: type: string description: The ID of the shift set effectiveWorkPlan: description: The work plan or work plan rotation used for generating the shift set $ref: '#/definitions/ShiftSetEffectiveWorkPlan' shifts: type: array description: The scheduled shifts items: $ref: '#/definitions/ScheduleBidScheduledShift' agents: type: array description: The details of the agents assigned to this shift set items: $ref: '#/definitions/AssignedAgentDetails' UpdateTimeOffLimitRequest: type: object required: - metadata properties: defaultLimitMinutes: type: integer format: int32 description: The default time off limit value in minutes per granularity metadata: description: Version metadata for the time off limit $ref: '#/definitions/WfmVersionedEntityMetadata' AgentMuQueryResponse: type: object required: - operationId - status properties: status: type: string description: The status of the operation enum: - Processing - Complete - Canceled - Error operationId: type: string description: The ID for the operation result: description: The schema of the result of the operation. Null if downloadUrl is populated, but defines the schema of the data that will be returned from the downloadUrl $ref: '#/definitions/AgentMuScheduleResult' downloadUrl: type: string description: The URL from which to download the result. The result will follow the schema documented by the result field error: description: Error details if status == 'Error'. Will always be null but the schema is documented in case of an error in an async notification $ref: '#/definitions/ErrorBody' SearchShiftTradesResponse: type: object properties: trades: type: array description: The shift trades that match the search criteria items: $ref: '#/definitions/SearchShiftTradeResponse' downloadUrl: type: string description: URL from which to fetch results for requests with a large result set. If populated, the downloaded data will conform to the same schema as would normally be returned, excepting downloaded data will never itself contain a downloadUrl AlternativeShiftJobResponse: type: object required: - status - type properties: id: type: string description: The globally unique identifier for the object. readOnly: true status: type: string description: The status of the alternative shift job enum: - Processing - Complete - Error type: type: string description: The type of job enum: - ListOffers - SearchOffers - ListUserTrades - SearchTrades - BulkUpdateTrades downloadUrl: type: string description: The URL where completed results are available, only set if status == 'Complete' error: description: Any error information, only set if the status == 'Error' $ref: '#/definitions/ErrorBody' viewOffersResults: description: Schema template for deserializing data returned from the downloadUrl. Use if type == 'ListOffers' or 'SearchOffers' $ref: '#/definitions/AlternativeShiftOffersViewResponseTemplate' viewTradesResults: description: Schema template for deserializing data returned from the downloadUrl. Use if type == 'ListUserTrades' or 'SearchTrades' $ref: '#/definitions/AlternativeShiftTradesViewResponseTemplate' bulkUpdateTradesResults: description: Schema template for deserializing data returned from the downloadUrl. Use if type == 'BulkUpdateTrades' $ref: '#/definitions/AlternativeShiftBulkUpdateTradesResponseTemplate' selfUri: type: string format: uri description: The URI for this object readOnly: true AdherenceExplanationListingBuQueryResponse: type: object properties: entities: type: array items: $ref: '#/definitions/AdherenceExplanationResponse' ScheduleBidGroup: type: object required: - agents - managementUnit - name - planningGroups properties: name: type: string description: The name of the schedule bid group managementUnit: description: The management unit to which this bid group belongs $ref: '#/definitions/ManagementUnitReference' agents: type: array description: The agents who participate in this bid group items: $ref: '#/definitions/UserReference' workPlans: type: array description: The work plans used in this bid group items: $ref: '#/definitions/WorkPlanReference' workPlanRotations: type: array description: The work plan rotations used in this bid group items: $ref: '#/definitions/BidGroupWorkPlanRotationResponse' planningGroups: type: array description: The planning groups selected in this bid group items: $ref: '#/definitions/PlanningGroupReference' downloadUrl: type: string description: The downloadUrl to fetch Schedule sets. It will be populated if the status of this bid is 'Optimized' downloadTemplate: description: Schedule sets always come through downloadUrl, the schema included here is just for documentation $ref: '#/definitions/BidGroupScheduleSet' QueryWaitlistPositionsRequest: type: object required: - timeOffRequests properties: timeOffRequests: type: array description: The list of the time off request ids for which to fetch the daily waitlist positions items: $ref: '#/definitions/UserTimeOffRequestReference' BuAgentScheduleShift: type: object properties: id: type: string description: The ID of the shift startDate: type: string format: date-time description: 'The start date of this shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true lengthMinutes: type: integer format: int32 description: The length of this shift in minutes readOnly: true activities: type: array description: The activities associated with this shift items: $ref: '#/definitions/BuAgentScheduleActivity' manuallyEdited: type: boolean description: Whether this shift was manually edited. This is only set by clients and is used for rescheduling schedule: description: The schedule to which this shift belongs readOnly: true $ref: '#/definitions/BuScheduleReference' workPlanId: type: string description: The ID of the work plan for which the work plan shift emanates from workPlanShiftId: type: string description: The ID of the work plan shift that was used in schedule generation AlternativeShiftOffersRequest: type: object required: - queryWeekDate - schedule properties: schedule: description: The existing schedule being used to find alternative shift offers $ref: '#/definitions/AlternativeShiftScheduleLookup' queryWeekDate: type: string format: date description: 'The start date for the week in this schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' AgentMuScheduleItem: type: object required: - agent - fullDayTimeOffMarkerDates - shifts properties: agent: description: 'The agent to whom this schedule applies. Note: selfUri will not be populated if retrieving result via downloadUrl' $ref: '#/definitions/UserReference' shifts: type: array description: The shift definitions for this agent schedule items: $ref: '#/definitions/AgentMuScheduleShift' fullDayTimeOffMarkerDates: type: array description: The full day time off marker dates which apply to this agent schedule, interpreted in the time zone of the relevant business unit items: type: string format: date WfmHistoricalAdherenceBulkItem: type: object required: - endDate - managementUnitId - startDate properties: managementUnitId: type: string description: The ID of the management unit to query startDate: type: string format: date-time description: Beginning of the date range to query in ISO-8601 format endDate: type: string format: date-time description: End of the date range to query in ISO-8601 format userIds: type: array description: The IDs of the users to query. If not included, will query every user in the management unit uniqueItems: true items: type: string includeExceptions: type: boolean description: Whether user exceptions should be returned as part of the results. Defaults to false if not specified. includeActuals: type: boolean description: Whether user actual activities should be returned as part of the results. Defaults to false if not specified. AgentsIntegrationsListing: type: object properties: entities: type: array items: $ref: '#/definitions/AgentIntegrationsResponse' AdminTimeOffRequestPatch: type: object required: - metadata properties: status: type: string description: The status of this time off request enum: - PENDING - APPROVED - DENIED activityCodeId: type: string description: The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category paid: type: boolean description: Whether this is a paid time off request notes: type: string description: Notes about the time off request fullDayManagementUnitDates: type: array description: A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone items: type: string fullDayEarliestStartOffsetMinutes: description: Earliest start offset in minutes for each full-day request date. Values may be null when time-off estimation is disabled or no estimate is available $ref: '#/definitions/ListWrapperInteger' fullDayLatestEndOffsetMinutes: description: Latest end offset in minutes for each full-day request date. Values may be null when time-off estimation is disabled or no estimate is available $ref: '#/definitions/ListWrapperInteger' partialDayStartDateTimes: type: array description: A set of start date-times in ISO-8601 format for partial day requests items: type: string format: date-time dailyDurationMinutes: type: integer format: int32 description: The daily duration of this time off request in minutes durationMinutes: type: array description: Daily durations for each day of this time off request in minutes items: type: integer format: int32 payableMinutes: type: array description: Payable minutes for each day of this time off request items: type: integer format: int32 metadata: description: Version metadata for the time off request $ref: '#/definitions/WfmVersionedEntityMetadata' ShiftTradeQueryTradesBuJobResponse: type: object required: - id - status - type properties: id: type: string description: The globally unique identifier for the object. status: type: string description: The status of the job enum: - Processing - Complete - Canceled - Error type: type: string description: The type of the job enum: - AddTrade - BulkUpdateTradeStates - EvaluateTrades - MatchTrade - QueryAgentTrades - QueryTrades - QueryWeekSummaries - SearchUnmatchedTrades - UpdateTrade - UpdateTradeState downloadUrl: type: string description: The URL where completed results might be available for download in case the result body for that job type is too large error: description: Any error information, only set if the status == 'Error' $ref: '#/definitions/ErrorBody' queryTradesResult: description: Results for QueryTrades job type $ref: '#/definitions/ShiftTradeListJobResponse' selfUri: type: string format: uri description: The URI for this object readOnly: true QueryAgentUnavailableTimesRequest: type: object required: - endDate - startDate properties: startDate: type: string format: date-time description: 'The earliest date to retrieve agent unavailability times. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endDate: type: string format: date-time description: 'The latest date to retrieve agent unavailability times. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' ManagementUnitSettingsRequest: type: object required: - metadata properties: adherence: description: Adherence settings for this management unit $ref: '#/definitions/AdherenceSettings' shortTermForecasting: description: Short term forecasting settings for this management unit. Moving to Business Unit $ref: '#/definitions/ShortTermForecastingSettings' timeOff: description: Time off request settings for this management unit $ref: '#/definitions/TimeOffSettingsRequest' scheduling: description: Scheduling settings for this management unit $ref: '#/definitions/SchedulingSettingsRequest' shiftTrading: description: Shift trade settings for this management unit $ref: '#/definitions/ShiftTradeSettings' metadata: description: Version info metadata for the associated management unit $ref: '#/definitions/WfmVersionedEntityMetadata' MinimumStaffingRequest: type: object properties: enabled: type: boolean description: Whether the setting is turned on or off minimumValue: type: number format: double description: Default minimum staff value to be applied to all planning groups planningGroupOverrides: description: List of planning groups with their minimum staff value overrides and the days to which the overrides apply. Setting the enclosed list to empty will clear out all existing overrides $ref: '#/definitions/ListWrapperPlanningGroupMinimumsRequest' applicableIntervals: type: string description: The intervals to which the minimum staff values will apply enum: - AllIntervals - VolumeOnlyIntervals CreateBusinessUnitRequest: type: object required: - divisionId - name - settings properties: name: type: string description: The name of the business unit divisionId: type: string description: The ID of the division to which the business unit should be added settings: description: Configuration for the business unit $ref: '#/definitions/CreateBusinessUnitSettingsRequest' ForecastServiceGoalTemplateImpactOverrideResponse: type: object properties: serviceLevel: description: Allowed service level percent increase and decrease; undefined if the goal is not enabled $ref: '#/definitions/WfmServiceGoalImpact' averageSpeedOfAnswer: description: Allowed average speed of answer percent increase and decrease; undefined if the goal is not enabled $ref: '#/definitions/WfmServiceGoalImpact' abandonRate: description: Allowed abandon rate percent increase and decrease; undefined if the goal is not enabled $ref: '#/definitions/WfmServiceGoalImpact' AdminAgentScheduleBidPreferenceResponse: type: object properties: result: description: The agents' schedule set preferences $ref: '#/definitions/AdminAgentScheduleSetPreferences' downloadUrl: type: string description: URL to retrieve results when the response contains a large dataset. If provided, the downloaded data will follow the same schema as the result. ScheduleGenerationMessage: type: object properties: type: type: string description: The type of the message enum: - AgentNotFound - AgentNotInSelectedManagementUnit - AgentNotLicensed - AgentWithoutWorkPlan - WorkPlanNotEnabled - WorkPlanNotFound - AgentWithoutCapability - NoNeedDays - UnableToProduceAgentSchedule - UnableToScheduleMinCoverageForPlanningGroup - UnableToScheduleMaxConsecutiveWorkingDays - UnableToScheduleMaxConsecutiveWorkingWeekends - UnableToScheduleMaxWeeklyPaidTime - UnableToScheduleMaxWeeklyWorkDays - UnableToScheduleMaxWorkDayPaidTime - UnableToScheduleMinConsecutiveNonWorkingTimePerWeek - UnableToScheduleMinIntershiftTime - UnableToScheduleMinShiftStartDistance - UnableToScheduleMinWeeklyPaidTime - UnableToScheduleMinWeeklyWorkDays - UnableToScheduleMinWorkDayPaidTime - UnableToSchedulePlanningPeriodMaxDaysOff - UnableToSchedulePlanningPeriodMaxPaidTime - UnableToSchedulePlanningPeriodMinDaysOff - UnableToSchedulePlanningPeriodMinPaidTime - UnableToScheduleShiftVariance - UnableToScheduleWorkDay - UnableToScheduleMaxConsecutiveWorkingDaysFromAgentHistory - UnableToScheduleMaxConsecutiveWorkingWeekendsFromAgentHistory - UnableToScheduleMaxWeeklyPaidTimeFromTimeOff - UnableToScheduleMaxWorkDayPaidTimeFromTimeOff - UnableToScheduleMinIntershiftTimeFromAgentHistory - UnableToScheduleMinIntershiftTimeFromDst - UnableToScheduleMinShiftStartDistanceFromAgentHistory - UnableToScheduleMinShiftStartDistanceFromDst - UnableToScheduleMinWeeklyPaidTimeFromTimeOff - UnableToScheduleMinWeeklyWorkDaysFromTimeOff - UnableToScheduleMinWorkDayPaidTimeFromTimeOff - UnableToSchedulePlanningPeriodMaxDaysOffFromAgentHistory - UnableToSchedulePlanningPeriodMaxDaysOffFromTimeOff - UnableToSchedulePlanningPeriodMaxPaidTimeFromAgentHistory - UnableToSchedulePlanningPeriodMaxPaidTimeFromTimeOff - UnableToSchedulePlanningPeriodMinDaysOffFromAgentHistory - UnableToSchedulePlanningPeriodMinPaidTimeFromAgentHistory - UnableToSchedulePlanningPeriodMinPaidTimeFromTimeOff - UnableToScheduleWorkDayFromTimeOff - AgentWithoutCapabilityToHandleActivityOnQueueWork - UnableToProduceAgentScheduleDueToUnavailableTimes - UnableToScheduleMaxActivityLengthFromShiftEndFromDst - UnableToScheduleMaxActivityLengthFromShiftEndFromTimeOff - UnableToScheduleMaxShiftStartAndPaidDurationVarianceFromTimeOff - UnableToScheduleMaxShiftStartTimeVarianceFromDst - UnableToScheduleMaxShiftStartTimeVarianceFromTimeOff - UnableToScheduleMinActivityLengthFromShiftEndFromDst - UnableToScheduleMinActivityLengthFromShiftStartFromDst - UnableToSchedulePlanningPeriodMaxShiftStartAndPaidDurationVarianceFromAgentHistory - UnableToSchedulePlanningPeriodMaxShiftStartAndPaidDurationVarianceFromTimeOff - UnableToSchedulePlanningPeriodMaxShiftStartTimeVarianceFromAgentHistory - UnableToSchedulePlanningPeriodMaxShiftStartTimeVarianceFromDst - UnableToSchedulePlanningPeriodMaxShiftStartTimeVarianceFromTimeOff - UnableToSchedulePlanningPeriodMaxWorkingWeekendsFromAgentHistory - UnableToSchedulePlanningPeriodShiftMaxCountFromAgentHistory - UnableToSchedulePlanningPeriodShiftMinCountFromAgentHistory arguments: type: array description: The arguments describing the message items: $ref: '#/definitions/SchedulerMessageArgument' AdherenceExplanationListing: type: object properties: entities: type: array items: $ref: '#/definitions/AdherenceExplanationResponse' CreateCapacityPlanStaffingGroupMetricChangeRequest: type: object required: - metric - numberOfWeeks - staffingGroupIds - value - version - weekStartNumber properties: numberOfWeeks: type: integer format: int32 description: The number of weeks to which the metric change applies weekStartNumber: type: integer format: int32 description: The start number of the week (starting from 1) to which the metric change applies, related to numberOfWeeks value: type: number format: double description: The value of the metric metric: type: string description: The metric which is going to be modified for the selected staffing groups enum: - StartingWeeklyFullTimeEquivalentCount - NewHiresFullTimeEquivalentCount - AttritionPercentage - ShrinkagePercentage - TransfersFullTimeEquivalentCount - ExtraTimeUnderTimeFullTimeEquivalentCount notes: type: string description: Notes about the staffing groups metric changes transfersFullTimeEquivalent: description: Full time equivalent transfer from one staffing group to another $ref: '#/definitions/TransfersFullTimeEquivalent' staffingGroupIds: type: array description: The IDs of the staffing groups affected by the metric change items: type: string version: type: integer format: int32 description: The version of the capacity plan MoveManagementUnitRequest: type: object required: - businessUnitId properties: businessUnitId: type: string description: The ID of the business unit to which to move the management unit AgentQueryAdherenceExplanationsRequest: type: object required: - endDate - startDate properties: startDate: type: string format: date-time description: 'The start date of the range to query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endDate: type: string format: date-time description: 'The end date of the range to query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' BuAlternativeShiftJobResponse: type: object required: - id - status - type properties: id: type: string description: The globally unique identifier for the object. status: type: string description: The status of the alternative shift job enum: - Processing - Complete - Error type: type: string description: The type of job enum: - ListOffers - SearchOffers - ListUserTrades - SearchTrades - BulkUpdateTrades downloadUrl: type: string description: The URL where completed results are available, only set if status == 'Complete' error: description: Any error information, only set if the status == 'Error' $ref: '#/definitions/ErrorBody' viewOffersResults: description: Schema template for deserializing data returned from the downloadUrl. Use if type == 'ListOffers' or 'SearchOffers' $ref: '#/definitions/AlternativeShiftOffersViewResponseTemplate' viewTradesResults: description: Schema template for deserializing data returned from the downloadUrl. Use if type == 'ListUserTrades' or 'SearchTrades' $ref: '#/definitions/AlternativeShiftTradesViewResponseTemplate' bulkUpdateTradesResults: description: Schema template for deserializing data returned from the downloadUrl. Use if type == 'BulkUpdateTrades' $ref: '#/definitions/AlternativeShiftBulkUpdateTradesResponseTemplate' selfUri: type: string format: uri description: The URI for this object readOnly: true BuAgentScheduleHistoryChange: type: object properties: metadata: description: The metadata of the change, including who and when the change was made $ref: '#/definitions/BuAgentScheduleHistoryChangeMetadata' shifts: type: array description: The list of changed shifts items: $ref: '#/definitions/BuAgentScheduleShift' fullDayTimeOffMarkers: type: array description: The list of changed full day time off markers items: $ref: '#/definitions/BuFullDayTimeOffMarker' deletes: description: The deleted shifts, full day time off markers, or the entire agent schedule $ref: '#/definitions/BuAgentScheduleHistoryDeletedChange' BulkOpportunitiesEnrollmentResult: type: object required: - enrollment - status properties: status: type: string description: The status indicating the result of the bulk operation for this item enum: - Complete - Error error: description: The error result if the operation failed $ref: '#/definitions/BulkOpportunitiesError' enrollment: description: The enrollment result $ref: '#/definitions/OpportunityEnrollment' UnavailableTimesManagementUnitSettings: type: object required: - enabled - managementUnit properties: managementUnit: description: The management unit to which these settings apply $ref: '#/definitions/ManagementUnitReference' enabled: type: boolean description: Indicates whether agent availability is enabled for the management unit AgentWorkPlanActivity: type: object required: - countsAsPaidTime - lengthMinutes properties: lengthMinutes: type: integer format: int32 description: Length of the activity in minutes countsAsPaidTime: type: boolean description: Whether the activity is paid BuForecastResult: type: object properties: referenceStartDate: type: string format: date-time description: 'The reference start date for interval-based data for this forecast. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' planningGroups: type: array description: The forecast data broken up by planning group items: $ref: '#/definitions/ForecastPlanningGroupData' weekNumber: type: integer format: int32 description: The week number represented by this response weekCount: type: integer format: int32 description: The number of weeks in this forecast AgentQueryOpportunityResult: type: object required: - activityCodeId - capacity - deadlineDate - endDate - enrollmentCounts - metadata - name - startDate - status properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the opportunity description: type: string description: Additional details describing the purpose or context of this opportunity activityCodeId: type: string description: The ID of the activity code associated with the opportunity startDate: type: string format: date-time description: The start date and time of the opportunity in ISO-8601 format endDate: type: string format: date-time description: The end date and time of the opportunity in ISO-8601 format deadlineDate: type: string format: date-time description: The deadline date and time for enrollment in the opportunity in ISO-8601 format status: type: string description: The current status of the opportunity enum: - Draft - Published - Open - Pending - Closed capacity: type: integer format: int32 description: The maximum capacity for this opportunity enrollmentCounts: description: Subset of enrollment counts which are relevant to the agent $ref: '#/definitions/PendingAndApprovedOpportunityEnrollmentCounts' enrollment: description: The agent's enrollment in this opportunity, if enrolled $ref: '#/definitions/AgentOpportunityEnrollmentResult' metadata: description: The metadata for the opportunity $ref: '#/definitions/WfmVersionedEntityMetadata' CurrentUserScheduleRequestBody: type: object required: - endDate - startDate properties: startDate: type: string format: date-time description: Beginning of the range of schedules to fetch, in ISO-8601 format endDate: type: string format: date-time description: End of the range of schedules to fetch, in ISO-8601 format loadFullWeeks: type: boolean description: Whether to load the full week's schedule (for the current user) of any week overlapping the start/end date query parameters, defaults to false ManagementUnitListing: type: object properties: entities: type: array items: $ref: '#/definitions/ManagementUnit' pageSize: type: integer format: int32 description: Deprecated, paging is not supported pageNumber: type: integer format: int32 description: Deprecated, paging is not supported total: type: integer format: int64 description: Deprecated, paging is not supported firstUri: type: string format: uri description: Deprecated, paging is not supported pageCount: type: integer format: int32 description: Deprecated, paging is not supported nextUri: type: string format: uri description: Deprecated, paging is not supported previousUri: type: string format: uri description: Deprecated, paging is not supported lastUri: type: string format: uri description: Deprecated, paging is not supported selfUri: type: string format: uri ShiftTradeActivityPreviewResponse: type: object properties: startDate: type: string format: date-time description: 'The start date and time of this activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' lengthMinutes: type: integer format: int32 description: The length in minutes of this activity activityCodeId: type: string description: The ID of the activity code for this activity countsAsPaidTime: type: boolean description: Whether this activity counts as paid time payableMinutes: type: integer format: int32 description: Payable minutes for this activity externalActivityType: type: string description: The type of the external activity associated with this activity, if applicable enum: - ActivityPlan - Coaching - Learning - Opportunity externalActivityId: type: string description: The ID of the external activity associated with this activity, if applicable BulkPublishOpportunitiesResponse: type: object required: - errorCount - results properties: results: type: array description: The result for each requested item items: $ref: '#/definitions/BulkOpportunitiesReferenceResult' errorCount: type: integer format: int32 description: The count of failed operations in the bulk request UpdateWorkPlanBid: type: object properties: name: type: string description: The name of the work plan bid forecast: description: The selected forecast in this work plan bid $ref: '#/definitions/BuShortTermForecastWeekReference' bidWindowStartDate: type: string format: date description: 'The bid start date where agents start participate in work plan bidding in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' bidWindowEndDate: type: string format: date description: 'The bid end date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' effectiveDate: type: string format: date description: 'The date when agents will be assigned to the new work plan in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' agentRankingType: type: string description: The type of agent ranking selected for this bid enum: - HireDate - Performance rankingTiebreakerType: type: string description: Ranking tiebreaker enum: - HireDate - Performance - Custom - RandomlyAssign endOverridesAndRotations: type: boolean description: If true, all existing overrides, workplan rotations will be ended one day before effective date of this bid workPlanFieldsVisibleToAgents: description: The work plan fields visible to agents whenever work plan preferences are made $ref: '#/definitions/ListWrapperAgentWorkPlanField' status: type: string description: The state of the bid enum: - Draft - Locked - Optimized - Scheduled - Open - Closed - Processed - Published description: Update work plan bid model BuAsyncAgentSchedulesQueryResponse: type: object properties: status: type: string description: The status of the operation enum: - Processing - Complete - Canceled - Error operationId: type: string description: The ID for the operation result: description: The result of the operation. Null unless status == Complete $ref: '#/definitions/BuAgentSchedulesQueryResponse' progress: type: integer format: int32 description: Percent progress for the operation downloadUrl: type: string description: The URL from which to download the result if it is too large to pass directly LongTermRequirementsServiceGoalDetail: type: object required: - id - serviceGoals properties: id: type: string description: Service goal template ID serviceGoals: description: 'The service goals used to generate the requirements ' $ref: '#/definitions/LongTermRequirementsServiceGoal' QueryCapacityPlanStaffingGroupMetricChangeHistory: type: object required: - staffingGroupIds properties: staffingGroupIds: type: array description: The IDs of the staffing groups for which to fetch the metric change history items: type: string queryEndDate: type: string format: date-time description: Fetch the history of metric changes on or before this date, in IS0-8601 format. If not specified, sets to current date QueryShiftTradeListJobRequest: type: object required: - managementUnitIds - userIds - weekDates properties: managementUnitIds: type: array description: The IDs of management units from which to query shift trades uniqueItems: true items: type: string weekDates: type: array description: The start week dates in which to query shift trades in the business unit time zone (yyyy-MM-dd format) uniqueItems: true items: type: string format: date userIds: type: array description: The IDs of the users for whom to query trades uniqueItems: true items: type: string TimeOffRequestQueryBody: type: object properties: ids: type: array description: The set of ids to filter time off requests uniqueItems: true items: type: string userIds: type: array description: The set of user ids to filter time off requests uniqueItems: true items: type: string statuses: type: array description: The set of statuses to filter time off requests uniqueItems: true items: type: string enum: - PENDING - APPROVED - DENIED - CANCELED substatuses: type: array description: The set of substatuses to filter time off requests uniqueItems: true items: type: string enum: - AdvanceTimeElapsed - AutoApproved - BlockedDate - InsufficientBalance - InvalidDailyDuration - ManualApproval - OutsideShift - OverlapsRestrictedActivityCode - RemovedFromWaitlist - ReviewDate - Waitlisted dateRange: description: The inclusive range of dates to filter time off requests $ref: '#/definitions/DateRange' StaffingGroupListing: type: object properties: entities: type: array items: $ref: '#/definitions/StaffingGroupResponse' downloadUrl: type: string description: URL from which to fetch results for requests with a large result set. If populated, the downloaded data will conform to the same schema as would normally be returned, excepting downloaded data will never itself contain a downloadUrl ValueWrapperString: type: object properties: value: type: string description: The value for the associated field ReschedulingManagementUnitResponse: type: object properties: managementUnit: description: The management unit $ref: '#/definitions/ManagementUnitReference' applied: type: boolean description: Whether the rescheduling run is applied for the given management unit QueryUserStaffingGroupListRequest: type: object required: - userIds properties: userIds: type: array description: The set of user IDs to fetch associated staffing groups uniqueItems: true items: type: string AgentBulkAddOpportunityEnrollmentResult: type: object required: - enrollment - status properties: status: type: string description: The status indicating the result of the bulk operation for this item enum: - Complete - Error error: description: The error result if the operation failed $ref: '#/definitions/BulkOpportunitiesError' enrollment: description: The enrollment result that was added $ref: '#/definitions/AgentBulkAddOpportunityEnrollment' AdherenceExplanationResponse: type: object required: - agent - businessUnit - lengthMinutes - managementUnit - startDate - status - type properties: id: type: string description: The globally unique identifier for the object. readOnly: true agent: description: The agent to whom this adherence explanation applies $ref: '#/definitions/UserReference' managementUnit: description: The management unit to which the agent belonged at the time the adherence explanation was submitted $ref: '#/definitions/ManagementUnitReference' businessUnit: description: The business unit to which the agent belonged at the time the adherence explanation was submitted $ref: '#/definitions/BusinessUnitReference' type: type: string description: The type of the adherence explanation enum: - Late status: type: string description: The status of the adherence explanation enum: - Pending - Approved - Denied startDate: type: string format: date-time description: The start timestamp of the adherence explanation in ISO-8601 format lengthMinutes: type: integer format: int32 description: The length of the adherence explanation in minutes notes: type: string description: Notes about the adherence explanation reviewedBy: description: The user who reviewed the adherence explanation, if applicable. The id may be 'System' if it was an automated process $ref: '#/definitions/UserReference' reviewedDate: type: string format: date-time description: 'The timestamp for when the adherence explanation was reviewed, if applicable. 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 WorkPlanBidGroupCreate: type: object required: - agentIds - managementUnitId - name - planningGroupIds - workPlans properties: name: type: string description: The name of the work plan bid group managementUnitId: type: string description: The management unit ID this bid group belongs to agentIds: type: array description: Agent IDs who participate in this bid group items: type: string workPlans: type: array description: The list of work plans used in this bid group items: $ref: '#/definitions/BidGroupWorkPlanRequest' planningGroupIds: type: array description: The planning group IDs selected in this bid group items: type: string ValidateWorkPlanResponse: type: object properties: workPlan: description: The work plan reference associated with this response $ref: '#/definitions/WorkPlanReference' valid: type: boolean description: Whether the work plan is valid or not messages: description: Validation messages for this work plan $ref: '#/definitions/ValidateWorkPlanMessages' WorkPlanListResponse: type: object properties: entities: type: array items: $ref: '#/definitions/WorkPlanListItemResponse' ScheduleBidGroupReference: type: object required: - id 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 AgentBulkStatusUpdateOpportunityEnrollmentsRequest: type: object required: - enrollmentIds - status properties: enrollmentIds: type: array description: The IDs of the enrollments to update items: type: string status: type: string description: The status to set for all enrollments specified in this request enum: - Withdrawn AdherenceExplanationAsyncResponse: type: object properties: job: description: A reference to the job that was started by the request $ref: '#/definitions/AdherenceExplanationJobReference' ListWrapperInteger: type: object properties: values: type: array items: type: integer format: int32 MatchShiftTradeJobRequest: type: object required: - metadata - receivingSchedule - weekDate properties: weekDate: type: string format: date description: 'The start week date of the initiating shift in the business unit time zone (yyyy-MM-dd format). Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' receivingSchedule: description: Associated schedule information for the receiving user $ref: '#/definitions/ReceivingScheduleLookup' receivingShiftId: type: string description: The ID of the shift the receiving user is giving up in trade, if applicable metadata: description: Version metadata for the shift trade $ref: '#/definitions/WfmVersionedEntityMetadata' AdherenceExplanationListingAgentQueryResponse: type: object properties: entities: type: array items: $ref: '#/definitions/AdherenceExplanationResponse' ScheduleBidScheduledShift: type: object required: - activities - lengthMinutes - startDate properties: workPlanShiftId: type: string description: The ID of the work plan shift that was used in schedule generation workPlanId: type: string description: The ID of the work plan from which the shift comes startDate: type: string format: date-time description: 'The start date of the scheduled shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' lengthMinutes: type: integer format: int32 description: The length of the shift in minutes activities: type: array description: The activities associated with this shift items: $ref: '#/definitions/ScheduleBidScheduledActivity' BuForecastTimeSeriesResult: type: object properties: metric: type: string description: The metric this result applies to enum: - Offered - AverageHandleTimeSeconds forecastingMethod: type: string description: The forecasting method that was used for this metric enum: - AutoRegressiveIntegratedMovingAverage - MovingAverage - SingleExponentialSmoothing - RandomWalk - DecompositionUsingAdditiveSeasonality - DecompositionUsingMultiplicativeSeasonality - HoltWintersAdditiveSeasonality - HoltWintersAdditiveSeasonalityWithDampedTrend - HoltWintersMultiplicativeSeasonality - HoltWintersMultiplicativeSeasonalityWithDampedTrend - DampedLinearExponentialSmoothing - DoubleExponentialSmoothing - DoubleMovingAverage - LinearExponentialSmoothing - LinearWeightedMovingAverage - PointEstimateUsingDampedLinearExponentialSmoothing - PointEstimateUsingDoubleExponentialSmoothing - PointEstimateUsingLatestWeek - PointEstimateUsingLinearExponentialSmoothing - PointEstimateUsingWeightedAverage - CurveFit - MultiLinearRegression - DynamicHarmonicRegression - Theta - Ensemble - Other forecastType: type: string description: The forecasting type in this forecast result enum: - LongTerm - ShortTerm ImportForecastUploadResponse: type: object properties: uploadKey: type: string description: The key to pass to the secondary request to start processing of the upload url: type: string description: The url to which to PUT the upload body headers: type: object description: Required headers for the PUT request to the url additionalProperties: type: string uploadBodySchema: description: Always null. Defines the schema of the json body to be PUT to the url. The json body should be gzip encoded before uploading $ref: '#/definitions/BuImportShortTermForecastSchema' UserSchedule: type: object required: - metadata properties: shifts: type: array description: The shifts that belong to this schedule items: $ref: '#/definitions/UserScheduleShift' fullDayTimeOffMarkers: type: array description: Markers to indicate a full day time off request, relative to the management unit time zone items: $ref: '#/definitions/UserScheduleFullDayTimeOffMarker' delete: type: boolean description: If marked true for updating an existing user schedule, it will be deleted metadata: description: Version metadata for this schedule $ref: '#/definitions/WfmVersionedEntityMetadata' workPlanId: type: string description: ID of the work plan associated with the user during schedule creation readOnly: true ListWrapperBidGroupWorkPlanRotationRequest: type: object properties: values: type: array items: $ref: '#/definitions/BidGroupWorkPlanRotationRequest' UnavailableTime: type: object required: - timeSpan properties: id: type: string description: The globally unique identifier for the object. readOnly: true timeSpan: description: Exact date, time and length of the unavailability time span $ref: '#/definitions/WfmTimeSpan' notes: type: string description: Comments explaining the unavailability time span AgentWorkPlanBiddingPreferenceRequest: type: object required: - workPlanId properties: workPlanId: type: string description: The ID of the work plan that belongs to agent's bid group priority: type: integer format: int32 description: The agent's priority for this work plan, with 1 being the best priority. Null if priority is not set for the work plan WeekShiftTradeResponse: type: object properties: trade: description: The shift trade details $ref: '#/definitions/ShiftTradeResponse' matchReview: description: A preview of what the schedule would look like if the shift trade is approved plus any violations $ref: '#/definitions/ShiftTradeMatchReviewResponse' QueryTimeOffLimitValuesResponse: type: object properties: values: type: array items: $ref: '#/definitions/TimeOffLimitValueRange' ScheduleBidGroupUpdate: type: object properties: name: type: string description: The name of the schedule bid group managementUnitId: type: string description: The ID of the management unit to which this bid group belongs agentIds: description: The IDs of the agents who participate in this bid group $ref: '#/definitions/SetWrapperString' workPlanIds: description: The IDs of the work plans used in this bid group $ref: '#/definitions/SetWrapperString' workPlanRotations: description: The work plan rotations used in this bid group $ref: '#/definitions/ListWrapperBidGroupWorkPlanRotationRequest' planningGroupIds: description: The IDs of the planning groups selected in this bid group $ref: '#/definitions/SetWrapperString' scheduleSets: description: The schedule sets generated for this bid group $ref: '#/definitions/ListWrapperScheduleSetRequest' BuScheduleMetadata: type: object properties: id: type: string description: The ID of the schedule weekDate: type: string format: date description: 'The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' weekCount: type: integer format: int32 description: The number of weeks spanned by this schedule description: type: string description: The description of this schedule published: type: boolean description: Whether this schedule is published shortTermForecast: description: The forecast used for this schedule, if applicable $ref: '#/definitions/BuShortTermForecastReference' generationResults: description: Generation result summary for this schedule, if applicable $ref: '#/definitions/ScheduleGenerationResultSummary' metadata: description: Version metadata for this schedule $ref: '#/definitions/WfmVersionedEntityMetadata' managementUnits: type: array description: High level per-management unit schedule metadata items: $ref: '#/definitions/BuManagementUnitScheduleSummary' selfUri: type: string format: uri description: The URI for this object readOnly: true BusinessUnitActivityCode: type: object required: - id properties: id: type: string description: The globally unique identifier for the object. name: type: string active: type: boolean description: Whether this activity code is active or has been deleted defaultCode: type: boolean description: Whether this is a default activity code category: type: string description: The category of the activity code enum: - OnQueueWork - Break - Meal - Meeting - OffQueueWork - TimeOff - Training - Unavailable lengthInMinutes: type: integer format: int32 description: The default length of the activity in minutes countsAsPaidTime: type: boolean description: Whether an agent is paid while performing this activity countsAsWorkTime: type: boolean description: Indicates whether or not the activity should be counted as contiguous work time for calculating daily constraints agentTimeOffSelectable: type: boolean description: Whether an agent can select this activity code when creating or editing a time off request. Null if the activity's category is not time off. countsTowardShrinkage: type: boolean description: Whether or not this activity code counts toward shrinkage calculations plannedShrinkage: type: boolean description: Whether this activity code is considered planned or unplanned shrinkage interruptible: type: boolean description: Whether this activity code is considered interruptible secondaryPresences: type: array description: The secondary presences of this activity code items: $ref: '#/definitions/SecondaryPresence' planningGroups: type: array description: Planning groups associated with this activity code items: $ref: '#/definitions/PlanningGroupReference' metadata: description: Version metadata of this activity code $ref: '#/definitions/WfmVersionedEntityMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true BulkRemoveOpportunitiesResponse: type: object required: - errorCount - results properties: results: type: array description: The result for each requested item items: $ref: '#/definitions/BulkRemoveOpportunitiesResult' errorCount: type: integer format: int32 description: The count of failed operations in the bulk request InitiatingAlternativeShift: type: object required: - id - startDate properties: id: type: string description: The ID of the shift from a user's schedule startDate: type: string format: date-time description: 'The start date for the shift in the user''s schedule in ISO-8601 format. For example: YYYY-MM-DDThh:mm:ss.SSSZ' LongTermForecastResult: type: object properties: planningGroups: type: array description: The forecast data broken up by planning group items: $ref: '#/definitions/LongTermForecastPlanningGroupData' referenceStartDate: type: string format: date description: 'The reference start date relative to the business unit time zone in this forecast. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' weekCount: type: integer format: int32 description: The number of weeks in this forecast GetAgentsWorkPlansRequest: type: object required: - agentIds - startDate - weekCount properties: agentIds: type: array description: The list of agent IDs items: type: string startDate: type: string format: date description: 'The start of a date in yyyy-MM-dd format. Response contains values rolled back to nearest BU start day of week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' weekCount: type: integer format: int32 description: The number of weeks to query PatchShiftTradeRequest: type: object required: - metadata properties: receivingUserId: description: Update the ID of the receiving user to direct the request at a specific user, or set the wrapped id to null to open up a trade to be matched by any user. $ref: '#/definitions/ValueWrapperString' expiration: description: Update the expiration time for this shift trade. $ref: '#/definitions/ValueWrapperDate' acceptableIntervals: description: Update the acceptable intervals the initiating user is willing to accept in trade. Setting the enclosed list to empty will make this a one sided trade request $ref: '#/definitions/ListWrapperInterval' metadata: description: Version metadata $ref: '#/definitions/WfmVersionedEntityMetadata' BuTimeOffLimitReference: type: object required: - id 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 BuServiceLevel: type: object required: - include properties: include: type: boolean description: Whether to include service level targets in the associated configuration percent: type: integer format: int32 description: Service level target percent answered. Required if include == true seconds: type: integer format: int32 description: Service level target answer time. Required if include == true SetWrapperRoutePathRequest: type: object properties: values: type: array uniqueItems: true items: $ref: '#/definitions/RoutePathRequest' WaitlistPositionListing: type: object properties: entities: type: array items: $ref: '#/definitions/WaitlistPosition' ConstraintConflictMessage: type: object properties: message: description: Message for how to resolve a set of conflicted work plan constraints $ref: '#/definitions/WorkPlanConstraintConflictMessage' conflictedConstraintMessages: type: array description: Messages for the set of conflicted work plan constraints. Each element indicates the message of a work plan constraint that is conflicted in the set items: $ref: '#/definitions/WorkPlanConstraintMessage' AdminAgentScheduleSetPreferences: type: object required: - agentsScheduleBidPreferences - id properties: id: type: string description: The globally unique identifier for the object. bid: description: The schedule bid $ref: '#/definitions/ScheduleBidReference' bidGroup: description: The schedule bid group $ref: '#/definitions/ScheduleBidGroupReference' agentsScheduleBidPreferences: type: array description: The agents' schedule bidding preferences items: $ref: '#/definitions/AdminAgentScheduleBidBiddingPreference' selfUri: type: string format: uri description: The URI for this object readOnly: true BuQueryAdherenceExplanationsResponse: type: object properties: job: description: The asynchronous job handling the query $ref: '#/definitions/AdherenceExplanationJobReference' result: description: The result of the query. May come via notification $ref: '#/definitions/AdherenceExplanationListingBuQueryResponse' downloadUrl: type: string description: The URL from which to download the result. May come via notification ScheduleBid: type: object required: - agentRankingType - bidType - bidWindowEndDate - bidWindowStartDate - effectiveDate - endOverridesAndRotations - id - metadata - name - rankingTiebreakerType - status - weeksToSchedule properties: id: type: string description: The ID of the schedule bid name: type: string description: The name of the schedule bid bidWindowStartDate: type: string format: date description: 'The bid start date when agents can start participating in schedule bidding relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' bidWindowEndDate: type: string format: date description: 'The bid end date relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' effectiveDate: type: string format: date description: 'The date when schedule sets would be effective for schedule generation relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' status: type: string description: The state of the bid enum: - Draft - Locked - Optimized - Scheduled - Open - Closed - Processed - Published bidType: type: string description: The type of the bid enum: - WorkPlanBid - ScheduleBid forecast: description: The selected forecast used for schedule set generation for this bid $ref: '#/definitions/BuShortTermForecastWeekReference' weeksToSchedule: type: integer format: int32 description: The number of weeks to generate schedule sets through this bid endOverridesAndRotations: type: boolean description: If true, all existing overrides, work plan rotations will be ended one day before effective date of this bid agentRankingType: type: string description: The type of agent ranking selected for this bid enum: - HireDate - Performance rankingTiebreakerType: type: string description: Ranking tiebreaker enum: - HireDate - Performance - Custom - RandomlyAssign publishedDate: type: string format: date-time description: 'The date the schedule bid is published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endDate: type: string format: date description: 'The end date until which schedule sets can be used for schedule generation. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' metadata: description: The metadata of this bid $ref: '#/definitions/WorkPlanBidMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true CreateWorkPlan: type: object required: - name properties: name: type: string description: Name of this work plan enabled: type: boolean description: Whether the work plan is enabled for scheduling constrainWeeklyPaidTime: type: boolean description: Whether the weekly paid time constraint is enabled for this work plan flexibleWeeklyPaidTime: type: boolean description: Whether the weekly paid time constraint is flexible for this work plan weeklyExactPaidMinutes: type: integer format: int32 description: Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false weeklyMinimumPaidMinutes: type: integer format: int32 description: Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true weeklyMaximumPaidMinutes: type: integer format: int32 description: Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true constrainPaidTimeGranularity: type: boolean description: Whether paid time granularity should be constrained for this workplan paidTimeGranularityMinutes: type: integer format: int32 description: Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true constrainMinimumTimeBetweenShifts: type: boolean description: Whether the minimum time between shifts constraint is enabled for this work plan minimumTimeBetweenShiftsMinutes: type: integer format: int32 description: Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true maximumDays: type: integer format: int32 description: Maximum number days in a week allowed to be scheduled for this work plan minimumConsecutiveNonWorkingMinutesPerWeek: type: integer format: int32 description: Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off constrainMaximumConsecutiveWorkingWeekends: type: boolean description: Whether to constrain the maximum consecutive working weekends maximumConsecutiveWorkingWeekends: type: integer format: int32 description: The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work minimumWorkingDaysPerWeek: type: integer format: int32 description: The minimum number of days that agents assigned to a work plan must work per week constrainMaximumConsecutiveWorkingDays: type: boolean description: Whether to constrain the maximum consecutive working days maximumConsecutiveWorkingDays: type: integer format: int32 description: The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true minimumShiftStartDistanceMinutes: type: integer format: int32 description: The time period in minutes for the duration between the start times of two consecutive working days minimumDaysOffPerPlanningPeriod: type: integer format: int32 description: Minimum days off in the planning period maximumDaysOffPerPlanningPeriod: type: integer format: int32 description: Maximum days off in the planning period minimumPaidMinutesPerPlanningPeriod: type: integer format: int32 description: Minimum paid minutes in the planning period maximumPaidMinutesPerPlanningPeriod: type: integer format: int32 description: Maximum paid minutes in the planning period constrainMaximumWorkingWeekendsPerPlanningPeriod: type: boolean description: Whether to constrain the maximum working weekends in the planning period maximumWorkingWeekendsPerPlanningPeriod: type: integer format: int32 description: Maximum working weekends in the planning period optionalDays: description: Optional days to schedule for this work plan $ref: '#/definitions/SetWrapperDayOfWeek' shiftStartVarianceType: type: string description: This constraint ensures that an agent starts each workday within a user-defined time threshold enum: - ShiftStart - ShiftStartAndPaidDuration shiftStartVariancePeriod: type: string description: The length of the period over which the maximum shift start time variance is applied enum: - Weekly - PlanningPeriod shiftStartVariances: description: Variance in minutes among start times of shifts in this work plan $ref: '#/definitions/ListWrapperShiftStartVariance' shifts: type: array description: Shifts in this work plan items: $ref: '#/definitions/CreateWorkPlanShift' agents: type: array description: Agents in this work plan items: $ref: '#/definitions/UserReference' EstimateAvailableFullDayTimeOffRequest: type: object required: - date properties: date: type: string format: date description: 'Date in yyyy-MM-dd format for full day request. Should be interpreted in the business unit''s configured time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' requestedDurationMinutes: type: integer format: int32 description: A requested length of time off request in minutes. If the value is null, then the system will use activity code length setting WorkPlanPatternResponse: type: object properties: workPlans: type: array description: List of work plans in order of rotation on a weekly basis items: $ref: '#/definitions/WorkPlanReference' UpdateBusinessUnitRequest: type: object properties: name: type: string description: The name of the business unit divisionId: type: string description: The ID of the division to which the business unit should be moved settings: description: Configuration for the business unit $ref: '#/definitions/UpdateBusinessUnitSettingsRequest' QueueReference: 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 UserStaffingGroupListing: type: object properties: entities: type: array items: $ref: '#/definitions/UserStaffingGroupResponse' downloadUrl: type: string description: URL from which to fetch results for requests with a large result set. If populated, the downloaded data will conform to the same schema as would normally be returned, excepting downloaded data will never itself contain a downloadUrl AgentsBidAssignedScheduleSetOverrideRequest: type: object required: - agentScheduleSetOverrides properties: agentScheduleSetOverrides: type: array description: The agent schedule set overrides items: $ref: '#/definitions/AgentBidScheduleSetOverrideRequest' BuNotificationSettingsResponse: type: object properties: scheduling: description: Schedule notification settings $ref: '#/definitions/BuScheduleNotificationsSettingsResponse' BuRescheduleResult: type: object properties: generationResults: description: The generation results. Note the result will always be delivered via the generationResultsDownloadUrl; however the schema is included for documentation $ref: '#/definitions/ScheduleGenerationResult' generationResultsDownloadUrl: type: string description: The download URL from which to fetch the generation results for the rescheduling run headcountForecast: description: The headcount forecast. Note the result will always be delivered via the headcountForecastDownloadUrl; however the schema is included for documentation $ref: '#/definitions/BuHeadcountForecastBuPlanningGroupHeadcountForecastResult' headcountForecastDownloadUrl: type: string description: The download URL from which to fetch the headcount forecast for the rescheduling run agentSchedules: type: array description: List of download links for agent schedules produced by the rescheduling run items: $ref: '#/definitions/BuRescheduleAgentScheduleResult' BuScheduleListItem: type: object properties: id: type: string description: The ID of the schedule weekDate: type: string format: date description: 'The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' weekCount: type: integer format: int32 description: The number of weeks spanned by this schedule description: type: string description: The description of this schedule published: type: boolean description: Whether this schedule is published shortTermForecast: description: The forecast used for this schedule, if applicable $ref: '#/definitions/BuShortTermForecastReference' generationResults: description: Generation result summary for this schedule, if applicable $ref: '#/definitions/ScheduleGenerationResultSummary' metadata: description: Version metadata for this schedule $ref: '#/definitions/WfmVersionedEntityMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true HistoricalShrinkageResult: type: object properties: startDate: type: string format: date-time description: Beginning of the date range that was queried, in ISO-8601 format endDate: type: string format: date-time description: End of the date range that was queried, in ISO-8601 format. If it was not set, end date will be set to the queried time totalScheduledDurationSeconds: type: integer format: int32 description: Total duration in seconds for which agents in the management unit are scheduled totalLoggedInDurationSeconds: type: integer format: int32 description: Total duration in seconds for which agents in the management unit are actually logged-in aggregatedShrinkage: description: Aggregated shrinkage data for all the activity categories $ref: '#/definitions/HistoricalShrinkageAggregateResponse' shrinkageForActivityCategories: type: array description: Shrinkage for activity categories items: $ref: '#/definitions/HistoricalShrinkageActivityCategoryResponse' businessUnitIds: type: array description: List of all business units of all the agents in response items: type: string HrisTimeOffTypesJobReference: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true status: type: string description: The status of the job enum: - Processing - Complete - Error selfUri: type: string format: uri description: The URI for this object readOnly: true UpdateUnavailableTimesRequest: type: object required: - entities properties: entities: type: array description: A list of unavailable time spans to update items: $ref: '#/definitions/UpdateUnavailableTime' HrisTimeOffTypeResponse: type: object required: - id - name properties: id: type: string description: ID of the time off type configured in integration name: type: string description: Name of the time off type configured in integration secondaryId: type: string description: Secondary ID of the time off type, if configured in integration AddWorkPlanRotationAgentRequest: type: object required: - dateRange - position - userId properties: userId: type: string description: The ID of an agent in this work plan rotation dateRange: description: The date range to which this agent is effective in the work plan rotation $ref: '#/definitions/DateRangeWithOptionalEnd' position: type: integer format: int32 description: Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0 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' AgentScheduleBid: type: object required: - bidType - bidWindowEndDate - bidWindowStartDate - effectiveDate - id - status properties: id: type: string description: The ID of the schedule bid name: type: string bidWindowStartDate: type: string format: date description: 'The bid start date when agents can start participating in schedule bidding relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' bidWindowEndDate: type: string format: date description: 'The bid end date relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' effectiveDate: type: string format: date description: 'The date when schedule sets would be effective for schedule generation relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' status: type: string description: The state of the bid enum: - Draft - Locked - Optimized - Scheduled - Open - Closed - Processed - Published bidType: type: string description: The type of the bid enum: - WorkPlanBid - ScheduleBid selfUri: type: string format: uri description: The URI for this object readOnly: true BuAverageSpeedOfAnswer: type: object required: - include properties: include: type: boolean description: Whether to include average speed of answer (ASA) in the associated configuration seconds: type: integer format: int32 description: The target average speed of answer (ASA) in seconds. Required if include == true AgentBulkAddOpportunityEnrollment: type: object required: - opportunityId properties: id: type: string description: The globally unique identifier for the object. readOnly: true opportunityId: type: string description: The ID of the opportunity in which the agent was enrolled StaffingGroupMetricChangeResponse: type: object required: - createdBy - createdDate - metric - numberOfWeeks - staffingGroups - value - weekStartNumber properties: numberOfWeeks: type: integer format: int32 description: The number of weeks to which the metric change applies weekStartNumber: type: integer format: int32 description: The start number of the week (starting from 1) to which the metric change applies, related to numberOfWeeks value: type: number format: double description: The value of the metric metric: type: string description: The metric which is going to be modified for the selected staffing groups enum: - StartingWeeklyFullTimeEquivalentCount - NewHiresFullTimeEquivalentCount - AttritionPercentage - ShrinkagePercentage - TransfersFullTimeEquivalentCount - ExtraTimeUnderTimeFullTimeEquivalentCount notes: type: string description: Notes about the staffing groups metric changes transfersFullTimeEquivalent: description: Full time equivalent transfer from one staffing group to another $ref: '#/definitions/TransfersFullTimeEquivalent' staffingGroups: type: array description: The staffing groups affected by the metric change items: $ref: '#/definitions/StaffingGroupReference' createdBy: description: The user who created the metric change $ref: '#/definitions/UserReference' createdDate: type: string format: date-time description: The date the entity was created, in ISO-8601 format LongTermRequirements: type: object required: - dateGenerationStarted - forecastMetadata - requirementResults properties: forecastMetadata: description: Forecast metadata $ref: '#/definitions/ForecastMetadata' dateGenerationStarted: type: string format: date-time description: 'Date the generation of the requirements started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' months: type: array description: The list of months covered by the long-term staffing requirements, formatted as yyyy-MM items: type: string format: year-month description: 'Year and month are represented as an ISO-8601 string. For example: yyyy-MM' requirementResults: type: array description: List of planning group outputs items: $ref: '#/definitions/PlanningGroupRequirementOutput' TimeOffRequestListing: type: object required: - entities properties: entities: type: array description: List of time off requests items: $ref: '#/definitions/TimeOffRequest' downloadUrl: type: string description: URL from which to fetch results for requests with a large result set. If populated, the downloaded data will conform to the same schema as would normally be returned, excepting downloaded data will never itself contain a downloadUrl PlanningPeriodSettings: type: object required: - startDate - weekCount properties: weekCount: type: integer format: int32 description: Planning period length in weeks startDate: type: string format: date description: 'Start date of the planning period in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' AgentIntegrationAssociationRequest: type: object required: - agentExternalId - integrationId - locked properties: agentExternalId: type: string description: The ID of the agent in external system integrationId: type: string description: The ID of the integration associated with the agent locked: type: boolean description: Whether agentExternalId should be protected from update by automatic processes UpdateMuAgentWorkPlanRequest: type: object required: - userId properties: userId: type: string description: The agent id for whom the work plan is updated workPlanId: description: The current work plan ID for the agent $ref: '#/definitions/ValueWrapperString' workPlanOverrides: description: The list of work plan overrides for the agent $ref: '#/definitions/WorkPlanOverrideListWrapperWorkPlanOverrideRequest' ListWrapperRequiredDateRange: type: object properties: values: type: array items: $ref: '#/definitions/RequiredDateRange' CreateWorkPlanActivity: type: object properties: activityCodeId: type: string description: ID of the activity code associated with this activity description: type: string description: Description of the activity lengthMinutes: type: integer format: int32 description: Length of the activity in minutes startTimeIsRelativeToShiftStart: type: boolean description: Whether the start time of the activity is relative to the start time of the shift it belongs to flexibleStartTime: type: boolean description: Whether the start time of the activity is flexible earliestStartTimeMinutes: type: integer format: int32 description: Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true latestStartTimeMinutes: type: integer format: int32 description: Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true exactStartTimeMinutes: type: integer format: int32 description: Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false startTimeIncrementMinutes: type: integer format: int32 description: Increment in offset minutes that would contribute to different possible start times for the activity countsAsPaidTime: type: boolean description: Whether the activity is paid countsAsContiguousWorkTime: type: boolean description: Whether the activity duration is counted towards contiguous work time minimumLengthFromShiftStartMinutes: type: integer format: int32 description: The minimum duration between shift start and shift item (e.g., break or meal) start in minutes minimumLengthFromShiftEndMinutes: type: integer format: int32 description: The minimum duration between shift item (e.g., break or meal) end and shift end in minutes maximumLengthFromShiftEndMinutes: type: integer format: int32 description: The maximum duration between shift item (e.g., break or meal) end and shift end in minutes UpdateBusinessUnitSettingsRequest: type: object required: - metadata properties: startDayOfWeek: type: string description: The start day of week for this business unit readOnly: true enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday timeZone: type: string description: The time zone for this business unit, using the Olsen tz database format readOnly: true shortTermForecasting: description: Short term forecasting settings $ref: '#/definitions/BuShortTermForecastingSettings' scheduling: description: Scheduling settings $ref: '#/definitions/BuSchedulingSettingsRequest' notifications: description: Notification settings $ref: '#/definitions/BuNotificationSettingsRequest' learning: description: Learning settings $ref: '#/definitions/BuActivitySettingsRequest' coaching: description: Coaching settings $ref: '#/definitions/BuActivitySettingsRequest' metadata: description: Version metadata for this business unit $ref: '#/definitions/WfmVersionedEntityMetadata' ActivityPlanServiceLevelImpactOverride: type: object required: - decreaseByPercent properties: decreaseByPercent: type: number format: double description: Allowed service level decrease percent, from 0.0 to 100.0 BuSetTimeOffLimitValuesRequest: type: object required: - metadata properties: values: type: array items: $ref: '#/definitions/BuTimeOffLimitRange' metadata: description: Version metadata for the time-off limit $ref: '#/definitions/WfmVersionedEntityMetadata' WorkPlanBidGroup: type: object required: - agents - managementUnit - name - planningGroups - workPlans properties: name: type: string description: The name of the work plan bid group managementUnit: description: The management unit this bid group belongs to $ref: '#/definitions/ManagementUnitReference' agents: type: array description: The list of agents who participate in this bid group items: $ref: '#/definitions/UserReference' workPlans: type: array description: The list of work plans used in this bid group items: $ref: '#/definitions/BidGroupWorkPlanResponse' planningGroups: type: array description: The list of planning groups selected in this bid group items: $ref: '#/definitions/PlanningGroupReference' UserSearchRulePart: type: object required: - ids - operation - selector properties: operation: type: string description: The operation for this part enum: - Include - Exclude selector: type: string description: The type of item being selected by this part enum: - AcdSkill - User - Group - Queue - Division - ManagementUnit ids: type: array description: The ids for the selector; the results of these are ORed together uniqueItems: true items: type: string QueryAvailabilityManagementUnitsSettingsRequest: type: object required: - managementUnitIds properties: managementUnitIds: type: array description: The IDs of the management units for which to fetch their configurations. The management units must be in the business unit specified in the request path items: type: string ListWrapperShiftStartVariance: type: object properties: values: type: array items: $ref: '#/definitions/ShiftStartVariance' TimeOffRequest: type: object required: - id - user properties: id: type: string description: The globally unique identifier for the object. user: description: The user that the time off request belongs to $ref: '#/definitions/UserReference' isFullDayRequest: type: boolean description: Whether this is a full day request (false means partial day) markedAsRead: type: boolean description: Whether this request has been marked as read by the agent activityCodeId: type: string description: The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category paid: type: boolean description: Whether this is a paid time off request status: type: string description: The status of this time off request enum: - PENDING - APPROVED - DENIED - CANCELED substatus: type: string description: The substatus of this time off request enum: - AdvanceTimeElapsed - AutoApproved - BlockedDate - InsufficientBalance - InvalidDailyDuration - ManualApproval - OutsideShift - OverlapsRestrictedActivityCode - RemovedFromWaitlist - ReviewDate - Waitlisted partialDayStartDateTimes: type: array description: A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false items: type: string format: date-time fullDayManagementUnitDates: type: array description: A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true items: type: string dailyDurationMinutes: type: integer format: int32 description: The daily duration of this time off request in minutes durationMinutes: type: array description: Daily durations for each day of this time off request in minutes items: type: integer format: int32 payableMinutes: type: array description: Payable minutes for each day of this time off request items: type: integer format: int32 fullDayEarliestStartOffsetMinutes: type: array description: Earliest start offset in minutes for each full-day request date. Values may be null when time-off estimation is disabled or no estimate is available items: type: integer format: int32 fullDayLatestEndOffsetMinutes: type: array description: Latest end offset in minutes for each full-day request date. Values may be null when time-off estimation is disabled or no estimate is available items: type: integer format: int32 notes: type: string description: Notes about the time off request submittedBy: description: The user who submitted this time off request. The id may be 'System' if it was an automated process $ref: '#/definitions/UserReference' submittedDate: type: string format: date-time description: 'The timestamp when this request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' reviewedBy: description: The user who reviewed this time off request. The id may be 'System' if it was an automated process $ref: '#/definitions/UserReference' reviewedDate: type: string format: date-time description: 'The timestamp when this request was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' syncVersion: type: integer format: int32 description: The sync version of this time off request for which the scheduled activity is associated metadata: description: The version metadata of the time off request $ref: '#/definitions/WfmVersionedEntityMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true AgentScheduleShiftActivity: type: object required: - activityCategory - lengthMinutes - startOffsetMinutes properties: activityCategory: type: string description: The activity category for which the agent is scheduled enum: - OnQueueWork - Break - Meal - Meeting - OffQueueWork - TimeOff - Training - Unavailable startOffsetMinutes: type: integer format: int32 description: The start offset of the activity, relative to referenceStartDate at the top level lengthMinutes: type: integer format: int32 description: The length of the activity in minutes WfmHistoricalAdherenceBulkQuery: type: object required: - items - timeZone properties: items: type: array description: The historical adherence items to query items: $ref: '#/definitions/WfmHistoricalAdherenceBulkItem' timeZone: type: string description: The time zone, in olson format, to use in defining days when computing adherence. The results will be returned as UTC timestamps regardless of the time zone input. HistoricalAdherenceDayMetrics: type: object properties: dayStartOffsetSecs: type: integer format: int32 description: Start of day offset in seconds relative to query start time adherenceScheduleSecs: type: integer format: int32 description: Duration of schedule in seconds included for adherence percentage calculation conformanceScheduleSecs: type: integer format: int32 description: Total scheduled duration in seconds for OnQueue activities conformanceActualSecs: type: integer format: int32 description: Total actually worked duration in seconds for OnQueue activities exceptionCount: type: integer format: int32 description: Total number of adherence exceptions for this user exceptionDurationSecs: type: integer format: int32 description: Total duration in seconds of adherence exceptions for this user impactSeconds: type: integer format: int32 description: The impact duration in seconds of current adherence state for this user scheduleLengthSecs: type: integer format: int32 description: Total duration in seconds for all scheduled activities actualLengthSecs: type: integer format: int32 description: Total duration in seconds for all actually worked activities adherencePercentage: type: number format: double description: Total adherence percentage for this user, in the scale of 0 - 100 conformancePercentage: type: number format: double description: Total conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on-queue time is greater than the scheduled on-queue time for the same period. ShiftSetEffectiveWorkPlan: type: object properties: workPlanId: type: string description: The ID of the work plan workPlanRotationId: type: string description: The ID of the work plan rotation positionInRotation: type: integer format: int32 description: The position in rotation CurrentUserTimeOffIntegrationStatusRequest: type: object required: - timeOffRequestIds properties: timeOffRequestIds: type: array description: A list of time off request IDs items: type: string AsyncForecastOperationResult: type: object properties: status: type: string description: The status of the operation enum: - Processing - Complete - Canceled - Error operationId: type: string description: The ID for the operation result: description: The result of the operation. Null unless status == Complete $ref: '#/definitions/BuShortTermForecast' progress: type: integer format: int32 description: Percent progress for the operation CapacityPlanForecastMetrics: type: object required: - averageHandleTime - volume properties: volume: type: array description: Forecast offered counts per requested granularity interval items: type: number format: double averageHandleTime: type: array description: Average handle time in seconds per requested granularity interval items: type: number format: double ValueWrapperActivityPlanServiceGoalImpactOverrides: type: object properties: value: description: The value for the associated field $ref: '#/definitions/ActivityPlanServiceGoalImpactOverrides' CreateAlternativeShiftTradeRequest: type: object required: - alternativeShiftTradeGranularity - jobId properties: jobId: type: string description: The ID of this alternative shift job dropShiftReferenceKeys: type: array description: A list of offered shift reference keys an agent wants to drop items: type: string pickupShiftReferenceKeys: type: array description: A list of offered shift reference keys an agent wants to pick up items: type: string alternativeShiftTradeGranularity: type: string description: The granularity of alternative shifts to be traded enum: - Daily expirationDate: type: string format: date-time description: The date when the trade will expire in ISO-8601 format. The trade cannot be approved after expiration BuScheduleRun: type: object required: - id properties: id: type: string description: The globally unique identifier for the object. schedulerRunId: type: string description: The scheduler run ID. Reference this value for support intradayRescheduling: type: boolean description: Whether this is an intraday rescheduling run state: type: string description: The state of the generation run enum: - None - Queued - Scheduling - Canceled - Failed - Complete weekCount: type: integer format: int32 description: The number of weeks spanned by the schedule percentComplete: type: number format: double description: Percent completion of the schedule run targetWeek: type: string format: date description: 'The start date of the target week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' schedule: description: The generated schedule. Null unless the schedule run is complete $ref: '#/definitions/BuScheduleReference' scheduleDescription: type: string description: The description of the generated schedule schedulingStartTime: type: string format: date-time description: 'When the schedule generation run started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' schedulingStartedBy: description: The user who started the scheduling run $ref: '#/definitions/UserReference' schedulingCanceledBy: description: The user who canceled the scheduling run, if applicable $ref: '#/definitions/UserReference' schedulingCompletedTime: type: string format: date-time description: 'When the scheduling run was completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' messageCount: type: integer format: int32 description: The number of schedule generation messages for this schedule generation run messageSeverityCounts: type: array description: The list of schedule generation message counts by severity for this schedule generation run items: $ref: '#/definitions/SchedulerMessageSeverityCount' reschedulingOptions: description: Rescheduling options for this run. Null unless intradayRescheduling is true $ref: '#/definitions/ReschedulingOptionsRunResponse' reschedulingResultExpiration: type: string format: date-time description: 'When the reschedule result will expire. Null unless intradayRescheduling is true. 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 ShiftTradeMatchTradeJobResponse: type: object required: - id - status - type properties: id: type: string description: The globally unique identifier for the object. status: type: string description: The status of the job enum: - Processing - Complete - Canceled - Error type: type: string description: The type of the job enum: - AddTrade - BulkUpdateTradeStates - EvaluateTrades - MatchTrade - QueryAgentTrades - QueryTrades - QueryWeekSummaries - SearchUnmatchedTrades - UpdateTrade - UpdateTradeState downloadUrl: type: string description: The URL where completed results might be available for download in case the result body for that job type is too large error: description: Any error information, only set if the status == 'Error' $ref: '#/definitions/ErrorBody' matchTradeResult: description: Results for MatchTrade job type $ref: '#/definitions/EvaluatedShiftTradeResponseItem' selfUri: type: string format: uri description: The URI for this object readOnly: true StaffingRequirementResultResponseTemplate: type: object required: - requirementResults properties: requirementResults: type: array description: List of staffing requirement results items: $ref: '#/definitions/PlanningGroupRequirementOutput' ValueWrapperDate: type: object properties: value: type: string format: date-time description: 'The value for the associated field. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' AdminAgentWorkPlanBiddingPreference: type: object required: - agent - submitted properties: agent: description: The agent to whom this work plan bidding preference applies $ref: '#/definitions/UserReference' submitted: type: boolean description: Whether the preference is submitted assignedWorkPlan: description: The work plan assigned to the agent by the bid process $ref: '#/definitions/WorkPlanReference' overriddenWorkPlan: description: The work plan that overrides the assigned work plan for the agent $ref: '#/definitions/WorkPlanReference' overrideReason: type: string description: The reason why the assigned work plan has been overridden. This must be null without an override work plan enum: - UnableToBid - ChangeOfCircumstance - NewHire - EmployeeMove priorities: type: array description: The agent priorities for the list of work plans. The index of the priorities should match with the list of work plans that belong to bid group. It contains null if priority is not set for the work plan items: type: integer format: int32 ShiftTradeResponse: type: object properties: id: type: string description: The ID of this shift trade weekDate: type: string format: date description: 'The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' schedule: description: A reference to the associated schedule $ref: '#/definitions/BuScheduleReferenceForMuRoute' state: type: string description: The state of this shift trade enum: - Unmatched - Matched - Approved - Denied - Expired - Canceled initiatingUser: description: The user who initiated this trade $ref: '#/definitions/UserReference' initiatingShiftId: type: string description: The ID of the shift offered for trade by the initiating user initiatingShiftStart: type: string format: date-time description: 'The start date/time of the shift being offered for trade. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' initiatingShiftEnd: type: string format: date-time description: 'The end date/time of the shift being offered for trade. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' receivingWeekDate: type: string format: date description: 'The start week date of the receiving shift in yyyy-MM-dd format for a cross-week shift trade or null otherwise. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' receivingUser: description: The user matching the trade, or if the state is not 'Matched', the user to whom the trade request was sent $ref: '#/definitions/UserReference' receivingShiftId: type: string description: The ID of the shift being exchanged for the initiating shift, null if the receiving user is picking up a shift receivingShiftStart: type: string format: date-time description: 'The start date/time of the receiving shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' receivingShiftEnd: type: string format: date-time description: 'The end date/time of the receiving shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' expiration: type: string format: date-time description: 'When this shift trade offer will expire if not matched or approved. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' oneSided: type: boolean description: Whether this is a one-sided shift trade (e.g. the initiating user is not asking for a shift in return) acceptableIntervals: type: array description: 'Time frames when the initiating user is willing to accept trades. Empty means giving up the shift. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss' items: type: string format: interval description: 'Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss' reviewedBy: description: The user who reviewed this shift trade. The id may be 'System' if it was an automated process $ref: '#/definitions/UserReference' reviewedDate: type: string format: date-time description: 'The timestamp when this shift trade was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' metadata: description: Version data for this trade $ref: '#/definitions/WfmVersionedEntityMetadata' PendingAndApprovedOpportunityEnrollmentCounts: type: object required: - approved - pending properties: pending: type: integer format: int32 description: The number of pending enrollments approved: type: integer format: int32 description: The number of approved enrollments ScheduleBidGroupResponse: type: object required: - id - metadata - scheduleBidGroup properties: id: type: string description: The globally unique identifier for the object. scheduleBidGroup: description: The schedule bid group $ref: '#/definitions/ScheduleBidGroup' metadata: description: The metadata of the bid group $ref: '#/definitions/WorkPlanBidMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true BuForecastGenerationPlanningGroupResult: type: object properties: planningGroupId: type: string description: The ID of the planning group metricResults: type: array description: The generation results for the associated planning group items: $ref: '#/definitions/BuForecastTimeSeriesResult' AddShiftTradeRequest: type: object required: - initiatingShiftId - scheduleId properties: scheduleId: type: string description: The ID of the schedule to which the initiating and receiving shifts belong initiatingShiftId: type: string description: The ID of the shift that the initiating user wants to give up receivingUserId: type: string description: The ID of the user to whom to send the request (for use in direct trade requests) expiration: type: string format: date-time description: 'When this shift trade request should expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' acceptableIntervals: type: array description: 'The acceptable intervals the initiating user is willing to accept in trade. Empty indicates the user is giving up the shift. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss' items: type: string format: interval description: 'Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss' ActivityPlanJobException: type: object required: - exceptionType - occurrences properties: exceptionType: type: string description: The type of error enum: - UnscheduledAttendees - SessionsNotDeleted occurrences: type: array description: The occurrences in which this error occurred items: $ref: '#/definitions/ActivityPlanOccurrenceReference' BuScheduleNotificationsCategorySettings: type: object required: - activityCategory - earlyReminderEnabled - onTimeReminderEnabled properties: activityCategory: type: string description: The activity category enum: - OnQueueWork - Break - Meal - Meeting - OffQueueWork - TimeOff - Training - Unavailable earlyReminderEnabled: type: boolean description: Indicates if agents should receive early schedule reminder notifications. onTimeReminderEnabled: type: boolean description: Indicates if agents should receive out of adherence notifications. BuImportShortTermForecastSchema: type: object required: - description - planningGroups - weekCount properties: description: type: string description: The description for the forecast weekCount: type: integer format: int32 description: The number of weeks covered by the forecast planningGroups: type: array description: The short term planning group data items: $ref: '#/definitions/ForecastPlanningGroupData' longTermPlanningGroups: type: array description: The long term planning group data items: $ref: '#/definitions/LongTermForecastPlanningGroupData' canUseForScheduling: type: boolean description: Whether this forecast can be used for scheduling PatchBuReschedulingOptionsManagementUnitRequest: type: object required: - managementUnitId properties: managementUnitId: type: string description: The management unit portion of the rescheduling run to update applied: type: boolean description: Whether to mark the run as applied. Only applies to reschedule runs. Once applied, a run cannot be un-marked as applied SetWrapperString: type: object properties: values: type: array uniqueItems: true items: type: string BuShortTermForecast: type: object required: - id properties: id: type: string description: The globally unique identifier for the object. weekDate: type: string format: date description: 'The start week date of this forecast in yyyy-MM-dd. Must fall on the start day of week for the associated business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' weekCount: type: integer format: int32 description: The number of weeks this forecast covers creationMethod: type: string description: The method by which this forecast was created enum: - Import - ImportedHistoricalWeightedAverage - HistoricalWeightedAverage - Advanced description: type: string description: The description of this forecast legacy: type: boolean description: Whether this forecast contains modifications on legacy metrics readOnly: true metadata: description: Metadata for this forecast $ref: '#/definitions/WfmVersionedEntityMetadata' canUseForScheduling: type: boolean description: Whether this forecast can be used for scheduling referenceStartDate: type: string format: date-time description: 'The reference start date for interval-based data for this forecast. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' sourceDays: type: array description: The source day pointers for this forecast items: $ref: '#/definitions/ForecastSourceDayPointer' modifications: type: array description: Any manual modifications applied to this forecast items: $ref: '#/definitions/BuForecastModificationResponse' generationResults: description: Generation result metadata $ref: '#/definitions/BuForecastGenerationResult' timeZone: type: string description: The time zone for this forecast planningGroupsVersion: type: integer format: int32 description: The version of the planning groups that was used for this forecast planningGroups: description: A snapshot of the planning groups used for this forecast as of the version number indicated $ref: '#/definitions/ForecastPlanningGroupsResponse' selfUri: type: string format: uri description: The URI for this object readOnly: true AssignedAgentDetails: type: object required: - id properties: id: type: string description: The ID of the agent endDate: type: string format: date description: 'The end date of this schedule set for the agent, relative to the business unit time zone in yyyy-MM-dd format. Null denotes an ongoing schedule set. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' ActivityCodesReference: type: object properties: ids: type: array description: The IDs of activity codes uniqueItems: true items: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true ScheduleBidGroupSummary: type: object required: - agentCount - id - managementUnit - name - planningGroupCount - workPlanCount - workPlanRotationCount properties: id: type: string description: The globally unique identifier for the object. name: type: string description: The name assigned to this bid group managementUnit: description: The management unit to which this bid group belongs $ref: '#/definitions/ManagementUnitReference' agentCount: type: integer format: int32 description: The number of agents in this bid group workPlanCount: type: integer format: int32 description: The number of work plans in this bid group or the number of work plans in rotations workPlanRotationCount: type: integer format: int32 description: The number of work plan rotations used in this bid group planningGroupCount: type: integer format: int32 description: The number of planning groups in this bid group scheduleSetError: description: Schedule set optimization error details for this bid group. Present only when optimization fails $ref: '#/definitions/ScheduleSetError' selfUri: type: string format: uri description: The URI for this object readOnly: true QueryWeekSummaryListJobRequest: type: object required: - managementUnitIds - weekDates properties: managementUnitIds: type: array description: The IDs of management units from which to query shift trades uniqueItems: true items: type: string weekDates: type: array description: The start week dates in which to query shift trades in the business unit time zone (yyyy-MM-dd format) uniqueItems: true items: type: string format: date AgentTimeOffRequestPatch: type: object properties: markedAsRead: type: boolean description: Whether this request has been read by the agent status: type: string description: The status of this time off request. Can only be canceled if the requested date has not already passed enum: - CANCELED notes: type: string description: Notes about the time off request. Can only be edited while the request is still pending fullDayEarliestStartOffsetMinutes: description: Earliest start offset in minutes for each full-day request date. Values may be null when time-off estimation is disabled or no estimate is available $ref: '#/definitions/ListWrapperInteger' fullDayLatestEndOffsetMinutes: description: Latest end offset in minutes for each full-day request date. Values may be null when time-off estimation is disabled or no estimate is available $ref: '#/definitions/ListWrapperInteger' CopyCapacityPlanRequest: type: object required: - endBusinessUnitDate - name - startBusinessUnitDate properties: name: type: string description: The name of the new capacity plan description: type: string description: Description of the new capacity plan startBusinessUnitDate: type: string format: date description: 'The start date for the capacity plan relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' endBusinessUnitDate: type: string format: date description: 'The end date for the capacity plan relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' forecast: description: The selected forecast for this capacity plan. Uses forecast from original capacity plan if not specified $ref: '#/definitions/ValueWrapperBuShortTermForecastReference' AgentAdherenceScheduledActivity: type: object required: - activityCodeId - endOffsetSeconds - startOffsetSeconds properties: activityCodeId: type: string description: The ID of the activity code from the schedule startOffsetSeconds: type: integer format: int32 description: Start offset in seconds relative to query start time endOffsetSeconds: type: integer format: int32 description: End offset in seconds relative to query start time ActivityPlanOccurrenceReference: type: object required: - id 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 OpportunityResultWithAgentIds: type: object required: - activityCodeId - agentCount - approvalType - capacity - deadlineDate - endDate - enrollmentCounts - enrollmentProcessingCount - id - metadata - name - startDate - status properties: id: type: string description: The globally unique identifier for the object. startDate: type: string format: date-time description: The start date and time of the opportunity in ISO-8601 format endDate: type: string format: date-time description: The end date and time of the opportunity in ISO-8601 format status: type: string description: The current status of the opportunity enum: - Draft - Published - Open - Pending - Closed openDate: type: string format: date-time description: The date and time when the opportunity opens for enrollment in ISO-8601 format. If not provided or in the past, it will be automatically updated to the current time when the opportunity is published deadlineDate: type: string format: date-time description: The deadline date and time for enrollment in the opportunity in ISO-8601 format name: type: string description: The name of the opportunity description: type: string description: Additional details describing the purpose or context of this opportunity activityCodeId: type: string description: The ID of the activity code associated with the opportunity approvalType: type: string description: The approval type for enrollments enum: - Automatic - Manual agentCount: type: integer format: int32 description: The total number of agents invited to this opportunity capacity: type: integer format: int32 description: The maximum capacity (enrollment slots) for this opportunity enrollmentProcessingCount: type: integer format: int32 description: The number of enrollments currently being processed enrollmentCounts: description: The counts for enrollment statuses $ref: '#/definitions/OpportunityEnrollmentCounts' publishedDate: type: string format: date-time description: The date and time when the opportunity was published in ISO-8601 format closedDate: type: string format: date-time description: The date and time when the opportunity was closed in ISO-8601 format systemMessageCode: type: string description: The system-generated message code about opportunity processing issues or validation failures enum: - ActivityChanged - AgentEnrollmentsHourlyLimitExceeded - BatchLimitExceeded - BusinessUnitEnrollmentsHourlyLimitExceeded - BusinessUnitNotFound - BusinessUnitOpportunityHourlyLimitExceeded - CapacityFull - Conflict - DateMustBeInFuture - DeadlineMustBeAfterOpenTime - DeadlineMustBeBeforeOrEqualToStartTime - EndTimeMustBeAfterStartTime - EnrollmentNotFound - InternalError - InternalErrorAutoApproval - InternalErrorDenial - InternalErrorScheduleUpdate - InvalidOpportunityLength - InvalidOpportunityStatus - InvalidRequest - InvalidStatusTransition - InvalidTime - NoInvitationsForPublish - OpenTimeMustBeBeforeStartTime - OpportunityClosed - OpportunityNotFound - OpportunityNotOpen - ScheduleConflict - ScheduleNotFound - ServiceUnavailable - StartTimeMustBeWithinOneYear - StatusNotDraft metadata: description: The metadata for the opportunity $ref: '#/definitions/WfmVersionedEntityMetadata' agentIds: type: array description: The IDs of the agents that are invited to the opportunity items: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true HistoricalDataDeleteEntity: type: object properties: requestId: type: string status: type: string enum: - InProgress - Success BulkOpportunitiesExternalActivitiesRequest: type: object required: - ids properties: ids: type: array description: The IDs of the external activities items: type: string SetWrapperSyncTimeOffProperty: type: object properties: values: type: array uniqueItems: true items: type: string enum: - PayableMinutes - FullDayEarliestStartOffsetMinutes - FullDayLatestEndOffsetMinutes BuAsyncAgentSchedulesSearchResponse: type: object properties: status: type: string description: The status of the operation enum: - Processing - Complete - Canceled - Error operationId: type: string description: The ID for the operation result: description: The result of the operation. Null unless status == Complete $ref: '#/definitions/BuAgentSchedulesSearchResponse' progress: type: integer format: int32 description: Percent progress for the operation downloadUrl: type: string description: The URL from which to download the result if it is too large to pass directly SetTimeOffIntegrationStatusRequest: type: object required: - integrationStatus properties: integrationStatus: type: string description: The integration status value for the time off request enum: - Processing - Error - AutomaticallyComplete - ManuallyComplete WfmHistoricalAdherenceQueryForTeams: type: object required: - startDate - timeZone properties: startDate: type: string format: date-time description: Beginning of the date range to query in ISO-8601 format endDate: type: string format: date-time description: End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time timeZone: type: string description: The time zone, in olson format, to use in defining days when computing adherence. The results will be returned as UTC timestamps regardless of the time zone input. userIds: type: array description: The userIds to report on. If null or not set, adherence will be computed for all the users in management unit or requested teamIds uniqueItems: true items: type: string includeExceptions: type: boolean description: Whether user exceptions should be returned as part of the results SchedulingSettingsRequest: type: object properties: maxOccupancyPercentForDeferredWork: type: integer format: int32 description: Max occupancy percent for deferred work defaultShrinkagePercent: type: number format: double description: Default shrinkage percent for scheduling shrinkageOverrides: description: Shrinkage overrides for scheduling $ref: '#/definitions/ShrinkageOverrides' planningPeriod: description: Planning period settings for scheduling. Only one of planningPeriod or monthlyPlanningPeriod may be defined $ref: '#/definitions/ValueWrapperPlanningPeriodSettings' monthlyPlanningPeriod: description: Monthly planning period setting for scheduling. Only one of planningPeriod or monthlyPlanningPeriod may be defined $ref: '#/definitions/ValueWrapperMonthlyPlanningPeriodSettings' startDayOfWeekend: type: string description: Start day of weekend for scheduling enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday InitiatingShiftRequestItem: type: object required: - id - schedule - weekDate properties: id: type: string description: The ID of the shift that the initiating user wants to give up in this trade schedule: description: A reference to the associated schedule to which this initiating shift belongs $ref: '#/definitions/BuScheduleReference' weekDate: type: string format: date description: 'The start week date of this schedule in the business unit time zone (yyyy-MM-dd format). Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' ValueWrapperShiftTradeTargetRequestItem: type: object properties: value: description: The value for the associated field $ref: '#/definitions/ShiftTradeTargetRequestItem' ImportForecastResponse: type: object properties: status: type: string description: The status of the operation enum: - Processing - Complete - Canceled - Error operationId: type: string description: The ID for the operation result: description: The result of the operation. Always null, result will come via notification $ref: '#/definitions/BuShortTermForecast' HistoricalAdherenceActuals: type: object properties: actualActivityCategory: type: string description: Activity in which the user is actually engaged enum: - OnQueueWork - Break - Meal - Meeting - OffQueueWork - TimeOff - Training - Unavailable - Unscheduled actualSecondaryPresenceLookupId: type: string description: The lookup ID used to retrieve the actual secondary status from map of lookup ID to corresponding secondary presence ID startOffsetSeconds: type: integer format: int32 description: Actual start offset in seconds relative to query start time endOffsetSeconds: type: integer format: int32 description: Actual end offset in seconds relative to query start time CreateAgentTimeOffRequest: type: object required: - activityCodeId properties: activityCodeId: type: string description: The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category notes: type: string description: Notes about the time off request fullDayManagementUnitDates: type: array description: A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone items: type: string fullDayEarliestStartOffsetMinutes: type: array description: Earliest start offset in minutes for each full-day request date. Values may be null when time-off estimation is disabled or no estimate is available items: type: integer format: int32 fullDayLatestEndOffsetMinutes: type: array description: Latest end offset in minutes for each full-day request date. Values may be null when time-off estimation is disabled or no estimate is available items: type: integer format: int32 partialDayStartDateTimes: type: array description: A set of start date-times in ISO-8601 format for partial day requests items: type: string format: date-time dailyDurationMinutes: type: integer format: int32 description: Daily duration in minutes applied to all days of this time off request. Ignored if durationMinutes is specified. At least one of dailyDurationMinutes or durationMinutes is required durationMinutes: type: array description: Duration in minutes for each day of this time off request. Must match the size of fullDayManagementUnitDates or partialDayStartDateTimes. At least one of dailyDurationMinutes or durationMinutes is required items: type: integer format: int32 payableMinutes: type: array description: Payable minutes for each day of this time off request, representing scheduled paid time displaced by this request. Defaults to dailyDurationMinutes if not specified items: type: integer format: int32 ScheduleBidGroupSummaryList: type: object required: - scheduleBidGroupSummaries properties: scheduleBidGroupSummaries: type: array description: Schedule bid group summary items: $ref: '#/definitions/ScheduleBidGroupSummary' ListWrapperAgentWorkPlanField: type: object properties: values: type: array items: type: string enum: - Name - PaidHours UserSearchRule: type: object required: - parts properties: parts: type: array description: The parts of this rule; the results of these are ANDed together. items: $ref: '#/definitions/UserSearchRulePart' UpdateScheduleBid: type: object properties: name: type: string description: The name of the schedule bid forecast: description: The selected forecast used for schedule set generation for this bid $ref: '#/definitions/BuShortTermForecastWeekReference' bidWindowStartDate: type: string format: date description: 'The bid start date where agents start participating in schedule bidding relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' bidWindowEndDate: type: string format: date description: 'The bid end date relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' effectiveDate: type: string format: date description: 'The date when schedule sets would be effective for schedule generation relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' weeksToSchedule: type: integer format: int32 description: The number of weeks to generate schedule set through this bid endOverridesAndRotations: type: boolean description: If true, all existing overrides, work plan rotations will be ended one day before effective date of this bid agentRankingType: type: string description: The type of agent ranking selected for this bid enum: - HireDate - Performance rankingTiebreakerType: type: string description: Ranking tiebreaker to be used enum: - HireDate - Performance - Custom - RandomlyAssign status: type: string description: The state of the bid enum: - Draft - Locked - Optimized - Scheduled - Open - Closed - Processed - Published TimeOffPlanListing: type: object properties: entities: type: array items: $ref: '#/definitions/TimeOffPlan' AgentMuScheduleQuery: type: object required: - endDate - startDate properties: startDate: type: string format: date-time description: 'The start date for the range to query the schedule''s for the agent''s management unit. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endDate: type: string format: date-time description: 'The end date for the range to query the schedule''s for the agent''s management unit. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' ForecastServiceLevelResponse: type: object properties: percent: type: integer format: int32 description: The percent of calls to answer in the number of seconds defined seconds: type: integer format: int32 description: The number of seconds to define for the percent of calls to be answered CreateStaffingGroupAllocation: type: object required: - initialAttritionPercentage - initialShrinkagePercentage - staffingGroupId - startingWeeklyFullTimeEquivalentCount properties: staffingGroupId: type: string description: The ID of the staffing group used in this capacity plan initialShrinkagePercentage: type: number format: double description: The shrinkage percentage of the staffing group that can be used for all weeks in the planning period, in the scale of 0 - 100 initialAttritionPercentage: type: number format: double description: The attrition percentage of the staffing group that can be used for all weeks in the planning period, in the scale of 0 - 100 startingWeeklyFullTimeEquivalentCount: type: number format: double description: The weekly count of full time equivalent agents in the staffing group that can be used for the first week of the planning period WfmHistoricalAdherenceBulkResult: type: object properties: startDate: type: string format: date-time description: Beginning of the date range for this result in ISO-8601 format endDate: type: string format: date-time description: End of the date range for this result in ISO-8601 format managementUnitId: type: string description: The ID of the management unit for this result userResults: type: array description: The individual results for each user items: $ref: '#/definitions/WfmHistoricalAdherenceBulkUserResult' lookupIdToSecondaryPresenceId: type: object description: Map of secondary presence lookup ID to corresponding secondary presence ID additionalProperties: type: string QueryOpportunityEnrollmentResult: type: object required: - agent - metadata - opportunityId - status properties: id: type: string description: The globally unique identifier for the object. readOnly: true opportunityId: type: string description: The ID of the opportunity agent: description: A reference to the agent who created the enrollment $ref: '#/definitions/UserReference' status: type: string description: The current status of the enrollment enum: - Pending - Approved - Denied - Withdrawn - Processing schedule: description: The schedule on which the enrollment was added when this enrollment was approved $ref: '#/definitions/BuScheduleReference' systemMessageCode: type: string description: The system-generated message code about enrollment processing results or failures enum: - ActivityChanged - AgentEnrollmentsHourlyLimitExceeded - BatchLimitExceeded - BusinessUnitEnrollmentsHourlyLimitExceeded - BusinessUnitNotFound - BusinessUnitOpportunityHourlyLimitExceeded - CapacityFull - Conflict - DateMustBeInFuture - DeadlineMustBeAfterOpenTime - DeadlineMustBeBeforeOrEqualToStartTime - EndTimeMustBeAfterStartTime - EnrollmentNotFound - InternalError - InternalErrorAutoApproval - InternalErrorDenial - InternalErrorScheduleUpdate - InvalidOpportunityLength - InvalidOpportunityStatus - InvalidRequest - InvalidStatusTransition - InvalidTime - NoInvitationsForPublish - OpenTimeMustBeBeforeStartTime - OpportunityClosed - OpportunityNotFound - OpportunityNotOpen - ScheduleConflict - ScheduleNotFound - ServiceUnavailable - StartTimeMustBeWithinOneYear - StatusNotDraft reviewNote: type: string description: Supervisor's note explaining the agent's enrollment status change denialCode: type: string description: The denial code enum: - ManuallyDenied - AutomaticallyClosed - ManuallyClosed - CapacityFull - ScheduleConflict metadata: description: The metadata for the enrollment $ref: '#/definitions/QueryOpportunityEnrollmentMetadata' AlternativeShiftOffersViewResponseTemplate: type: object required: - agentId - alternativeDays - businessUnitId - jobId - managementUnitId - offerWeekDate - schedule - shifts properties: jobId: type: string description: The unique identifier of the async list job that created this file businessUnitId: type: string description: The unique identifier of the business unit to which the user (agent) belongs at the time the offer is created agentId: type: string description: The unique identifier of the agent for whom the offer was made managementUnitId: type: string description: The unique identifier of the management unit to which the user (agent) belongs at the time the offer is created schedule: description: The existing schedule information associated with the offer $ref: '#/definitions/AlternativeShiftScheduleLookup' offerWeekDate: type: string format: date description: 'The first date of the week for the schedule we are querying in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' shifts: type: array description: The shifts the agent is scheduled for at the time the offer is created items: $ref: '#/definitions/AlternativeShiftAgentScheduledShift' alternativeDays: type: array description: The offered alternative shift days in this week at the time the offer is created items: $ref: '#/definitions/AlternativeShiftAgentScheduledShift' BusinessUnitSettingsResponse: type: object required: - metadata - startDayOfWeek - timeZone properties: startDayOfWeek: type: string description: The start day of week for this business unit enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday timeZone: type: string description: The time zone for this business unit, using the Olsen tz database format shortTermForecasting: description: Short term forecasting settings $ref: '#/definitions/BuShortTermForecastingSettings' scheduling: description: Scheduling settings $ref: '#/definitions/BuSchedulingSettingsResponse' notifications: description: Notification settings $ref: '#/definitions/BuNotificationSettingsResponse' learning: description: Learning settings $ref: '#/definitions/BuActivitySettingsResponse' coaching: description: Coaching settings $ref: '#/definitions/BuActivitySettingsResponse' metadata: description: Version metadata for this business unit $ref: '#/definitions/WfmVersionedEntityMetadata' SearchAlternativeShiftTradesRequest: type: object properties: managementUnitIds: type: array description: The list of management unit IDs for this alternative shift trade search. Either managementUnitIds or agentIds is required items: type: string agentIds: type: array description: The list of agent IDs for this alternative shift trade search. Either managementUnitIds or agentIds is required items: type: string AdherenceExplanationNotification: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true agent: description: The agent for whom the adherence explanation applies $ref: '#/definitions/UserReference' managementUnit: description: The management unit to which the agent belonged at the time the adherence explanation was submitted $ref: '#/definitions/ManagementUnitReference' businessUnit: description: The business unit to which the agent belonged at the time the adherence explanation was submitted $ref: '#/definitions/BusinessUnitReference' startDate: type: string format: date-time description: 'The start date of the adherence explanation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' lengthMinutes: type: integer format: int32 description: The length of the adherence explanation in minutes status: type: string description: The status of the adherence explanation enum: - Pending - Approved - Denied type: type: string description: The type of the adherence explanation enum: - Late notes: type: string description: Notes about the adherence explanation selfUri: type: string format: uri description: The URI for this object readOnly: true WorkPlanReference: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true managementUnit: description: The management unit to which this work plan belongs. Nullable in some routes $ref: '#/definitions/ManagementUnitReference' selfUri: type: string format: uri description: The URI for this object readOnly: true BuIntradayScheduleData: type: object properties: onQueueTimeSeconds: type: integer format: int64 description: The total on-queue time in seconds for all agents in this group QueryOpportunitiesResponse: type: object properties: result: description: The query result. Null if downloadUrl is populated $ref: '#/definitions/OpportunitiesResultWithPagination' downloadUrl: type: string description: The URL used to retrieve large datasets. If present, the response conforms to the schema for the result field WorkPlanBidGroupSummaryList: type: object required: - workPlanBidGroupSummaryList properties: workPlanBidGroupSummaryList: type: array description: List of work plan bid group summary items: $ref: '#/definitions/WorkPlanBidGroupSummary' LongTermForecastPlanningGroupData: type: object required: - averageHandleTimeSecondsPerDay - offeredPerDay - planningGroupId properties: planningGroupId: type: string description: The ID of the planning group to which this data applies. Note this is a snapshot of the planning group at the time of forecast creation and may not correspond to the current configuration offeredPerDay: type: array description: Forecast offered counts per day for this planning group items: type: number format: double averageHandleTimeSecondsPerDay: type: array description: Forecast average handle time per day in seconds items: type: number format: double ListWrapperInterval: type: object properties: values: type: array description: 'Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss' items: type: string format: interval description: 'Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss' BuShortTermForecastReference: type: object required: - weekDate properties: id: type: string description: The globally unique identifier for the object. weekDate: type: string format: date description: 'The weekDate of the short term forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' description: type: string description: The description of the short term forecast readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true BuScheduleListing: type: object properties: entities: type: array items: $ref: '#/definitions/BuScheduleListItem' MoveAgentsResponse: type: object properties: requestingUser: description: The user that made the request $ref: '#/definitions/UserReference' destinationManagementUnit: description: The management unit specified on the request $ref: '#/definitions/ManagementUnitReference' results: type: array description: The list containing the agent and result of the move operation items: $ref: '#/definitions/MoveAgentResponse' BuAgentScheduleShiftRequest: type: object properties: id: type: string description: The ID of the shift startDate: type: string format: date-time description: 'The start date of this shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true lengthMinutes: type: integer format: int32 description: The length of this shift in minutes readOnly: true activities: type: array description: The activities associated with this shift items: $ref: '#/definitions/BuAgentScheduleActivity' manuallyEdited: type: boolean description: Whether this shift was manually edited. This is only set by clients and is used for rescheduling schedule: description: The schedule to which this shift belongs readOnly: true $ref: '#/definitions/BuScheduleReference' workPlanId: description: The ID of the work plan for which the work plan shift emanates from $ref: '#/definitions/ValueWrapperString' workPlanShiftId: description: The ID of the work plan shift that was used in schedule generation $ref: '#/definitions/ValueWrapperString' AgentMuScheduleResult: type: object required: - agentSchedules - referenceStartDate properties: referenceStartDate: type: string format: date-time description: 'The reference start date to use when calculating offsets for shifts and activities. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' agentSchedules: type: array description: The list of agent schedules for the management unit items: $ref: '#/definitions/AgentMuScheduleItem' AgentQueryAdherenceExplanationsResponse: type: object properties: job: description: The asynchronous job handling the query $ref: '#/definitions/AdherenceExplanationJobReference' result: description: The result of the query. May come via notification $ref: '#/definitions/AdherenceExplanationListingAgentQueryResponse' downloadUrl: type: string description: The URL from which to download the result. May come via notification BulkUpdateShiftTradeStateResultItem: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true state: type: string description: The state of the shift trade after the update request is processed enum: - Unmatched - Matched - Approved - Denied - Expired - Canceled reviewedBy: description: The user who reviewed the request, if applicable. The id may be 'System' if it was an automated process $ref: '#/definitions/UserReference' reviewedDate: type: string format: date-time description: 'The date the request was reviewed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' failureReason: type: string description: The reason the update failed, if applicable enum: - InitiatingAgentScheduleNotFound - InitiatingAgentShiftHasExternalActivities - InitiatingAgentShiftNotFound - InitiatingExternalActivityOutsideReceivingShift - ReceivingAgentNotFound - ReceivingAgentScheduleNotFound - ReceivingAgentShiftHasExternalActivities - ReceivingAgentShiftNotFound - ReceivingExternalActivityOutsideInitiatingShift - ScheduleNotPublished - TransitionNotAllowed metadata: description: Version metadata for the shift trade $ref: '#/definitions/WfmVersionedEntityMetadata' FixedAvailability: type: object properties: availabilityRange: description: The range of time of day the activity can be scheduled $ref: '#/definitions/AvailabilityRange' dateRange: description: The range of date for which the activity plan could be scheduled $ref: '#/definitions/RequiredLocalDateRange' daysOfWeek: type: array description: The days of week available for scheduling. Empty list or null means daysOfWeek is not considered items: type: string enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday MatchShiftTradeResponse: type: object properties: trade: description: The associated shift trade $ref: '#/definitions/ShiftTradeResponse' violations: type: array description: Constraint violations which disallow this shift trade items: $ref: '#/definitions/ShiftTradeMatchViolation' adminReviewViolations: type: array description: Constraint violations for this shift trade which require shift trade administrator review items: $ref: '#/definitions/ShiftTradeMatchViolation' unevaluatedRules: type: array description: Unevaluated rules for this shift trade which require shift trade administrator review uniqueItems: true items: type: string enum: - PlanningPeriodMinPaidTime - PlanningPeriodMaxPaidTime - MinimumTimeBetweenShifts PlanningGroupToStaffingGroupsResponse: type: object required: - planningGroup properties: planningGroup: description: The ID of the planning group $ref: '#/definitions/PlanningGroupReference' staffingGroups: type: array description: The list of staffing groups that are associated with the planning group uniqueItems: true items: $ref: '#/definitions/StaffingGroupReference' BuAgentSchedulePublishedScheduleReference: type: object properties: id: type: string description: The ID of the schedule weekDate: type: string format: date description: 'The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' weekCount: type: integer format: int32 description: The number of weeks encompassed by the schedule selfUri: type: string format: uri description: The URI for this object readOnly: true QueryAgentUnavailableTimesValidationJobResponse: type: object required: - agent - status properties: id: type: string description: The globally unique identifier for the object. readOnly: true agent: description: The agent who started the job $ref: '#/definitions/UserReference' status: type: string description: Status of the job enum: - Processing - Complete - Canceled - Error result: description: Validation results if status == 'Complete' $ref: '#/definitions/UnavailableTimesValidationResult' error: description: Error details if status == 'Error'. The error occurs if the validation job has failed $ref: '#/definitions/ErrorBody' selfUri: type: string format: uri description: The URI for this object readOnly: true ServiceGoalTemplateImpactOverride: type: object required: - enabled - impact properties: enabled: type: boolean description: Whether service goal overrides are enabled for this service goal template impact: description: Settings controlling max percent increase and decrease of service goals for this service goal template $ref: '#/definitions/WfmServiceGoalImpactSettings' SchedulingOptionsRequest: type: object properties: noForecastOptions: description: Schedule generation options to apply if no forecast is supplied $ref: '#/definitions/SchedulingNoForecastOptionsRequest' activitySmoothingType: type: string description: Overrides the default BU level activity smoothing type for this schedule generation enum: - ReduceConcurrentActivitiesAcrossBu - ReduceConcurrentActivitiesAcrossMu - ConsistentServiceLevel induceScheduleVariability: type: boolean description: Overrides the default BU level induce schedule variability setting for this schedule generation CapacityPlanStaffingGroupMetricChangeHistoryListResponse: type: object properties: entities: type: array items: $ref: '#/definitions/StaffingGroupMetricChangeResponse' BuScheduleReference: type: object properties: id: type: string description: The ID of the schedule weekDate: type: string format: date description: 'The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' selfUri: type: string format: uri description: The URI for this object readOnly: true ActivityPlanRunJobResponse: type: object required: - activityPlan - exceptions - id - status properties: id: type: string description: The globally unique identifier for the object. status: type: string description: The status of the job enum: - Processing - Complete - Error exceptions: type: array description: The list of exceptions that occurred while running this activity plan job. These are exceptions that affect individual occurrences but didn't prevent the job from completing items: $ref: '#/definitions/ActivityPlanJobException' error: description: Error details if status == 'Error'. These are errors that caused the job to fail to complete $ref: '#/definitions/ErrorBody' activityPlan: description: The activity plan associated with this job $ref: '#/definitions/ActivityPlanReference' selfUri: type: string format: uri description: The URI for this object readOnly: true PlanningGroupToStaffingGroupsListing: type: object properties: entities: type: array items: $ref: '#/definitions/PlanningGroupToStaffingGroupsResponse' WaitlistPosition: type: object properties: timeOffRequest: description: The time off request for this wait list position $ref: '#/definitions/TimeOffRequestReference' timeOffLimit: description: The time off limit for which time off request is waitlisted $ref: '#/definitions/TimeOffLimitReference' date: type: string format: date description: 'The date to which this wait list position applies, as defined by the time zone of the business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' waitlistPosition: type: integer format: int32 description: The time off request's position in the waitlist on the date. 1 means time off is the first in the waitlist BulkUpdateShiftTradeStateRequestItem: type: object required: - metadata - state properties: id: type: string description: The globally unique identifier for the object. state: type: string description: The new state to set on the shift trade enum: - Unmatched - Matched - Approved - Denied - Expired - Canceled metadata: description: Version metadata for the shift trade $ref: '#/definitions/WfmVersionedEntityMetadata' TimeOffRequestReference: type: object properties: id: type: string description: The id of the time off request selfUri: type: string format: uri description: The URI for this object readOnly: true AdminBulkUpdateAlternativeShiftTradeStateRequest: type: object required: - managementUnitId properties: entities: type: array items: $ref: '#/definitions/AdminBulkUpdateAlternativeShiftTradeState' managementUnitId: type: string description: The ID of the management unit for this alternative shift bulk trade update LongTermRequirementsServiceGoal: type: object required: - abandonRateGoalPercent - serviceLevelGoalPercent - serviceLevelObjectiveSeconds - targetAsaSec - useAbandonRateGoal - useAsaTarget - useServiceLevelTarget properties: useAsaTarget: type: boolean description: Toggle for target average speed of answer from service goals targetAsaSec: type: number format: double description: Value of target average speed of answer from service goals useServiceLevelTarget: type: boolean description: Toggle for service level objective from service goals serviceLevelObjectiveSeconds: type: number format: double description: Value of service level objective seconds from service goals serviceLevelGoalPercent: type: number format: double description: Value of service level objective percent from service goals useAbandonRateGoal: type: boolean description: Toggle for abandon rate from service goals abandonRateGoalPercent: type: number format: double description: Value of abandon rate objective AgentQueryOpportunities: type: object required: - businessUnits properties: nextStartDate: type: string format: date-time description: The start date to use for the next query to retrieve additional results in ISO-8601 format. Null if there are no more results businessUnits: type: array description: The opportunities for the agent grouped by business unit items: $ref: '#/definitions/AgentBusinessUnitOpportunities' EstimateAvailablePartialDayTimeOffRequest: type: object required: - date properties: date: type: string format: date-time description: Start date-time in ISO-8601 format for partial day request requestedDurationMinutes: type: integer format: int32 description: A requested length of time off request in minutes. If the value is null, then the system will use activity code length setting UpdatePlanningGroupRequest: type: object required: - metadata properties: name: type: string description: The name of the planning group routePaths: description: Set of route paths to associate with the planning group $ref: '#/definitions/SetWrapperRoutePathRequest' serviceGoalTemplateId: type: string description: The ID of the service goal template to associate with this planning group metadata: description: Version metadata for the planning group $ref: '#/definitions/WfmVersionedEntityMetadata' WfmHistoricalAdherenceQuery: type: object required: - startDate properties: startDate: type: string format: date-time description: Beginning of the date range to query in ISO-8601 format endDate: type: string format: date-time description: End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time timeZone: type: string description: The time zone, in olson format, to use in defining days when computing adherence. The results will be returned as UTC timestamps regardless of the time zone input. userIds: type: array description: The userIds to report on. If null or not set, adherence will be computed for all the users in management unit or requested teamIds uniqueItems: true items: type: string includeExceptions: type: boolean description: Whether user exceptions should be returned as part of the results teamIds: type: array description: 'The teamIds to report on. If null or not set, adherence will be computed for requested users if applicable or otherwise all users in the management unit. Note: If teamIds is also specified, only adherence for users in the requested teams will be returned' uniqueItems: true items: type: string ShiftTradeInitiatingSideResponseItem: type: object required: - managementUnit - schedule - shift - user properties: user: description: The user who initiated this trade $ref: '#/definitions/UserReference' managementUnit: description: The management unit of the user who initiated this trade $ref: '#/definitions/ManagementUnitReference' schedule: description: Associated schedule information for the initiating user $ref: '#/definitions/ScheduleReferenceWithBusinessUnit' shift: description: The shift offered for trade by the initiating user $ref: '#/definitions/ShiftTradeShiftResponseItem' AlternativeShiftBuSettingsResponse: type: object required: - enabledGranularities - metadata - minMinutesBeforeStartTime - retainedActivityCategories properties: enabledGranularities: type: array description: The granularity at which alternative shifts is allowed. An empty list means Alternative Shifts is disabled items: type: string enum: - Daily minMinutesBeforeStartTime: type: integer format: int32 description: The minimum number of minutes before the start of a shift that an alternative shift can be automatically approved retainedActivityCategories: type: array description: Categories of activities that are required to remain at the same time slot for the alternative shifts offered. An empty list represents no retained activities items: type: string enum: - Break - Meal - Meeting - OffQueueWork - TimeOff - Training - Unavailable metadata: description: Version metadata for this business unit's alternative shift settings $ref: '#/definitions/WfmVersionedEntityMetadata' BuShortTermForecastListItem: type: object required: - id properties: id: type: string description: The globally unique identifier for the object. weekDate: type: string format: date description: 'The start week date of this forecast in yyyy-MM-dd. Must fall on the start day of week for the associated business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' weekCount: type: integer format: int32 description: The number of weeks this forecast covers creationMethod: type: string description: The method by which this forecast was created enum: - Import - ImportedHistoricalWeightedAverage - HistoricalWeightedAverage - Advanced description: type: string description: The description of this forecast legacy: type: boolean description: Whether this forecast contains modifications on legacy metrics readOnly: true metadata: description: Metadata for this forecast $ref: '#/definitions/WfmVersionedEntityMetadata' canUseForScheduling: type: boolean description: Whether this forecast can be used for scheduling selfUri: type: string format: uri description: The URI for this object readOnly: true BuTimeOffPlanListing: type: object properties: entities: type: array items: $ref: '#/definitions/BuTimeOffPlanResponse' downloadUrl: type: string description: URL from which to fetch results for requests with a large result set. If populated, the downloaded data will conform to the same schema as would normally be returned, excepting downloaded data will never itself contain a downloadUrl ValueWrapperUserSearchRule: type: object properties: value: description: The value for the associated field $ref: '#/definitions/UserSearchRule' SchedulingStatusResponse: type: object properties: id: type: string description: The ID generated for the scheduling job. Use to GET result when job is completed. readOnly: true status: type: string description: The status of the scheduling job. readOnly: true enum: - Pending - Success - Failed - Ongoing - PartialFailure errorDetails: type: array description: If the request could not be properly processed, error details will be given here. readOnly: true items: $ref: '#/definitions/SchedulingProcessingError' schedulingResultUri: type: string description: The uri of the scheduling result. It has a value if the status is 'Success'. readOnly: true percentComplete: type: integer format: int32 description: The percentage of the job that is complete. readOnly: true BuAbandonRate: type: object required: - include properties: include: type: boolean description: Whether to include abandon rate in the associated configuration percent: type: integer format: int32 description: Abandon rate percent goal. Required if include == true AgentBidScheduleSetOverrideRequest: type: object required: - agentId properties: agentId: type: string description: The ID of the agent overrideScheduleSetId: type: string description: If provided, the schedule set overrides the agent's assigned schedule set overrideReason: type: string description: The reason the assigned schedule set has been overridden. This must be null if no override schedule is set enum: - UnableToBid - ChangeOfCircumstance - NewHire - EmployeeMove SearchUnmatchedShiftTradeResponseItem: type: object required: - receivingShiftMatches - trade properties: trade: description: A trade which matches search criteria $ref: '#/definitions/ShiftTradeResponseItem' receivingShiftMatches: type: array description: The shifts that match the search criteria items: $ref: '#/definitions/ShiftTradeMatchResponseItem' BuAgentSchedulesSearchResponse: type: object properties: agentSchedules: type: array description: The requested agent schedules items: $ref: '#/definitions/BuAgentScheduleSearchResponse' businessUnitTimeZone: type: string description: The time zone configured for the business unit to which this schedule applies publishedSchedules: type: array description: References to all published week schedules overlapping the start/end date query parameters items: $ref: '#/definitions/BuAgentSchedulePublishedScheduleReference' AddAdherenceExplanationAgentRequest: type: object required: - lengthMinutes - startDate - type properties: type: type: string description: The type of the adherence explanation enum: - Late startDate: type: string format: date-time description: The start timestamp of the adherence explanation in ISO-8601 format lengthMinutes: type: integer format: int32 description: The length of the adherence explanation in minutes notes: type: string description: Notes about the adherence explanation UpdateTimeOffPlanRequest: type: object required: - metadata properties: name: type: string description: The name of this time off plan. activityCodeIds: description: The set of activity code IDs to associate with this time off plan. $ref: '#/definitions/SetWrapperString' timeOffLimitIds: description: The set of time off limit IDs to associate with this time off plan. $ref: '#/definitions/SetWrapperString' autoApprovalRule: type: string description: Auto approval rule for the time off plan. enum: - Never - Always - CheckLimits - CheckActivityCodes - CheckLimitsAndActivityCodes daysBeforeStartToExpireFromWaitlist: type: integer format: int32 description: The number of days before the time off request start date for when the request will be expired from the waitlist. hrisTimeOffType: description: Time off type, if this time off plan is associated with the integration. $ref: '#/definitions/ValueWrapperHrisTimeOffType' active: type: boolean description: Whether this time off plan should be used by agents. metadata: description: Version metadata for the time off plan $ref: '#/definitions/WfmVersionedEntityMetadata' WorkPlanConstraintConflictMessage: type: object properties: type: type: string description: Type of constraint conflict that can be resolved by clients in order to generate agent schedules enum: - UnknownFix - WithPotentialFixes arguments: type: array description: The arguments to the type of the message that can help clients resolve validation issues items: $ref: '#/definitions/WorkPlanValidationMessageArgument' ShiftTradeExternalActivityRule: type: object required: - action - externalActivityType properties: externalActivityType: type: string description: The external activity type to which to apply this rule enum: - ActivityPlan - Coaching - Learning - Opportunity action: type: string description: The action this rule invokes enum: - DoNotAllowTrade - KeepWithAgent activityCodeIdReplacement: type: string description: The ID of the activity code with which to replace to replace external activities (required if action == KeepWithAgent, must be a default activity code ID) WfmIntegrationListing: type: object properties: entities: type: array items: $ref: '#/definitions/WfmIntegrationResponse' UpdateScheduleUploadSchema: type: object required: - metadata properties: description: type: string description: The description to set for the schedule published: type: boolean description: 'Whether to publish the schedule. Note: a schedule cannot be un-published unless another schedule is published over it' shortTermForecast: description: The short term forecast to associate with the schedule $ref: '#/definitions/BuShortTermForecastReference' headcountForecast: description: The headcount forecast to associate with the schedule $ref: '#/definitions/BuHeadcountForecastBuPlanningGroupHeadcountForecastUploadSchema' agentSchedules: type: array description: Individual agent schedules items: $ref: '#/definitions/BuUpdateAgentScheduleUploadSchema' metadata: description: Version metadata for this schedule $ref: '#/definitions/WfmVersionedEntityMetadata' ShiftTradeTargetRequestItem: type: object properties: userId: type: string description: The user to whom the shift trade request was sent in a direct trade AlternativeShiftTradeBulkUpdateTemplateItem: type: object required: - metadata - state - tradeId properties: tradeId: type: string description: The ID of this alternative shift trade state: type: string description: The current state of this alternative shift trade request enum: - Canceled - Denied - Expired - Submitted - Approved failureReason: type: string description: The reason the update failed, if applicable enum: - TransitionNotAllowed - NotAuthorized adminDateReviewed: type: string format: date-time description: The timestamp of when the trade request was manually reviewed by an admin in ISO-8601 format adminReviewedBy: description: The admin who manually reviewed this alternative shift trade after system denial $ref: '#/definitions/UserReference' metadata: description: Version metadata for this alternative shift trade $ref: '#/definitions/WfmVersionedEntityMetadata' AvailableTimeOffRange: type: object properties: timeOffLimit: description: The time off limit $ref: '#/definitions/TimeOffLimitReference' startDate: type: string format: date description: 'Start date of the requested date range. The end date is determined by the size of interval list. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' granularity: type: string description: Granularity choice for time off limit enum: - Daily - FifteenMinutes availableMinutesPerInterval: type: array description: The list of available time off values in minutes per granularity interval items: type: integer format: int32 waitlistedRequestsPerInterval: type: array description: The current number of waitlisted time off requests for every interval per granularity items: type: integer format: int32 waitlistEnabled: type: boolean description: Whether the time off request can be waitlisted ShiftTradeTargetResponseItem: type: object properties: user: description: The user to whom the shift trade request was sent in a direct trade $ref: '#/definitions/UserReference' ActivityPlanResponse: type: object required: - activityCode - countsAsPaidTime - createdBy - createdDate - description - facilitated - id - initialSchedulePeriod - lengthMinutes - modifiedBy - modifiedDate - name - optimizationObjective - state - transitionTimeMinutes - type properties: id: type: string description: The globally unique identifier for the object. name: type: string description: The name of the activity plan managementUnits: type: array description: The management units to which this activity plan applies. Empty list or null means this activity plan applies to the entire business unit items: $ref: '#/definitions/ManagementUnitReference' description: type: string description: The description of this activity plan activityCode: description: The activity code associated with this activity plan. It is recommended to load and cache the entire list of activity codes rather than look up individual codes $ref: '#/definitions/ActivityCodeReference' type: type: string description: The type of the activity plan enum: - Individual - Group initialSchedulePeriod: description: The initial schedule period of the activity plan $ref: '#/definitions/SchedulingPeriod' lengthMinutes: type: integer format: int32 description: The length of the activity in minutes groupSettings: description: Group settings for this activity plan $ref: '#/definitions/GroupSettings' recurrenceSettings: description: Recurrence settings for this activity plan $ref: '#/definitions/RecurrenceSettings' attendeesSearchRule: description: Attendee search rule for this activity plan $ref: '#/definitions/UserSearchRule' facilitated: type: boolean description: Whether the sessions created by this activity plan should be facilitated facilitatorsSearchRule: description: Facilitator search rule for this activity plan $ref: '#/definitions/UserSearchRule' transitionTimeMinutes: type: integer format: int32 description: Transition time in minutes between facilitated sessions serviceGoalImpactOverrides: description: Allowable service goal impact override settings for this activity plan $ref: '#/definitions/ActivityPlanServiceGoalImpactOverrides' optimizationObjective: type: string description: The optimization objective of this activity plan enum: - FavorServiceGoals - FavorSchedulingAll fixedAvailability: type: array description: Fixed availability configuration for this activity plan items: $ref: '#/definitions/FixedAvailability' state: type: string description: The state of this activity plan enum: - Active - Inactive countsAsPaidTime: type: boolean description: Whether the activity should count as paid time createdDate: type: string format: date-time description: The date the activity plan was created, in ISO-8601 format createdBy: description: The user who created this activity plan $ref: '#/definitions/UserReference' modifiedDate: type: string format: date-time description: The date the activity plan was modified, in ISO-8601 format modifiedBy: description: The last user to modify this activity plan. The id may be 'System' if it was an automated process $ref: '#/definitions/UserReference' lastRunDate: type: string format: date-time description: The date on which the activity plan was last manually run, in ISO-8601 format lastRunBy: description: The last user to run this activity plan $ref: '#/definitions/UserReference' startTimeIncrementMinutes: type: integer format: int32 description: The valid start times available when scheduling sessions selfUri: type: string format: uri description: The URI for this object readOnly: true ManagementUnit: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string businessUnit: description: The business unit to which this management unit belongs $ref: '#/definitions/BusinessUnitReference' startDayOfWeek: type: string description: Start day of week for scheduling and forecasting purposes. Moving to Business Unit enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday timeZone: type: string description: The time zone for the management unit in standard Olson format. Moving to Business Unit settings: description: The configuration settings for this management unit $ref: '#/definitions/ManagementUnitSettingsResponse' metadata: description: Version info metadata for this management unit. Deprecated, use settings.metadata $ref: '#/definitions/WfmVersionedEntityMetadata' division: description: The division to which this entity belongs. $ref: '#/definitions/DivisionReference' modifiedBy: description: The user who last modified this entity. Deprecated, use field from settings.metadata instead readOnly: true $ref: '#/definitions/UserReference' dateModified: type: string format: date-time description: 'The date and time at which this entity was last modified. Deprecated, use field from settings.metadata instead. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: The version of the underlying entity. Deprecated, use field from settings.metadata instead readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true BuAsyncScheduleResponse: type: object properties: status: type: string description: The status of the operation enum: - Processing - Complete - Canceled - Error operationId: type: string description: The ID for the operation result: description: The result of the operation. Null unless status == Complete $ref: '#/definitions/BuScheduleMetadata' WorkPlanActivity: type: object properties: activityCodeId: type: string description: ID of the activity code associated with this activity description: type: string description: Description of the activity lengthMinutes: type: integer format: int32 description: Length of the activity in minutes startTimeIsRelativeToShiftStart: type: boolean description: Whether the start time of the activity is relative to the start time of the shift it belongs to flexibleStartTime: type: boolean description: Whether the start time of the activity is flexible earliestStartTimeMinutes: type: integer format: int32 description: Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true latestStartTimeMinutes: type: integer format: int32 description: Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true exactStartTimeMinutes: type: integer format: int32 description: Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false startTimeIncrementMinutes: type: integer format: int32 description: Increment in offset minutes that would contribute to different possible start times for the activity countsAsPaidTime: type: boolean description: Whether the activity is paid countsAsContiguousWorkTime: type: boolean description: Whether the activity duration is counted towards contiguous work time minimumLengthFromShiftStartMinutes: type: integer format: int32 description: The minimum duration between shift start and shift item (e.g., break or meal) start in minutes minimumLengthFromShiftEndMinutes: type: integer format: int32 description: The minimum duration between shift item (e.g., break or meal) end and shift end in minutes maximumLengthFromShiftEndMinutes: type: integer format: int32 description: The maximum duration between shift item (e.g., break or meal) end and shift end in minutes id: type: string description: ID of the activity. This is required only for the case of updating an existing activity delete: type: boolean description: If marked true for updating an existing activity, the activity will be permanently deleted validationId: type: string description: ID of the activity in the context of work plan validation HistoricalShrinkageActivityCategoryResponse: type: object properties: activityCategory: type: string description: Activity category for which shrinkage data is provided enum: - OnQueueWork - Break - Meal - Meeting - OffQueueWork - TimeOff - Training - Unavailable - Unscheduled shrinkageForActivityCategory: description: Aggregated shrinkage data for the activity category $ref: '#/definitions/HistoricalShrinkageAggregateResponse' shrinkageForActivityCodes: type: array description: Shrinkage for the activity codes under this activity category items: $ref: '#/definitions/HistoricalShrinkageActivityCodeResponse' MoveManagementUnitResponse: type: object properties: businessUnit: description: The new business unit $ref: '#/definitions/BusinessUnitReference' status: type: string description: The status of the move. Will always be 'Processing' unless the Management Unit is already in the requested Business Unit in which case it will be 'Complete' enum: - Processing - Complete - Canceled - Error QueryWeekSummaryListJobResponseItem: type: object required: - weeks properties: weeks: type: array description: Weekly summary counts of the trades for the requested weeks items: $ref: '#/definitions/ShiftTradeWeekSummaryResponseItem' BuPlanningGroupHeadcountForecastUploadSchema: type: object required: - planningGroupId properties: requiredPerInterval: type: array description: Required headcount per interval, referenced against the reference start date items: type: number format: double requiredWithoutShrinkagePerInterval: type: array description: Required headcount per interval without accounting for shrinkage, referenced against the reference start date items: type: number format: double planningGroupId: type: string description: The ID of the planning group to which this portion of the headcount forecast applies EstimateAvailableTimeOffRequest: type: object required: - activityCodeId - paid properties: fullDayDates: type: array description: Full day dates. partialDayDates must be empty if this field is populated items: $ref: '#/definitions/EstimateAvailableFullDayTimeOffRequest' partialDayDates: type: array description: Partial day dates. fullDayDates must be empty if this field is populated items: $ref: '#/definitions/EstimateAvailablePartialDayTimeOffRequest' activityCodeId: type: string description: The ID of the activity code associated with the time off request. Activity code must be of the TimeOff category paid: type: boolean description: Whether this estimate is for a paid time off request AgentUpdateAlternativeShiftTradeRequest: type: object required: - metadata properties: state: type: string description: The new state of this alternative shift trade enum: - Canceled metadata: description: Version metadata for this alternative shift trade $ref: '#/definitions/WfmVersionedEntityMetadata' HrisTimeOffTypesJobResponse: type: object properties: entities: type: array items: $ref: '#/definitions/HrisTimeOffTypeResponse' status: type: string description: The status of the time off types job enum: - Processing - Complete - Error BulkOpportunitiesError: type: object required: - errorCode properties: errorCode: type: string description: The error code for the failed operation enum: - ActivityChanged - AgentEnrollmentsHourlyLimitExceeded - BatchLimitExceeded - BusinessUnitEnrollmentsHourlyLimitExceeded - BusinessUnitNotFound - BusinessUnitOpportunityHourlyLimitExceeded - CapacityFull - Conflict - DateMustBeInFuture - DeadlineMustBeAfterOpenTime - DeadlineMustBeBeforeOrEqualToStartTime - EndTimeMustBeAfterStartTime - EnrollmentNotFound - InternalError - InternalErrorAutoApproval - InternalErrorDenial - InternalErrorScheduleUpdate - InvalidOpportunityLength - InvalidOpportunityStatus - InvalidRequest - InvalidStatusTransition - InvalidTime - NoInvitationsForPublish - OpenTimeMustBeBeforeStartTime - OpportunityClosed - OpportunityNotFound - OpportunityNotOpen - ScheduleConflict - ScheduleNotFound - ServiceUnavailable - StartTimeMustBeWithinOneYear - StatusNotDraft LocalDateRange: type: object properties: startDate: type: string format: date description: 'The inclusive start of a date range in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' endDate: type: string format: date description: 'The inclusive end of a date range in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' WorkPlanOverrideListWrapperWorkPlanOverrideRequest: type: object properties: values: type: array items: $ref: '#/definitions/WorkPlanOverrideRequest' deleteAll: type: boolean description: if true, should delete all existing overrides for the agent and update the given overrides ScheduleGenerationWarning: type: object properties: userId: type: string description: ID of the user in the warning userNotLicensed: type: boolean description: Whether the user does not have the appropriate license to be scheduled unableToMeetMaxDays: type: boolean description: Whether the number of scheduled days exceeded the maximum days to schedule defined in the agent work plan unableToScheduleRequiredDays: type: array description: Days indicated as required to work in agent work plan where no viable shift was found to schedule uniqueItems: true items: type: string enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday unableToMeetMinPaidForTheWeek: type: boolean description: Whether the schedule did not meet the minimum paid time for the week defined in the agent work plan unableToMeetMaxPaidForTheWeek: type: boolean description: Whether the schedule exceeded the maximum paid time for the week defined in the agent work plan noNeedDays: type: array description: Days agent was scheduled but there was no need to meet. The scheduled days have no effect on service levels uniqueItems: true items: type: string enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday shiftsTooCloseTogether: type: boolean description: Whether the schedule did not meet the minimum time between shifts defined in the agent work plan WfmServiceGoalImpactSettings: type: object required: - abandonRate - averageSpeedOfAnswer - serviceLevel properties: serviceLevel: description: Allowed service level percent increase and decrease $ref: '#/definitions/WfmServiceGoalImpact' averageSpeedOfAnswer: description: Allowed average speed of answer percent increase and decrease $ref: '#/definitions/WfmServiceGoalImpact' abandonRate: description: Allowed abandon rate percent increase and decrease $ref: '#/definitions/WfmServiceGoalImpact' ValueWrapperGroupSettings: type: object properties: value: description: The value for the associated field $ref: '#/definitions/GroupSettings' BuIntradayForecastData: type: object properties: offered: type: number format: double description: The number of interactions routed into the queues in the selected planning groups for the given media type for an agent to answer averageHandleTimeSeconds: type: number format: double description: The average handle time in seconds an agent spent handling interactions QueryOpportunityEnrollmentsResponse: type: object properties: result: description: The query result. Null if downloadUrl is populated $ref: '#/definitions/QueryOpportunityEnrollmentsResult' downloadUrl: type: string description: The URL used to retrieve large datasets. If present, the response conforms to the schema for the result field AgentsBidAssignedWorkPlanOverrideRequest: type: object required: - agentWorkPlanOverrides properties: agentWorkPlanOverrides: type: array description: The list of agent work plan overrides items: $ref: '#/definitions/AgentBidWorkPlanOverrideRequest' BuShortTermForecastWeekReference: type: object required: - id - weekDate - weekNumber properties: id: type: string description: The ID of the forecast weekDate: type: string format: date description: 'The weekDate of the short term forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' description: type: string description: The description of the short term forecast readOnly: true weekNumber: type: integer format: int32 description: The week number to be used from the selected forecast. First week starts with number 1 selfUri: type: string format: uri description: The URI for this object readOnly: true HeadcountInterval: type: object required: - interval - value properties: interval: type: string format: date-time description: The start date-time for this headcount interval in ISO-8601 format, must be within the 8 day schedule value: type: number format: double description: Headcount value for this interval UpdateTimeOffPlanManagementUnitAssociation: type: object properties: staffingGroupIds: description: The IDs of staffing groups to which this time-off plan applies. If not defined, the plan is applied to the management unit $ref: '#/definitions/SetWrapperString' ShiftTradeReceivingSideResponseItem: type: object required: - user properties: user: description: The receiving user that was matched in a shift trade $ref: '#/definitions/UserReference' shift: description: The shift being traded by the receiving user, or null if picking up a shift in a one-sided trade $ref: '#/definitions/ShiftTradeShiftResponseItem' BuAgentScheduleSearchResponse: type: object properties: user: description: The user to whom this agent schedule applies $ref: '#/definitions/UserReference' shifts: type: array description: The shift definitions for this agent schedule items: $ref: '#/definitions/BuAgentScheduleShift' fullDayTimeOffMarkers: type: array description: Full day time off markers which apply to this agent schedule items: $ref: '#/definitions/BuFullDayTimeOffMarker' ManagementUnitUserListing: type: object required: - managementUnit - users properties: managementUnit: description: The management unit associated with the users $ref: '#/definitions/ManagementUnitReference' users: type: array description: Users in the management unit items: $ref: '#/definitions/UserReference' WfmForecastModificationIntervalOffsetValue: type: object required: - intervalIndex - value properties: intervalIndex: type: integer format: int32 description: The number of intervals past referenceStartDate to which to apply this modification value: type: number format: double description: The value to set for the given interval WfmTimeSpan: type: object required: - lengthMinutes - startDate properties: startDate: type: string format: date-time description: 'Start date of the time span. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' lengthMinutes: type: integer format: int32 description: The length of the time span from the start date in minutes ActivityPlanSessionStructureReference: type: object required: - id properties: id: type: string description: The globally unique identifier for the object. users: type: array description: The list of users to delete from this session items: $ref: '#/definitions/UserReference' selfUri: type: string format: uri description: The URI for this object readOnly: true TimeOffSettingsResponse: type: object properties: submissionRangeEnforced: type: boolean description: Whether to enforce a submission range for agent time off requests submissionRangeType: type: string description: The type of the submission range enum: - Relative - FixedEnd submissionEarliestDaysFromNow: type: integer format: int32 description: The earliest number of days from now for which an agent can submit a time off request. Use negative numbers to indicate days in the past submissionLatestDaysFromNow: type: integer format: int32 description: The latest number of days from now for which an agent can submit a time off request submissionLatestDate: type: string format: date description: 'The latest date for the time off request submission interpreted in the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' ShiftTradeActivityRule: type: object required: - action - activityCategory properties: activityCategory: type: string description: The activity category to which to apply this rule enum: - OnQueueWork - Break - Meal - Meeting - OffQueueWork - TimeOff - Training - Unavailable action: type: string description: The action this rule invokes enum: - Replace - DoNotAllowTrade - KeepWithSchedule activityCodeIdReplacement: type: string description: The ID of the activity code with which to replace activities belonging to the original category if applicable (required if action == Replace, must be a default activity code ID) ScheduleBidGroupCreate: type: object required: - agentIds - managementUnitId - name - planningGroupIds properties: name: type: string description: The name of the schedule bid group managementUnitId: type: string description: The ID of the management unit to which this bid group belongs agentIds: type: array description: The IDs of the agents who participate in this bid group uniqueItems: true items: type: string workPlanIds: type: array description: The IDs of the work plans used in this bid group uniqueItems: true items: type: string workPlanRotations: type: array description: The work plan rotations used in this bid group items: $ref: '#/definitions/BidGroupWorkPlanRotationRequest' planningGroupIds: type: array description: The IDs of the planning groups selected in this bid group uniqueItems: true items: type: string BidGroupScheduleSet: type: object required: - shiftSets properties: shiftSets: type: array description: The shift sets that will be used for schedule generation items: $ref: '#/definitions/ShiftSet' HeadcountForecast: type: object required: - required - requiredWithoutShrinkage properties: required: type: array description: Headcount information with shrinkage items: $ref: '#/definitions/HeadcountInterval' requiredWithoutShrinkage: type: array description: Headcount information without shrinkage items: $ref: '#/definitions/HeadcountInterval' BuAgentScheduleActivity: type: object required: - activityCodeId - description - lengthMinutes - startDate properties: startDate: type: string format: date-time description: 'The start date/time of this activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' lengthMinutes: type: integer format: int32 description: The length of this activity in minutes description: type: string description: The description of this activity activityCodeId: type: string description: The ID of the activity code associated with this activity paid: type: boolean description: Whether this activity is paid payableMinutes: type: integer format: int32 description: Payable minutes for this activity timeOffRequestId: type: string description: The ID of the time off request associated with this activity, if applicable timeOffRequestSyncVersion: type: integer format: int32 description: The sync version of the partial day time off request for which the scheduled activity is associated, if applicable externalActivityId: type: string description: The ID of the external activity associated with this activity, if applicable externalActivityType: type: string description: The type of the external activity associated with this activity, if applicable enum: - ActivityPlan - Coaching - Learning - Opportunity BulkRemoveOpportunitiesResult: type: object required: - opportunityId - status properties: status: type: string description: The status indicating the result of the bulk operation for this item enum: - Complete - Error error: description: The error result if the operation failed $ref: '#/definitions/BulkOpportunitiesError' opportunityId: type: string description: The ID of the opportunity ScheduleGenerationResult: type: object properties: failed: type: boolean description: Whether the schedule generation run failed runId: type: string description: The ID of the schedule generation run. Reference this when requesting support messageCount: type: integer format: int32 description: The number of schedule generation messages for this schedule generation run messages: type: array description: User facing messages related to the schedule generation run items: $ref: '#/definitions/ScheduleGenerationMessage' messageSeverities: type: array description: The list of messages by severity in this schedule generation run items: $ref: '#/definitions/SchedulerMessageTypeSeverity' ShortTermForecastingSettings: type: object properties: defaultHistoryWeeks: type: integer format: int32 description: The number of weeks to consider by default when generating a volume forecast ProcessScheduleUpdateUploadRequest: type: object required: - uploadKey properties: uploadKey: type: string description: The uploadKey provided by the request to get an upload URL teamIds: type: array description: The list of teams to which the users being modified belong. Only required if the requesting user has conditional permission to wfm:schedule:edit uniqueItems: true items: type: string managementUnitIdsForAddedTeamUsers: type: array description: The set of muIds to which agents belong if agents are being newly added to the schedule, if the requesting user has conditional permission to wfm:schedule:edit uniqueItems: true items: type: string PatchBuScheduleRunRequest: type: object properties: reschedulingOptions: description: The rescheduling options to update $ref: '#/definitions/PatchBuReschedulingOptionsRequest' ValueWrapperMonthlyPlanningPeriodSettings: type: object properties: value: description: The value for the associated field $ref: '#/definitions/MonthlyPlanningPeriodSettings' DayOfWeekMinimums: type: object required: - daysOfWeek - minimumValue properties: minimumValue: type: number format: double description: The minimum staff value to be applied to this planning group daysOfWeek: type: array description: Days of week this minimum staff value applies to uniqueItems: true items: type: string enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday EvaluateShiftTradeListJobResponseItem: type: object properties: entities: type: array items: $ref: '#/definitions/EvaluatedShiftTradeResponseItem' CopyScheduleBid: type: object required: - name properties: name: type: string description: The name of the new schedule bid BuTimeOffLimitListing: type: object properties: entities: type: array items: $ref: '#/definitions/BuTimeOffLimitResponse' ValueWrapperLocalDate: type: object properties: value: type: string format: date description: 'The value for the associated field. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' BuCreateTimeOffPlanRequest: type: object required: - name properties: name: type: string description: The name of this time-off plan activityCodeIds: type: array description: The IDs of activity codes to associate with this time-off plan uniqueItems: true items: type: string autoApprovalRule: type: string description: Auto approval rule for this time-off plan. Default is Never enum: - Never - Always - CheckLimits - CheckActivityCodes - CheckLimitsAndActivityCodes daysBeforeStartToExpireFromWaitlist: type: integer format: int32 description: The number of days before the time-off request start date for when the request will be expired from the waitlist. Default is 0 autoPublishApprovedTimeOffRequests: type: boolean description: Whether newly approved time-off requests with activity codes associated with this time-off plan should be automatically published to the schedule restrictedActivityCodeIds: type: array description: The IDs of non time-off activity codes to check for conflicts in case the auto approval rule specifies checking activity codes. If these activity codes are present in schedule and overlap with the time-off request duration, the request will not be auto approved uniqueItems: true items: type: string overrideDates: type: array description: A list of override dates to check for conflicts with time-off request dates. If a conflict is found, the request will not be auto-approved items: $ref: '#/definitions/OverrideDate' hrisTimeOffType: description: Time-off type, if this time-off plan is associated with the integration $ref: '#/definitions/HrisTimeOffType' enabled: type: boolean description: Whether this time-off plan should be used by agents. Default is true countAgainstTimeOffLimits: type: boolean description: Whether this time-off plan should count against time-off limits. Default is false businessUnitAssociation: description: Business unit association, if the time-off plan belongs to a business unit. managementUnitAssociation must not be set if this is populated $ref: '#/definitions/CreateTimeOffPlanBusinessUnitAssociation' managementUnitAssociation: description: Management unit association, if the time-off plan belongs to a management unit. businessUnitAssociation must not be set if this is populated $ref: '#/definitions/CreateTimeOffPlanManagementUnitAssociation' CreateServiceGoalTemplate: type: object required: - name properties: name: type: string description: The name of the service goal template. serviceLevel: description: Service level targets for this service goal template $ref: '#/definitions/BuServiceLevel' averageSpeedOfAnswer: description: Average speed of answer targets for this service goal template $ref: '#/definitions/BuAverageSpeedOfAnswer' abandonRate: description: Abandon rate targets for this service goal template $ref: '#/definitions/BuAbandonRate' impactOverride: description: Settings controlling max percent increase and decrease of service goals for this service goal template $ref: '#/definitions/ServiceGoalTemplateImpactOverride' CreateActivityPlanRequest: type: object required: - activityCodeId - countsAsPaidTime - initialSchedulePeriod - lengthMinutes - name - optimizationObjective - state - transitionTimeMinutes - type properties: name: type: string description: The name of the activity plan managementUnitIds: type: array description: The management units to which this activity plan applies. Empty list or null means this activity plan applies to the entire business unit items: type: string description: type: string description: The description of the activity plan activityCodeId: type: string description: The activity code associated with the activity plan type: type: string description: The type of the activity plan enum: - Individual - Group lengthMinutes: type: integer format: int32 description: The length in minutes of the activity plan initialSchedulePeriod: description: The initial scheduling period for the activity plan $ref: '#/definitions/SchedulingPeriod' groupSettings: description: Group settings for the activity plan $ref: '#/definitions/GroupSettings' recurrenceSettings: description: Settings controlling recurrence for the activity plan. If not set the activity plan will only occur once $ref: '#/definitions/RecurrenceSettings' attendeesSearchRule: description: Attendee search rule for this activity plan $ref: '#/definitions/UserSearchRule' facilitated: type: boolean description: Whether the sessions created by this activity plan should be facilitated facilitatorsSearchRule: description: Facilitator search rule for this activity plan $ref: '#/definitions/UserSearchRule' transitionTimeMinutes: type: integer format: int32 description: Transition time in minutes between facilitated sessions serviceGoalImpactOverrides: description: Allowable service goal impact override settings for this activity plan. If not set the business unit setting will be used $ref: '#/definitions/ActivityPlanServiceGoalImpactOverrides' optimizationObjective: type: string description: The optimization objective of this activity plan enum: - FavorServiceGoals - FavorSchedulingAll state: type: string description: The state of this activity plan enum: - Active - Inactive countsAsPaidTime: type: boolean description: Whether the activity should count as paid time fixedAvailability: type: array description: Fixed availability configuration for the activity plan items: $ref: '#/definitions/FixedAvailability' startTimeIncrementMinutes: type: integer format: int32 description: The valid start times available when scheduling sessions AgentManagementUnitReference: type: object properties: user: description: The user (agent) for whom the management unit was requested $ref: '#/definitions/UserReference' managementUnit: description: The management to which the user (agent) belongs $ref: '#/definitions/ManagementUnitReference' businessUnit: description: The business unit to which the user (agent) belongs. Populate with expand=businessUnit $ref: '#/definitions/BusinessUnitReference' AgentEffectiveBid: type: object required: - downloadUrl - effectiveDate - id properties: id: type: string description: The ID of the schedule bid name: type: string effectiveDate: type: string format: date description: 'The effective date of the bid relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' endDate: type: string format: date description: 'The end date of the bid, relative to the business unit time zone in yyyy-MM-dd format. Null denotes an active schedule bid. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' downloadUrl: type: string description: The download URL to fetch the list of schedule sets and the agents assigned to them downloadTemplate: description: This field will always be null. Effective schedule sets are returned through the download URL. The schema is included here for documentation purposes $ref: '#/definitions/AgentAssignedScheduleSetList' selfUri: type: string format: uri description: The URI for this object readOnly: true AlternativeShiftTradeResponse: type: object required: - existingShifts - managementUnit - metadata - offeredShifts - schedule - shiftOfferJobId - state - user - violations properties: id: type: string description: The globally unique identifier for the object. readOnly: true shiftOfferJobId: type: string description: The job ID of the alternative shift offer listing, from which the trade was chosen existingShifts: type: array description: The existing shifts from the offer, may be empty items: $ref: '#/definitions/AlternativeShiftAgentScheduledShift' offeredShifts: type: array description: The offered shifts from the offer, may be empty items: $ref: '#/definitions/AlternativeShiftAgentScheduledShift' schedule: description: The existing schedule information associated with the trade $ref: '#/definitions/AlternativeShiftScheduleLookup' managementUnit: description: The management unit of this alternative shift trade request $ref: '#/definitions/ManagementUnitReference' user: description: The user who submitted the trade request $ref: '#/definitions/UserReference' weekDate: type: string format: date description: 'The start week date of the associated schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' expirationDate: type: string format: date-time description: The date when the trade will expire in ISO-8601 format. The trade cannot be approved after expiration state: type: string description: The state of this alternative shift trade enum: - Canceled - Denied - Expired - Submitted - Approved processingStatus: type: string description: The processing status of this alternative shift trade enum: - Error - WaitingForScheduleUpdate - ScheduleUpdating - ScheduleUpdated - WaitingForReview - Reviewing systemDateReviewed: type: string format: date-time description: The timestamp of when the trade request was reviewed by the system in ISO-8601 format adminDateReviewed: type: string format: date-time description: The timestamp of when the trade request was reviewed by an admin in ISO-8601 format adminReviewedBy: description: The admin who reviewed this alternative shift trade after system denial $ref: '#/definitions/UserReference' violations: type: array description: A list of trade match violations items: type: string enum: - ServiceGoalsNotMet metadata: description: Version metadata for this alternative shift trade $ref: '#/definitions/WfmVersionedEntityMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true BuForecastResultResponse: type: object properties: result: description: The result of the operation. Populated whenever the result is small enough to pass through the api directly $ref: '#/definitions/BuForecastResult' downloadUrl: type: string description: The download url to fetch the result. Only populated if the result is too large to pass through the api directly AgentOpportunityEnrollmentResult: type: object required: - metadata - status properties: id: type: string description: The globally unique identifier for the object. readOnly: true status: type: string description: The current status of the enrollment enum: - Pending - Approved - Denied - Withdrawn - Processing schedule: description: The schedule on which the enrollment was added when this enrollment was approved $ref: '#/definitions/BuScheduleReference' systemMessageCode: type: string description: The system-generated message code about enrollment processing results or failures enum: - ActivityChanged - AgentEnrollmentsHourlyLimitExceeded - BatchLimitExceeded - BusinessUnitEnrollmentsHourlyLimitExceeded - BusinessUnitNotFound - BusinessUnitOpportunityHourlyLimitExceeded - CapacityFull - Conflict - DateMustBeInFuture - DeadlineMustBeAfterOpenTime - DeadlineMustBeBeforeOrEqualToStartTime - EndTimeMustBeAfterStartTime - EnrollmentNotFound - InternalError - InternalErrorAutoApproval - InternalErrorDenial - InternalErrorScheduleUpdate - InvalidOpportunityLength - InvalidOpportunityStatus - InvalidRequest - InvalidStatusTransition - InvalidTime - NoInvitationsForPublish - OpenTimeMustBeBeforeStartTime - OpportunityClosed - OpportunityNotFound - OpportunityNotOpen - ScheduleConflict - ScheduleNotFound - ServiceUnavailable - StartTimeMustBeWithinOneYear - StatusNotDraft reviewNote: type: string description: Supervisor's note explaining the agent's enrollment status change denialCode: type: string description: The denial code enum: - ManuallyDenied - AutomaticallyClosed - ManuallyClosed - CapacityFull - ScheduleConflict metadata: description: The metadata for the enrollment $ref: '#/definitions/WfmVersionedEntityMetadata' ShiftTradeUpdateTradeJobResponse: type: object required: - id - status - type properties: id: type: string description: The globally unique identifier for the object. status: type: string description: The status of the job enum: - Processing - Complete - Canceled - Error type: type: string description: The type of the job enum: - AddTrade - BulkUpdateTradeStates - EvaluateTrades - MatchTrade - QueryAgentTrades - QueryTrades - QueryWeekSummaries - SearchUnmatchedTrades - UpdateTrade - UpdateTradeState downloadUrl: type: string description: The URL where completed results might be available for download in case the result body for that job type is too large error: description: Any error information, only set if the status == 'Error' $ref: '#/definitions/ErrorBody' updateTradeResult: description: Results for UpdateTrade job type $ref: '#/definitions/ShiftTradeResponseItem' selfUri: type: string format: uri description: The URI for this object readOnly: true CapacityPlanResponse: type: object required: - endBusinessUnitDate - fullTimeEquivalentWeeklyHours - id - metadata - startBusinessUnitDate properties: id: type: string description: The globally unique identifier for the object. name: type: string description: type: string description: Description of the capacity plan forecast: description: The selected forecast for this capacity plan. Null when main forecast is used in the future $ref: '#/definitions/BuShortTermForecastReference' startBusinessUnitDate: type: string format: date description: 'The start date for the capacity plan relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' endBusinessUnitDate: type: string format: date description: 'The end date for the capacity plan relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' fullTimeEquivalentWeeklyHours: type: number format: double description: The weekly hours used to calculate full time equivalent agents metadata: description: The metadata of this capacity plan $ref: '#/definitions/CapacityPlanMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true UpdateNotificationResponse: type: object properties: mutableGroupId: type: string description: The mutableGroupId of the notification id: type: string description: The id of the notification for mapping the potentially new mutableGroupId CapacityPlanReference: type: object required: - id 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 WfmHistoricalShrinkageResponse: type: object properties: operationId: type: string description: The operationId for which to listen downloadUrls: type: array description: The url list to GET the results of the Historical Shrinkage query. This field is populated only if query state is Complete items: type: string downloadResult: description: Result will always come via downloadUrls; however the schema is included for documentation $ref: '#/definitions/HistoricalShrinkageResultListing' state: type: string description: The state of the shrinkage query enum: - Processing - Complete - Error ActivityCode: type: object required: - id - metadata 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 name: type: string description: The name of the activity code. Default activity codes will be created with an empty name isActive: type: boolean description: Whether this activity code is active or has been deleted isDefault: type: boolean description: Whether this is a default activity code category: type: string description: The activity code's category. enum: - OnQueueWork - Break - Meal - Meeting - OffQueueWork - TimeOff - Training - Unavailable lengthInMinutes: type: integer format: int32 description: The default length of the activity in minutes countsAsPaidTime: type: boolean description: Whether an agent is paid while performing this activity countsAsWorkTime: type: boolean description: Indicates whether or not the activity should be counted as contiguous work time for calculating daily constraints agentTimeOffSelectable: type: boolean description: Whether an agent can select this activity code when creating or editing a time off request. Null if the activity's category is not time off. metadata: description: Version metadata for the associated management unit's list of activity codes $ref: '#/definitions/WfmVersionedEntityMetadata' AgentMuScheduleShift: type: object required: - activities - lengthMinutes - startOffsetMinutes properties: startOffsetMinutes: type: integer format: int32 description: The start offset of the shift, relative to referenceStartDate at the top level lengthMinutes: type: integer format: int32 description: The length of the shift in minutes activities: type: array description: The activities associated with this shift items: $ref: '#/definitions/AgentScheduleShiftActivity' EstimateAvailableFullDayTimeOffResponse: type: object required: - date - durationMinutes - flexible - payableMinutes properties: date: type: string format: date description: 'Date in yyyy-MM-dd format for full day request. Should be interpreted in the business unit''s configured time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' durationMinutes: type: integer format: int32 description: An estimation of time off request length in minutes payableMinutes: type: integer format: int32 description: An estimation of payable part of time off request in minutes flexible: type: boolean description: Whether there is flexibility for a user to choose different hours than the system estimated overrideDateType: type: string description: The override date type, if the requested day is an override date enum: - Blocked - ManualReview earliestStartOffsetMinutes: type: integer format: int32 description: Earliest start time in minutes from midnight for full day request. Value may be null when time-off estimation is disabled latestEndOffsetMinutes: type: integer format: int32 description: Latest end time in minutes from midnight for full day request. Value may be null when time-off estimation is disabled MatchShiftTradeRequest: type: object required: - metadata - receivingScheduleId properties: receivingScheduleId: type: string description: The ID of the schedule with which the shift trade is associated receivingShiftId: type: string description: The ID of the shift the receiving user is giving up in trade, if applicable metadata: description: Version metadata for the shift trade $ref: '#/definitions/WfmVersionedEntityMetadata' TimeOffLimitValueRange: type: object required: - granularity - startDate properties: timeOffLimit: description: The ID of the time off limit $ref: '#/definitions/TimeOffLimitReference' startDate: type: string format: date description: Start date of the requested date range, in ISO-8601 format. The end date is determined by the size of interval lists granularity: type: string description: Granularity choice for time off limit enum: - Daily - FifteenMinutes limitMinutesPerInterval: type: array description: A list of time off limit values in minutes per granularity interval items: type: integer format: int32 allocatedMinutesPerInterval: type: array description: A list of allocated time off minutes per granularity interval items: type: integer format: int32 waitlistedMinutesPerInterval: type: array description: A list of waitlisted time off minutes per granularity interval items: type: integer format: int32 waitlistedRequestsPerInterval: type: array description: The current number of waitlisted time off requests for every interval per granularity items: type: integer format: int32 metadata: description: Version metadata for the time off limit $ref: '#/definitions/WfmVersionedEntityMetadata' SecondaryPresenceLookupItem: type: object properties: lookupId: type: string description: The lookupId of secondary presence id secondaryPresence: description: The secondary presence Id $ref: '#/definitions/SecondaryPresence' AdherenceExplanationJobReference: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true type: type: string description: The type of the adherence explanation job enum: - AddExplanation - UpdateExplanation - QueryAgentExplanations - QueryBuExplanations status: type: string description: The status of the adherence explanation job enum: - Processing - Complete - Error selfUri: type: string format: uri description: The URI for this object readOnly: true TimeOffBalanceJobReference: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true status: type: string description: The status of the job enum: - Processing - Complete - Error selfUri: type: string format: uri description: The URI for this object readOnly: true ShiftTradeUpdateTradeStateJobResponse: type: object required: - id - status - type properties: id: type: string description: The globally unique identifier for the object. status: type: string description: The status of the job enum: - Processing - Complete - Canceled - Error type: type: string description: The type of the job enum: - AddTrade - BulkUpdateTradeStates - EvaluateTrades - MatchTrade - QueryAgentTrades - QueryTrades - QueryWeekSummaries - SearchUnmatchedTrades - UpdateTrade - UpdateTradeState downloadUrl: type: string description: The URL where completed results might be available for download in case the result body for that job type is too large error: description: Any error information, only set if the status == 'Error' $ref: '#/definitions/ErrorBody' updateTradeStateResult: description: Results for UpdateTradeState job type $ref: '#/definitions/BulkUpdateShiftTradeStateResultItem' selfUri: type: string format: uri description: The URI for this object readOnly: true QueryAgentsIntegrationsRequest: type: object required: - agentIds properties: agentIds: type: array description: The IDs of the agents to query associated integrations uniqueItems: true items: type: string description: Query integrations for agents request BuForecastModificationResponse: type: object required: - displayGranularity - enabled - granularity - metric - planningGroupIds - type - values properties: type: type: string description: The type of the modification enum: - MinimumPerInterval - MaximumPerInterval - SetValuePerInterval - ChangeValuePerInterval - ChangePercentPerInterval - SetValueOverRange - ChangeValueOverRange - SetValuesForIntervalSet - SetMultiGranularityValuesForIntervalSet startIntervalIndex: type: integer format: int32 description: The number of intervals past referenceStartDate representing the first interval to which this modification applies endIntervalIndex: type: integer format: int32 description: The number of intervals past referenceStartDate representing the last interval to which this modification applies metric: type: string description: The metric to which this modification applies enum: - Offered - AverageHandleTimeSeconds legacyMetric: type: string description: The legacy metric to which this modification applies if applicable enum: - AverageAfterCallWorkTimeSeconds - AverageHandleTimeSeconds - AverageTalkTimeSeconds - Offered value: type: number format: double description: The value of the modification values: type: array description: The list of modification values. Only applicable for grid-type modifications items: $ref: '#/definitions/WfmForecastModificationIntervalOffsetValue' secondaryValues: type: array description: The list of modification secondary values. Only applicable for multi granularity modifications items: $ref: '#/definitions/WfmForecastModificationIntervalOffsetValue' displayGranularity: type: string description: 'The client side display granularity of the modification, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H' granularity: type: string description: 'The actual granularity of the modification as stored behind the scenes, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H' secondaryGranularity: type: string description: 'The granularity of the ''secondaryValues'' modification as stored behind the scenes, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H' enabled: type: boolean description: Whether the modification is enabled for the forecast planningGroupIds: type: array description: The IDs of the planning groups to which this forecast modification applies uniqueItems: true items: type: string SchedulingNoForecastOptionsRequest: type: object properties: shiftLength: type: string description: The shift length option to apply if no forecast is supplied enum: - Shortest - Median - Longest - Random shiftStart: type: string description: The shift start option to apply if no forecast is supplied enum: - Earliest - Median - Latest - Random AgentBulkAddOpportunityEnrollmentsRequest: type: object required: - enrollments properties: enrollments: type: array description: The list of the enrollments to add items: $ref: '#/definitions/AgentAddOpportunityEnrollment' OpportunityEnrollment: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true LongTermForecastResultResponse: type: object properties: result: description: The result of the operation. Populated whenever the result is small enough to pass through the api directly $ref: '#/definitions/LongTermForecastResult' downloadUrl: type: string description: The download url to fetch the result. Only populated if the result is too large to pass through the api directly LongTermRequirementsErrorDetail: type: object required: - description - internalErrorCode properties: internalErrorCode: type: string description: The error code enum: - TimedOut - NoData - ClientDataInvalid - ConfigurationInvalid - RequirementsFailed description: type: string description: The description of the error code CreateActivityCodeRequest: type: object required: - category - name properties: name: type: string description: The name of the activity code category: type: string description: The activity code's category enum: - OnQueueWork - Break - Meal - Meeting - OffQueueWork - TimeOff - Training - Unavailable lengthInMinutes: type: integer format: int32 description: The default length of the activity in minutes countsAsPaidTime: type: boolean description: Whether an agent is paid while performing this activity countsAsWorkTime: type: boolean description: Indicates whether or not the activity should be counted as work time agentTimeOffSelectable: type: boolean description: Whether an agent can select this activity code when creating or editing a time off request countsTowardShrinkage: type: boolean description: Whether or not this activity code counts toward shrinkage calculations plannedShrinkage: type: boolean description: Whether this activity code is considered planned or unplanned shrinkage interruptible: type: boolean description: Whether this activity code is considered interruptible secondaryPresences: type: array description: The secondary presences of this activity code items: $ref: '#/definitions/SecondaryPresence' planningGroupIds: type: array description: The planning group IDs associated with this activity code items: type: string ShiftSet: type: object required: - effectiveWorkPlan - id - name - shifts - suggestedAgentCount properties: id: type: string description: The ID of the shift set name: type: string description: The name given for the shift set effectiveWorkPlan: description: The work plan or work plan rotation used for generating the shift set $ref: '#/definitions/ShiftSetEffectiveWorkPlan' shifts: type: array description: The scheduled shifts items: $ref: '#/definitions/ScheduleBidScheduledShift' suggestedAgentCount: type: integer format: int32 description: The suggested agent count overrideAgentCount: type: integer format: int32 description: The override agent count. If it is null, it falls back to using the suggestedAgentCount ValueWrapperHrisTimeOffType: type: object properties: value: description: The value for the associated field $ref: '#/definitions/HrisTimeOffType' WorkPlanBidGroupUpdate: type: object properties: name: type: string description: The name of the work plan bid group managementUnitId: type: string description: The management unit ID used for this work plan bid group agentIds: description: Agent IDs who participate in this bid group $ref: '#/definitions/ListWrapperString' workPlans: description: The list of work plans used in this bid group $ref: '#/definitions/ListWrapperBidGroupWorkPlanRequest' planningGroupIds: description: The planning group IDs selected in this bid group $ref: '#/definitions/ListWrapperString' CapacityPlanStaffingGroupAllocationsResponse: type: object required: - capacityPlan - downloadUrl - fullTimeEquivalentWeeklyHours properties: capacityPlan: description: The capacity plan to which the staffing groups belong $ref: '#/definitions/CapacityPlanReference' fullTimeEquivalentWeeklyHours: type: number format: double description: The weekly hours used to calculate full time equivalent agents downloadUrl: type: string description: The URL to download the staffing group allocations downloadTemplate: description: Staffing groups allocation results always come through downloadUrl, the schema included here is just for documentation $ref: '#/definitions/StaffingGroupAllocationsResponseTemplate' HistoricalShrinkageActivityCodeResponse: type: object properties: activityCodeId: type: string description: The ID of the activity code for which shrinkage data is provided shrinkageForActivityCode: description: Aggregated shrinkage data for the activity code $ref: '#/definitions/HistoricalShrinkageAggregateResponse' ActivityPlanAbandonRateImpactOverride: type: object required: - increaseByPercent properties: increaseByPercent: type: number format: double description: Allowed abandon rate increase percent, from 0.0 to 100.0 RoutePathRequest: type: object required: - mediaType - queueId properties: queueId: type: string example: f27450c9-c1a0-451a-804c-2579b268b273 description: The ID of the queue to associate with the route path mediaType: type: string example: Email description: The media type of the given queue to associate with the route path enum: - Voice - Chat - Email - Callback - Message - Workitem languageId: type: string example: e3d65f6a-c0d2-41da-8152-82d3f075d77c description: The ID of the language to associate with the route path skillIds: type: array example: '["33d29376-4267-4968-8042-dcabdf2c1d98"]' description: The set of skill IDs to associate with the route path uniqueItems: true items: type: string sourcePlanningGroup: description: The planning group from which to take route paths. This property is only needed if a route path already exists in another planning group.Note that taking a route path from another planning group will modify the other planning group $ref: '#/definitions/SourcePlanningGroupRequest' WorkPlanBidRanks: type: object properties: id: type: string description: The globally unique identifier for the user. workPlanBiddingPerformance: type: integer format: int32 description: Work plan bidding agent performance ranking. The range of values is between 0 and 9999. biddingTieBreaker: type: string description: Custom agent ranking metric that some customers can use. selfUri: type: string format: uri description: The URI for this object readOnly: true TimeOffBalanceRequest: type: object required: - activityCodeIds properties: activityCodeIds: type: array description: The set of activity code IDs for which to query available time off balances uniqueItems: true items: type: string dateRanges: type: array description: The list of date ranges for which to query time off balance items: $ref: '#/definitions/LocalDateRange' AgentBulkStatusUpdateOpportunityEnrollmentsResponse: type: object required: - errorCount - results properties: results: type: array description: The result for each requested item items: $ref: '#/definitions/BulkOpportunitiesEnrollmentResult' errorCount: type: integer format: int32 description: The count of failed operations in the bulk request UnavailableTimesViolationMessageArgument: type: object required: - type - value properties: type: type: string description: Argument type enum: - PlanningPeriodType - Minutes - Date - SecondDate - SecondCount - Count value: type: string description: Value of argument TimeOffRequestList: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string timeOffRequests: type: array items: $ref: '#/definitions/TimeOffRequestResponse' selfUri: type: string format: uri description: The URI for this object readOnly: true CapacityPlanStaffingRequirementResult: type: object required: - businessUnit - capacityPlan - granularity - referenceBusinessUnitDate - status properties: businessUnit: description: The business unit to which the capacity plan belongs $ref: '#/definitions/BusinessUnitReference' capacityPlan: description: The capacity plan for which requirements are generated $ref: '#/definitions/CapacityPlanReference' status: type: string description: The status of the requirement generation of the capacity plan enum: - Processing - Complete - Canceled - Error referenceBusinessUnitDate: type: string format: date description: 'The reference date for interval-based data relative to the business unit time zone for the requirements. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' granularity: type: string description: Granularity of the intervals enum: - Weekly - Monthly errorCode: type: string description: The error code when status is 'Failed' enum: - TimedOut - NoData - ClientDataInvalid - ConfigurationInvalid - RequirementsFailed downloadUrl: type: string description: The URL to get the requirements results for the capacity plan. It will be populated if the status is 'Complete' downloadTemplate: description: Staffing requirement results always come through downloadUrl, the schema included here is just for documentation $ref: '#/definitions/StaffingRequirementResultResponseTemplate' DateRange: type: object properties: startDate: type: string description: The inclusive start of a date range in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. endDate: type: string description: The inclusive end of a date range in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. AgentsEffectiveScheduleSetResponse: type: object required: - effectiveBids properties: effectiveBids: type: array description: Bids that are effective from the startDate until the weekCount items: $ref: '#/definitions/AgentEffectiveBid' BuHeadcountForecastResponse: type: object properties: result: description: The headcount forecast, null when downloadUrl is provided $ref: '#/definitions/BuHeadcountForecastBuPlanningGroupHeadcountForecastResult' downloadUrl: type: string description: Download URL. Null unless the response is too large to pass directly through the api ValueWrapperInstant: type: object properties: value: type: string format: date-time description: 'The value for the associated field. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' BuRescheduleRequest: type: object required: - doNotChangeDailyPaidTime - doNotChangeManuallyEditedShifts - doNotChangeShiftStartTimes - doNotChangeWeeklyPaidTime - managementUnitIds properties: startDate: type: string format: date-time description: 'The start of the range to reschedule. Defaults to the beginning of the schedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endDate: type: string format: date-time description: 'The end of the range to reschedule. Defaults the the end of the schedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' agentIds: type: array description: The IDs of the agents to consider for rescheduling. Omit to consider all agents in the specified management units.Agents not in the specified management units will be ignored items: type: string activityCodeIds: type: array description: The IDs of the activity codes to consider for rescheduling. Omit to consider all activity codes items: type: string managementUnitIds: type: array description: The IDs of the management units to reschedule items: type: string doNotChangeWeeklyPaidTime: type: boolean description: Instructs the scheduler whether it is allowed to change weekly paid time doNotChangeDailyPaidTime: type: boolean description: Instructs the scheduler whether it is allowed to change daily paid time doNotChangeShiftStartTimes: type: boolean description: Instructs the scheduler whether it is allowed to change shift start times doNotChangeManuallyEditedShifts: type: boolean description: Instructs the scheduler whether it is allowed to change manually edited shifts activitySmoothingType: type: string description: Overrides the default BU level activity smoothing type for this reschedule run enum: - ReduceConcurrentActivitiesAcrossBu - ReduceConcurrentActivitiesAcrossMu - ConsistentServiceLevel induceScheduleVariability: type: boolean description: Overrides the default BU level induce schedule variability setting for this reschedule run useUnavailableTimesSnapshot: type: boolean description: Whether to use original unavailable times from schedule generation or latest saved unavailable times for this reschedule run AgentWorkPlanBids: type: object required: - agentWorkPlanBids properties: id: type: string description: The globally unique identifier for the object. readOnly: true businessUnit: description: The business unit to which the bids belong $ref: '#/definitions/BusinessUnitReference' agentWorkPlanBids: type: array description: Work plan bid summaries associated with this agent items: $ref: '#/definitions/AgentWorkPlanBid' selfUri: type: string format: uri description: The URI for this object readOnly: true UpdateScheduleUploadResponse: type: object properties: uploadKey: type: string description: The key to pass to the secondary request to start processing of the upload url: type: string description: The url to which to PUT the upload body headers: type: object description: Required headers for the PUT request to the url additionalProperties: type: string uploadBodySchema: description: Always null. Defines the schema of the json body to be PUT to the url. The json body should be gzip encoded before uploading $ref: '#/definitions/UpdateScheduleUploadSchema' HistoricalImportDeleteFilesJobResponse: type: object properties: id: type: string description: The Job Id Request readOnly: true state: type: string description: Property denoting the state of the remove request enum: - Processing - Complete - Error entities: type: array description: The request entities that got deleted items: $ref: '#/definitions/HistoricalDataDeleteEntity' disallowedEntities: type: array description: The request entities that were disallowed to be deleted items: $ref: '#/definitions/HistoricalDataDisallowedDeleteEntity' selfUri: type: string format: uri description: The URI for this object readOnly: true TimeOffRequestResponse: type: object required: - id properties: id: type: string description: The globally unique identifier for the object. user: description: The user associated with this time off request $ref: '#/definitions/UserReference' isFullDayRequest: type: boolean description: Whether this is a full day request (false means partial day) markedAsRead: type: boolean description: Whether this request has been marked as read by the agent activityCodeId: type: string description: The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category paid: type: boolean description: Whether this is a paid time off request status: type: string description: The status of this time off request enum: - PENDING - APPROVED - DENIED - CANCELED substatus: type: string description: The substatus of this time off request enum: - AdvanceTimeElapsed - AutoApproved - BlockedDate - InsufficientBalance - InvalidDailyDuration - ManualApproval - OutsideShift - OverlapsRestrictedActivityCode - RemovedFromWaitlist - ReviewDate - Waitlisted partialDayStartDateTimes: type: array description: A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false items: type: string format: date-time fullDayManagementUnitDates: type: array description: A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true items: type: string dailyDurationMinutes: type: integer format: int32 description: The daily duration of this time off request in minutes durationMinutes: type: array description: Daily durations for each day of this time off request in minutes items: type: integer format: int32 payableMinutes: type: array description: Payable minutes for each day of this time off request items: type: integer format: int32 fullDayEarliestStartOffsetMinutes: type: array description: Earliest start offset in minutes for each full-day request date. Values may be null when time-off estimation is disabled or no estimate is available items: type: integer format: int32 fullDayLatestEndOffsetMinutes: type: array description: Latest end offset in minutes for each full-day request date. Values may be null when time-off estimation is disabled or no estimate is available items: type: integer format: int32 notes: type: string description: Notes about the time off request submittedBy: description: The user who submitted this time off request. The id may be 'System' if it was an automated process $ref: '#/definitions/UserReference' submittedDate: type: string format: date-time description: 'The timestamp when this request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' reviewedBy: description: The user who reviewed this time off request. The id may be 'System' if it was an automated process $ref: '#/definitions/UserReference' reviewedDate: type: string format: date-time description: 'The timestamp when this request was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' modifiedBy: description: The user who last modified this TimeOffRequestResponse $ref: '#/definitions/UserReference' modifiedDate: type: string format: date-time description: 'The timestamp when this request was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' syncVersion: type: integer format: int32 description: The sync version of this time off request for which the scheduled activity is associated metadata: description: The version metadata of the time off request $ref: '#/definitions/WfmVersionedEntityMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true ActivityPlanOccurrenceSessionsUsersStructureReference: type: object required: - id - sessions properties: id: type: string description: The globally unique identifier for the object. sessions: type: array description: The sessions to delete from this activity plan occurrence items: $ref: '#/definitions/ActivityPlanSessionStructureReference' selfUri: type: string format: uri description: The URI for this object readOnly: true StaffingGroupAllocationsResponseTemplate: type: object required: - staffingGroupAllocations properties: staffingGroupAllocations: type: array description: List of staffing group allocations items: $ref: '#/definitions/StaffingGroupAllocation' months: type: array description: The list of months covered by this capacity plan, formatted as yyyy-MM items: type: string format: year-month description: 'Year and month are represented as an ISO-8601 string. For example: yyyy-MM' planningGroupAllocations: type: array description: The planning group allocations items: $ref: '#/definitions/CapacityPlanningPlanningGroupAllocation' capacityPlanMetricsSummary: description: The total summary of staffing allocation metrics for this capacity plan, for the selected granularity $ref: '#/definitions/CapacityPlanMetricsSummary' ListWrapperPlanningGroupMinimumsRequest: type: object properties: values: type: array items: $ref: '#/definitions/PlanningGroupMinimumsRequest' AgentPossibleWorkShiftsRequest: type: object required: - weekCount - weekStartDate properties: weekStartDate: type: string format: date description: 'Start date of requested effective work plan, day of week will be in line with business unit start day of week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' weekCount: type: integer format: int32 description: Number of weeks for which to return possible work shifts WorkPlanRotationListResponse: type: object properties: entities: type: array items: $ref: '#/definitions/WorkPlanRotationResponse' UserScheduleShift: type: object properties: weekSchedule: description: The schedule to which this shift belongs readOnly: true $ref: '#/definitions/WeekScheduleReference' id: type: string description: ID of the schedule shift. This is only for the case of updating and deleting an existing shift startDate: type: string format: date-time description: 'Start time in UTC for this shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true lengthInMinutes: type: integer format: int32 description: Length of this shift in minutes readOnly: true activities: type: array description: List of activities in this shift items: $ref: '#/definitions/UserScheduleActivity' delete: type: boolean description: If marked true for updating this schedule shift, it will be deleted manuallyEdited: type: boolean description: Whether the shift was set as manually edited AgentIntegrationAssociationResponse: type: object required: - agentExternalId - integration - locked properties: agentExternalId: type: string description: ID of the agent in external system integration: description: The integration associated with the agent $ref: '#/definitions/WfmIntegrationReference' locked: type: boolean description: Whether agentExternalId should be protected from update by automatic processes UpdateUnavailableTime: type: object properties: id: type: string description: The ID of the unavailable time span. Should be specified to update or delete an existing unavailable time span or set to null when creating a new one timeSpan: description: Exact date, time and length of the unavailability time in granularity of minutes. Must be specified when creating a new unavailable time span $ref: '#/definitions/WfmTimeSpan' notes: type: string description: Comments explaining the unavailability time span delete: type: boolean description: Whether the unavailable time should be deleted TimeOffBalancesResponse: type: object properties: job: description: The asynchronous job handling the query $ref: '#/definitions/TimeOffBalanceJobReference' entities: type: array description: The list of time off balances. May come via notification items: $ref: '#/definitions/TimeOffBalanceResponse' HistoricalImportOverallDeleteStatusResponse: type: object properties: entities: type: array description: List of all the delete jobs items: $ref: '#/definitions/HistoricalDataJobEntityStatus' status: type: string description: Property denoting overall status of the service. readOnly: true enum: - Processing - Complete ShrinkageOverrides: type: object properties: clear: type: boolean description: Set true to clear the shrinkage interval overrides values: type: array description: List of interval shrinkage overrides items: $ref: '#/definitions/ShrinkageOverride' PatchBuReschedulingOptionsRequest: type: object properties: managementUnits: type: array description: Per-management unit rescheduling options to update items: $ref: '#/definitions/PatchBuReschedulingOptionsManagementUnitRequest' AgentAdherenceDayMetrics: type: object required: - actualLengthSeconds - adherenceScheduleSeconds - dayStartOffsetSeconds - exceptionCount - exceptionDurationSeconds - impactSeconds - scheduleLengthSeconds properties: dayStartOffsetSeconds: type: integer format: int32 description: Start of day offset in seconds relative to query start time adherenceScheduleSeconds: type: integer format: int32 description: Duration of schedule in seconds included for adherence percentage calculation conformanceScheduleSeconds: type: integer format: int32 description: Total scheduled duration in seconds for OnQueue activities conformanceActualSeconds: type: integer format: int32 description: Total actually worked duration in seconds for OnQueue activities exceptionCount: type: integer format: int32 description: Total number of adherence exceptions for this user exceptionDurationSeconds: type: integer format: int32 description: Total duration in seconds of adherence exceptions for this user impactSeconds: type: integer format: int32 description: The impact duration in seconds of current adherence state for this user scheduleLengthSeconds: type: integer format: int32 description: Total duration in seconds for all scheduled activities actualLengthSeconds: type: integer format: int32 description: Total duration in seconds for all actually worked activities adherencePercentage: type: number format: double description: Total adherence percentage for this user, in the scale of 0 - 100 conformancePercentage: type: number format: double description: Total conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period. RecurrenceSettingsBase: type: object required: - endAfter properties: endAfter: description: Settings controlling when to end the recurrence for the activity plan $ref: '#/definitions/RecurrenceEndSettings' PossibleWorkShiftsForWeek: type: object properties: id: type: integer format: int32 description: ID of this possible weekly shift dailyPossibleShifts: type: array description: Daily shifts in this possible weekly shift items: $ref: '#/definitions/DailyPossibleShift' WorkPlanRotationResponse: type: object required: - id properties: id: type: string description: The globally unique identifier for the object. name: type: string enabled: type: boolean description: Whether the work plan rotation is enabled for scheduling dateRange: description: The date range to which this work plan rotation applies $ref: '#/definitions/DateRangeWithOptionalEnd' pattern: description: Pattern with ordered list of work plans that rotate on a weekly basis $ref: '#/definitions/WorkPlanPatternResponse' agentCount: type: integer format: int32 description: Number of agents in this work plan rotation agents: type: array description: Agents in this work plan rotation. Populate with expand=agents for GET WorkPlanRotationsList (defaults to empty list) items: $ref: '#/definitions/WorkPlanRotationAgentResponse' metadata: description: Version metadata for this work plan rotation $ref: '#/definitions/WfmVersionedEntityMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true ShiftTradeAddTradeJobResponse: type: object required: - id - status - type properties: id: type: string description: The globally unique identifier for the object. status: type: string description: The status of the job enum: - Processing - Complete - Canceled - Error type: type: string description: The type of the job enum: - AddTrade - BulkUpdateTradeStates - EvaluateTrades - MatchTrade - QueryAgentTrades - QueryTrades - QueryWeekSummaries - SearchUnmatchedTrades - UpdateTrade - UpdateTradeState downloadUrl: type: string description: The URL where completed results might be available for download in case the result body for that job type is too large error: description: Any error information, only set if the status == 'Error' $ref: '#/definitions/ErrorBody' addTradeResult: description: Results for AddTrade job type $ref: '#/definitions/ShiftTradeResponseItem' selfUri: type: string format: uri description: The URI for this object readOnly: true BusinessUnitListing: type: object properties: entities: type: array items: $ref: '#/definitions/BusinessUnitListItem' AddWorkPlanRotationRequest: type: object required: - dateRange - name - pattern properties: name: type: string description: Name of this work plan rotation dateRange: description: The date range to which this work plan rotation applies $ref: '#/definitions/DateRangeWithOptionalEnd' agents: type: array description: Agents in this work plan rotation items: $ref: '#/definitions/AddWorkPlanRotationAgentRequest' pattern: description: Pattern with list of work plan IDs that rotate on a weekly basis $ref: '#/definitions/WorkPlanPatternRequest' ListWrapperBidGroupWorkPlanRequest: type: object properties: values: type: array items: $ref: '#/definitions/BidGroupWorkPlanRequest' EntityListing: type: object properties: entities: type: array items: type: object ShiftTradeMatchReviewResponse: type: object properties: initiatingUser: description: Details for the initiatingUser side of the shift trade $ref: '#/definitions/ShiftTradeMatchReviewUserResponse' receivingUser: description: Details for the receivingUser side of the shift trade $ref: '#/definitions/ShiftTradeMatchReviewUserResponse' violations: type: array description: Constraint violations introduced after being matched that would normally disallow a trade, but which can still be overridden by the shift trade administrator items: $ref: '#/definitions/ShiftTradeMatchViolation' adminReviewViolations: type: array description: Constraint violations associated with this shift trade which require shift trade administrator review items: $ref: '#/definitions/ShiftTradeMatchViolation' unevaluatedRules: type: array description: Unevaluated rules for this shift trade which require shift trade administrator review uniqueItems: true items: type: string enum: - PlanningPeriodMinPaidTime - PlanningPeriodMaxPaidTime - MinimumTimeBetweenShifts AlternativeShiftAgentScheduledShift: type: object required: - activities - dayIndex - lengthMinutes - referenceKey - startDate properties: dayIndex: type: integer format: int32 description: The number of days since start of schedule referenceKey: type: string description: A key generated for an offer to help facilitate alternative shift trading startDate: type: string format: date-time description: The start date of this shift in ISO-8601 format lengthMinutes: type: integer format: int32 description: The length of this shift in minutes activities: type: array description: A list of activities in this shift items: $ref: '#/definitions/BuAgentScheduleActivity' ActivityPlanJobListing: type: object properties: entities: type: array items: $ref: '#/definitions/ActivityPlanJobResponse' WorkPlanRotationAgentResponse: type: object properties: user: description: The user associated with this work plan rotation $ref: '#/definitions/UserReference' dateRange: description: The date range to which this agent is effective in the work plan rotation $ref: '#/definitions/DateRangeWithOptionalEnd' position: type: integer format: int32 description: Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0 AsyncIntradayResponse: type: object properties: status: type: string description: The status of the operation enum: - Processing - Complete - Canceled - Error operationId: type: string description: The ID for the operation result: description: The result of the operation. Null unless status == Complete $ref: '#/definitions/BuIntradayResponse' BulkShiftTradeStateUpdateRequest: type: object required: - entities properties: entities: type: array description: The shift trades to update items: $ref: '#/definitions/BulkUpdateShiftTradeStateRequestItem' TimeOffLimit: type: object required: - id properties: id: type: string description: The globally unique identifier for the object. granularity: type: string description: Granularity choice for the time off limit enum: - Daily - FifteenMinutes defaultLimitMinutes: type: integer format: int32 description: The default time off limit value in minutes per granularity interval metadata: description: Version metadata for the time off limit $ref: '#/definitions/WfmVersionedEntityMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true UpdateStaffingGroupRequest: type: object required: - metadata properties: name: type: string description: The name of the staffing group userIds: description: The set of user Ids to associate with the staffing group $ref: '#/definitions/SetWrapperString' planningGroupIds: description: The set of planning group Ids to associate with the staffing group $ref: '#/definitions/SetWrapperString' metadata: description: Version metadata for the staffing group $ref: '#/definitions/WfmVersionedEntityMetadata' CreateWorkPlanShift: type: object required: - name properties: name: type: string description: Name of the shift days: description: Days of the week applicable for this shift $ref: '#/definitions/SetWrapperDayOfWeek' flexibleStartTime: type: boolean description: Whether the start time of the shift is flexible exactStartTimeMinutesFromMidnight: type: integer format: int32 description: Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false earliestStartTimeMinutesFromMidnight: type: integer format: int32 description: Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true latestStartTimeMinutesFromMidnight: type: integer format: int32 description: Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true constrainStopTime: type: boolean description: Whether the latest stop time constraint for the shift is enabled. Deprecated, use constrainLatestStopTime instead constrainLatestStopTime: type: boolean description: Whether the latest stop time constraint for the shift is enabled latestStopTimeMinutesFromMidnight: type: integer format: int32 description: Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true constrainEarliestStopTime: type: boolean description: Whether the earliest stop time constraint for the shift is enabled earliestStopTimeMinutesFromMidnight: type: integer format: int32 description: This is the earliest time a shift can end startIncrementMinutes: type: integer format: int32 description: Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true flexiblePaidTime: type: boolean description: Whether the paid time setting for the shift is flexible exactPaidTimeMinutes: type: integer format: int32 description: Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false minimumPaidTimeMinutes: type: integer format: int32 description: Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true maximumPaidTimeMinutes: type: integer format: int32 description: Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true constrainContiguousWorkTime: type: boolean description: Whether the contiguous time constraint for the shift is enabled minimumContiguousWorkTimeMinutes: type: integer format: int32 description: Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true maximumContiguousWorkTimeMinutes: type: integer format: int32 description: Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true constrainDayOff: type: boolean description: Whether day off rule is enabled dayOffRule: type: string description: The day off rule for agents to have next day off or previous day off. used if constrainDayOff = true enum: - NextDayOff - PreviousDayOff planningPeriodConstraints: description: Planning period constraints $ref: '#/definitions/PlanningPeriodShiftConstraints' activities: type: array description: Activities configured for this shift items: $ref: '#/definitions/CreateWorkPlanActivity' ScheduleBidReference: type: object required: - id properties: id: type: string description: The ID of the schedule bid name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true ForecastSourceDayPointer: type: object properties: dayOfWeek: type: string description: The forecast day of week for this source data enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - EighthDay weight: type: integer format: int32 description: The relative weight to apply to this source data item for weighted averages date: type: string description: The date this source data represents, in yyyy-MM-dd format fileName: type: string description: The name of the source file this data came from if it originated from a data import dataKey: type: string description: The key to look up the forecast source data for this source day CapacityPlansListResponse: type: object properties: entities: type: array items: $ref: '#/definitions/CapacityPlanListItem' AgentScheduleBids: type: object required: - agentScheduleBids - businessUnit properties: id: type: string description: The globally unique identifier for the object. readOnly: true businessUnit: description: The business unit to which the bids belong $ref: '#/definitions/BusinessUnitReference' agentScheduleBids: type: array description: Schedule bid summaries associated with this agent items: $ref: '#/definitions/AgentScheduleBid' selfUri: type: string format: uri description: The URI for this object readOnly: true UpdateActivityPlanRequest: type: object properties: name: type: string description: The name of the activity plan description: type: string description: The description of the activity plan groupSettings: description: Group settings for the activity plan $ref: '#/definitions/ValueWrapperGroupSettings' attendeesSearchRule: description: Attendee search rule for this activity plan $ref: '#/definitions/ValueWrapperUserSearchRule' facilitatorsSearchRule: description: Facilitator search rule for this activity plan $ref: '#/definitions/ValueWrapperUserSearchRule' transitionTimeMinutes: type: integer format: int32 description: Transition time in minutes between facilitated sessions serviceGoalImpactOverrides: description: Allowable service goal impact override settings for this activity plan $ref: '#/definitions/ValueWrapperActivityPlanServiceGoalImpactOverrides' optimizationObjective: type: string description: The optimization objective of this activity plan enum: - FavorServiceGoals - FavorSchedulingAll state: type: string description: The state of this activity plan enum: - Active - Inactive fixedAvailability: description: Fixed availability configuration for the activity plan $ref: '#/definitions/ListWrapperFixedAvailability' activityCodeId: type: string description: The activity code associated with the activity plan type: type: string description: The type of the activity plan enum: - Individual - Group lengthMinutes: type: integer format: int32 description: The length in minutes of the activity plan countsAsPaidTime: type: boolean description: Whether the activity should count as paid time recurrenceSettings: description: Settings controlling recurrence for the activity plan. If not set the activity plan will only occur once $ref: '#/definitions/RecurrenceSettingsBase' ShortTermForecastReference: type: object required: - id - weekDate 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 weekDate: type: string description: The weekDate of the short term forecast in yyyy-MM-dd format description: type: string description: The description of the short term forecast StaffingGroupFullTimeEquivalentContribution: type: object required: - plannedFullTimeEquivalentContribution - staffingGroupId properties: staffingGroupId: type: string description: The staffing group ID receiving full time equivalent agents from the planning group plannedFullTimeEquivalentContribution: type: array description: The weekly planned full time contribution from the planning group to this staffing group items: type: number format: double WeekShiftTradeMatchesSummaryResponse: type: object properties: weekDate: type: string format: date description: 'The schedule week date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' count: type: integer format: int32 description: The number of trades in the 'Matched' state with the initiating shift in the given week crossWeekReceivingCount: type: integer format: int32 description: The number of cross-week trades in the 'Matched' state with the receiving shift for the given week BuUpdateTimeOffPlanRequest: type: object required: - metadata properties: name: type: string description: The name of this time-off plan activityCodeIds: description: The IDs of activity codes to associate with this time-off plan $ref: '#/definitions/SetWrapperString' autoApprovalRule: type: string description: Auto approval rule for this time-off plan enum: - Never - Always - CheckLimits - CheckActivityCodes - CheckLimitsAndActivityCodes daysBeforeStartToExpireFromWaitlist: type: integer format: int32 description: The number of days before the time-off request start date for when the request will be expired from the waitlist autoPublishApprovedTimeOffRequests: type: boolean description: Whether newly approved time-off requests with activity codes associated with this time-off plan should be automatically published to the schedule restrictedActivityCodeIds: description: The IDs of non time-off activity codes to check for conflicts in case the auto approval rule specifies checking activity codes. If these activity codes are present in schedule and overlap with the time-off request duration, the request will not be auto approved $ref: '#/definitions/SetWrapperString' overrideDates: description: A list of override dates to check for conflicts with time-off request dates. If a conflict is found, the request will not be auto-approved $ref: '#/definitions/ListWrapperOverrideDate' hrisTimeOffType: description: Time-off type, if this time-off plan is associated with the integration $ref: '#/definitions/ValueWrapperHrisTimeOffType' enabled: type: boolean description: Whether this time-off plan should be used by agents countAgainstTimeOffLimits: type: boolean description: Whether this time-off plan should count against time-off limits businessUnitAssociation: description: Business unit association, if the time-off plan belongs to a business unit. managementUnitAssociation must not be set if this is populated $ref: '#/definitions/UpdateTimeOffPlanBusinessUnitAssociation' managementUnitAssociation: description: Management unit association, if the time-off plan belongs to a management unit. businessUnitAssociation must not be set if this is populated $ref: '#/definitions/UpdateTimeOffPlanManagementUnitAssociation' metadata: description: Version metadata for this time-off plan $ref: '#/definitions/WfmVersionedEntityMetadata' BuAgentSchedulesQueryResponse: type: object properties: agentSchedules: type: array description: The requested agent schedules items: $ref: '#/definitions/BuAgentScheduleQueryResponse' businessUnitTimeZone: type: string description: The time zone configured for the business unit to which these schedules apply StaffingGroupResponse: type: object required: - id - metadata - name properties: id: type: string description: The globally unique identifier for the object. name: type: string description: The name of the staffing group users: type: array description: The list of users that belong to the staffing group uniqueItems: true items: $ref: '#/definitions/UserReference' managementUnit: description: The ID of the management unit to which the staffing group users belong. If undefined the staffing group can include users from the entire business unit $ref: '#/definitions/ManagementUnitReference' planningGroups: type: array description: The list of planning groups that are associated with the staffing group uniqueItems: true items: $ref: '#/definitions/PlanningGroupReference' metadata: description: Version metadata for the staffing group $ref: '#/definitions/WfmVersionedEntityMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true ForecastAverageSpeedOfAnswerResponse: type: object properties: seconds: type: integer format: int32 description: the average speed of answer goal in seconds AgentWorkPlan: type: object required: - constrainWeeklyPaidTime - flexibleWeeklyPaidTime - id - shifts - weeklyExactPaidMinutes - weeklyMaximumPaidMinutes - weeklyMinimumPaidMinutes properties: id: type: string description: The globally unique identifier for the object. name: type: string constrainWeeklyPaidTime: type: boolean description: Whether the weekly paid time constraint is enabled for this work plan flexibleWeeklyPaidTime: type: boolean description: Whether the weekly paid time constraint is flexible for this work plan weeklyExactPaidMinutes: type: integer format: int32 description: Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false weeklyMinimumPaidMinutes: type: integer format: int32 description: Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true weeklyMaximumPaidMinutes: type: integer format: int32 description: Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true optionalDays: description: Optional days to schedule for this work plan $ref: '#/definitions/SetWrapperDayOfWeek' shifts: type: array description: Shifts in this work plan items: $ref: '#/definitions/AgentWorkPlanShift' selfUri: type: string format: uri description: The URI for this object readOnly: true PlanningGroupRequirementOutput: type: object required: - id properties: id: type: string description: The ID of the planning group to which this output applies intervals: type: array description: List of interval values that correspond with the requirements granularity that was requested items: type: integer format: int32 errorDetails: type: array description: Error details if the intervals cannot be provided for this planning group because of missing data or internal error items: $ref: '#/definitions/LongTermRequirementsErrorDetail' serviceGoalDetails: description: The service goal details used to generate the requirements $ref: '#/definitions/LongTermRequirementsServiceGoalDetail' AgentsWorkPlansResponse: type: object properties: downloadUrl: type: string description: URL from which to fetch results for requests with a large result set. If populated, the downloaded data will conform to the same schema as would normally be returned, excepting downloaded data will never itself contain a downloadUrl result: description: The result of agent(s) work plans query $ref: '#/definitions/MuAgentsWorkPlansResult' AlternativeShiftTradesViewResponseTemplate: type: object properties: entities: type: array items: $ref: '#/definitions/AlternativeShiftTradeResponse' AgentPossibleWorkShiftsResponse: type: object properties: weekStartDate: type: string format: date description: 'Start date of requested effective work plan. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' pattern: type: array description: Each element is the ID of an effective work plan for a specific week items: type: integer format: int32 weeklyPossibleWorkShifts: type: array description: Each element is a weekly effective work plan that can be used for multiple weeks items: $ref: '#/definitions/PossibleWorkShiftsForWeek' schedulerIntervalLengthMinutes: type: integer format: int32 description: Number of minutes in each interval in the intervalScheduleProbabilities timeZone: type: string description: The time zone of the business unit AgentWorkPlanBiddingPreference: type: object required: - workPlan properties: workPlan: description: The work plan that belongs to the agent's bid group $ref: '#/definitions/WorkPlanReference' priority: type: integer format: int32 description: The agent's priority for this work plan, with 1 being the best priority. Null if priority is not set for the work plan HistoricalImportDeleteFilesJobRequest: type: object required: - requestIds properties: requestIds: type: array description: List of requestIds to be deleted. Max number of RequestIds should be 100 items: type: string BuScheduleNotificationsSettingsRequest: type: object properties: earlyReminderMinutes: type: integer format: int32 description: The number of minutes prior to the scheduled event to display an early reminder notification activityCategorySettings: type: array description: List of activity category notification settings items: $ref: '#/definitions/BuScheduleNotificationsCategorySettings' RealTimeAdherenceExplanation: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true startDate: type: string format: date-time description: The start timestamp of the adherence explanation in ISO-8601 format lengthMinutes: type: integer format: int32 description: The length of the adherence explanation in minutes status: type: string description: The status of the adherence explanation enum: - Pending - Approved - Denied selfUri: type: string format: uri description: The URI for this object readOnly: true MuAgentsWorkPlansResult: type: object required: - referenceStartWeekDate - workPlanLookup properties: entities: type: array items: $ref: '#/definitions/AgentWorkPlans' referenceStartWeekDate: type: string format: date description: 'The reference date in yyyy-MM-dd format rolled back to nearest BU start day of week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' workPlanLookup: type: object description: Map containing lookup values for agent work plans. The integer keys serves as lookup keys for effective work plan from workPlanLookupKeysPerWeek property additionalProperties: $ref: '#/definitions/WorkPlanReference' AgentWorkPlanBiddingPreferenceResponse: type: object required: - agentWorkPlanBidPreferences - submitted properties: id: type: string description: The globally unique identifier for the object. readOnly: true submitted: type: boolean description: Whether the preference is submitted assignedWorkPlan: description: The work plan assigned to the agent by the bid process $ref: '#/definitions/WorkPlanReference' overriddenWorkPlan: description: The work plan that overrides the assigned work plan for the agent $ref: '#/definitions/WorkPlanReference' overrideReason: type: string description: The reason why the assigned work plan has been overridden. This must be null without an override work plan enum: - UnableToBid - ChangeOfCircumstance - NewHire - EmployeeMove agentWorkPlanBidPreferences: type: array description: The list of work plan bidding preferences items: $ref: '#/definitions/AgentWorkPlanBiddingPreference' selfUri: type: string format: uri description: The URI for this object readOnly: true ImportScheduleUploadSchema: type: object required: - description - weekCount properties: description: type: string description: The description for the imported schedule weekCount: type: integer format: int32 description: The number of weeks the imported schedule will cover published: type: boolean description: Whether the imported schedule should be immediately published shortTermForecast: description: The short term forecast to associate with the imported schedule $ref: '#/definitions/BuShortTermForecastReference' headcountForecast: description: The headcount forecast to associate with the imported schedule $ref: '#/definitions/BuHeadcountForecastBuPlanningGroupHeadcountForecastUploadSchema' agentSchedules: type: array description: Individual agent schedules items: $ref: '#/definitions/BuImportAgentScheduleUploadSchema' AgentBusinessUnitOpportunities: type: object required: - opportunities properties: id: type: string description: The globally unique identifier for the object. readOnly: true opportunities: type: array description: The opportunities for the agent in this business unit items: $ref: '#/definitions/AgentQueryOpportunityResult' selfUri: type: string format: uri description: The URI for this object readOnly: true AgentScheduleBiddingPreferenceResponse: type: object required: - agentScheduleBidPreferences - submitted properties: id: type: string description: The globally unique identifier for the object. readOnly: true submitted: type: boolean description: Whether the preference is submitted assignedScheduleSetId: type: string description: The schedule set assigned to the agent by the bid process. Will be set after bid is processed overriddenScheduleSetId: type: string description: The schedule set that overrides the assigned schedule set for the agent overrideReason: type: string description: The reason why the assigned schedule set has been overridden. This must be null without an override schedule set enum: - UnableToBid - ChangeOfCircumstance - NewHire - EmployeeMove agentScheduleBidPreferences: type: array description: The schedule bidding preferences items: $ref: '#/definitions/AgentScheduleBiddingPreferencePriority' selfUri: type: string format: uri description: The URI for this object readOnly: true RecurrencePeriod: type: object required: - granularity - magnitude properties: magnitude: type: integer format: int32 description: The period of the activity plan in granularity units granularity: type: string description: The granularity unit to interpret the period of this activity plan enum: - Days - Weeks WorkPlanValidationMessageArgument: type: object properties: type: type: string description: The type of the argument associated with violation messages enum: - ActivityId - ActivityId2 - ActivityPaidTimeMinutes - ActivityStartTimeMinutes - ActivityValidationId - ActivityValidationId2 - ApplicableDays - Count - DailyPaidTimeMinutes - MaximumDays - MaxShiftCount - Minutes - PaidTimeGranularityMinutes - RequiredDays - ShiftId - ShiftPaidTimeMinutes - ShiftStartTimeMinutes - ShiftStopTimeMinutes - ShiftValidationId - WeeklyPaidTimeMinutes - Weeks - WorkTimeMinutes value: type: string description: The value of the argument ForecastPlanningGroupData: type: object required: - averageHandleTimeSecondsPerInterval - offeredPerInterval - planningGroupId properties: planningGroupId: type: string description: The ID of the planning group to which this data applies. Note this is a snapshot of the planning group at the time of forecast creation and may not correspond to the current configuration offeredPerInterval: type: array description: Forecast offered counts per 15 minute interval for this week of the forecast items: type: number format: double averageHandleTimeSecondsPerInterval: type: array description: Forecast average handle time per 15 minute interval in seconds items: type: number format: double BuCopyScheduleRequest: type: object required: - description - weekDate properties: description: type: string description: The description for the new schedule weekDate: type: string format: date description: 'The start weekDate for the new copy of the schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' includeForecast: type: boolean description: Whether to include the forecast while copying the schedule WorkPlanOverride: type: object required: - startDate - weekCount - workPlan properties: startDate: type: string format: date description: 'The start date in yyyy-MM-dd format of the work plan override. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' weekCount: type: integer format: int32 description: Number of weeks for the work plan override workPlan: description: The work plan reference associated with this override $ref: '#/definitions/WorkPlanReference' BuSchedulingSettingsRequest: type: object properties: messageSeverities: type: array description: Schedule generation message severity configuration items: $ref: '#/definitions/SchedulerMessageTypeSeverity' syncTimeOffProperties: description: Synchronize set of time off properties from scheduled activities to time off requests when the schedule is published $ref: '#/definitions/SetWrapperSyncTimeOffProperty' enableTimeOffFullDayEstimation: type: boolean description: Enables start and end time estimation for full-day time-off requests. When enabled, syncTimeOffProperties must include FullDayEarliestStartOffsetMinutes and FullDayLatestEndOffsetMinutes serviceGoalImpact: description: Configures the max percent increase and decrease of service goals for this business unit $ref: '#/definitions/WfmServiceGoalImpactSettings' allowWorkPlanPerMinuteGranularity: type: boolean description: Indicates whether or not per minute granularity for scheduling will be enabled for this business unit. Defaults to false activitySmoothingType: type: string description: The activity smoothing type for schedule generation in this business unit enum: - ReduceConcurrentActivitiesAcrossBu - ReduceConcurrentActivitiesAcrossMu - ConsistentServiceLevel induceScheduleVariability: type: boolean description: Indicates whether to provide variability in schedule generation ShiftTradeListJobResponse: type: object properties: entities: type: array items: $ref: '#/definitions/ShiftTradeResponseItem' DateRangeWithOptionalEnd: type: object required: - startBusinessUnitDate properties: startBusinessUnitDate: type: string format: date description: 'The start date for work plan rotation or an agent, interpreted in the business unit''s time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' endBusinessUnitDate: type: string format: date description: 'The end date for work plan rotation or an agent, interpreted in the business unit''s time zone. Null denotes open ended date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' WfmHistoricalAdherenceQueryForAgent: type: object required: - startDate properties: startDate: type: string format: date-time description: Beginning of the date range to query in ISO-8601 format endDate: type: string format: date-time description: End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time timeZone: type: string description: The time zone, in olson format, to use in defining days when computing adherence. The results will be returned as UTC timestamps regardless of the time zone input. AgentWorkPlanBid: type: object required: - bidWindowEndDate - bidWindowStartDate - effectiveDate - id - status - workPlanFieldsVisibleToAgents properties: id: type: string description: The ID of the work plan bid name: type: string bidWindowStartDate: type: string format: date description: 'The date when agents can start participating in work plan bidding. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' bidWindowEndDate: type: string format: date description: 'The inclusive end date of a bid window. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' effectiveDate: type: string format: date description: 'The date when agents will be assigned to the new work plan. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' status: type: string description: The state of the bid enum: - Draft - Locked - Optimized - Scheduled - Open - Closed - Processed - Published workPlanFieldsVisibleToAgents: type: array description: The work plan fields visible to agents whenever work plan preferences are made items: type: string enum: - Name - PaidHours bidType: type: string description: The type of the bid enum: - WorkPlanBid - ScheduleBid selfUri: type: string format: uri description: The URI for this object readOnly: true description: Work plan bid reference EvaluatedShiftTradeResponseItem: type: object required: - trade properties: trade: description: The evaluated shift trade $ref: '#/definitions/ShiftTradeResponseItem' matchReview: description: A preview of what the schedule would look like if the shift trade is approved plus any violations, or null if the shift is in a one-sided trade $ref: '#/definitions/ShiftTradeMatchReviewResponse' QueryOpportunitiesRequest: type: object required: - range properties: range: description: The date range for the query $ref: '#/definitions/RequiredDateRange' WfmHistoricalAdherenceBulkJobReference: type: object properties: id: type: string description: The ID of the historical adherence job to listen for via notification or query using the jobs route status: type: string description: The status of the historical adherence job enum: - Processing - Complete - Error selfUri: type: string format: uri description: The URI for this object readOnly: true ShiftTradeSettings: type: object properties: enabled: type: boolean description: Whether shift trading is enabled for this management unit autoReview: type: boolean description: Whether automatic shift trade review is enabled according to the rules defined in for this management unit allowDirectTrades: type: boolean description: Whether direct shift trades between agents are allowed minHoursInFuture: type: integer format: int32 description: The minimum number of hours in the future shift trades are allowed unequalPaid: type: string description: How to handle shift trades which involve unequal paid times enum: - Allow - Disallow - AdminReview oneSided: type: string description: How to handle one-sided shift trades enum: - Allow - Disallow - AdminReview weeklyMinPaidViolations: type: string description: How to handle shift trades which result in violations of weekly minimum paid time constraint enum: - Allow - Disallow - AdminReview weeklyMaxPaidViolations: type: string description: How to handle shift trades which result in violations of weekly maximum paid time constraint enum: - Allow - Disallow - AdminReview requiresMatchingQueues: type: boolean description: Whether to constrain shift trades to agents with matching queues requiresMatchingLanguages: type: boolean description: Whether to constrain shift trades to agents with matching languages requiresMatchingSkills: type: boolean description: Whether to constrain shift trades to agents with matching skills requiresMatchingPlanningGroups: type: boolean description: Whether to constrain shift trades to agents with matching planning groups activityCategoryRules: type: array description: Rules that specify what to do with activity categories that are part of a shift defined in a trade items: $ref: '#/definitions/ShiftTradeActivityRule' externalActivityRules: type: array description: Rules that specify what to do with external activities that are part of a shift items: $ref: '#/definitions/ShiftTradeExternalActivityRule' externalActivityRuleIgnoresActivityCategoryRule: type: boolean description: Whether external activity rules ignore activity category rules maxTradeSpanWeeks: type: integer format: int32 description: The maximum number of weeks a shift trade can span maxTradesPerAgentPerWeek: type: integer format: int32 description: The maximum number of shift trades an agent can submit per week minMinutesBetweenShifts: type: integer format: int32 description: The minimum number of minutes between shifts planningPeriodMinPaidViolations: type: string description: How to handle shift trades which result in violations of planning period minimum paid time constraint enum: - Allow - Disallow - AdminReview planningPeriodMaxPaidViolations: type: string description: How to handle shift trades which result in violations of planning period maximum paid time constraint enum: - Allow - Disallow - AdminReview minMinutesBetweenShiftsViolations: type: string description: How to handle shift trades which result in violations of minimum number of minutes between shifts constraint enum: - Allow - Disallow - AdminReview CopyWorkPlanBid: type: object required: - name properties: name: type: string description: The name of the new work plan bid CreateTimeOffLimitRequest: type: object properties: granularity: type: string description: Granularity choice for time off limit. If not specified, 'Daily' is assumed enum: - Daily - FifteenMinutes defaultLimitMinutes: type: integer format: int32 description: The default limit value in minutes per granularity. If not specified, then 0 is assumed, which means there are no time off minutes available CapacityPlanListItem: type: object required: - endBusinessUnitDate - id - metadata - startBusinessUnitDate properties: id: type: string description: The globally unique identifier for the object. name: type: string startBusinessUnitDate: type: string format: date description: 'The start date for the capacity plan relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' endBusinessUnitDate: type: string format: date description: 'The end date for the capacity plan relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' metadata: description: The metadata of this capacity plan $ref: '#/definitions/CapacityPlanMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true SchedulingSettingsResponse: type: object properties: maxOccupancyPercentForDeferredWork: type: integer format: int32 description: Max occupancy percent for deferred work defaultShrinkagePercent: type: number format: double description: Default shrinkage percent for scheduling shrinkageOverrides: description: Shrinkage overrides for scheduling $ref: '#/definitions/ShrinkageOverrides' planningPeriod: description: Planning period settings for scheduling. Only one of planningPeriod or monthlyPlanningPeriod will be defined if applicable, but both can be null $ref: '#/definitions/PlanningPeriodSettings' monthlyPlanningPeriod: description: Monthly planning period settings for scheduling. Only one of planningPeriod or monthlyPlanningPeriod will be defined if applicable, but both can be null $ref: '#/definitions/MonthlyPlanningPeriodSettings' startDayOfWeekend: type: string description: Start day of weekend for scheduling enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday UpdateWorkPlanRotationRequest: type: object required: - metadata properties: name: type: string description: Name of this work plan rotation enabled: type: boolean description: Whether the work plan rotation is enabled for scheduling dateRange: description: The date range to which this work plan rotation applies $ref: '#/definitions/DateRangeWithOptionalEnd' agents: type: array description: Agents in this work plan rotation items: $ref: '#/definitions/UpdateWorkPlanRotationAgentRequest' pattern: description: Pattern with list of work plan IDs that rotate on a weekly basis $ref: '#/definitions/WorkPlanPatternRequest' metadata: description: Version metadata for this work plan rotation $ref: '#/definitions/WfmVersionedEntityMetadata' ActivityPlanReference: type: object required: - id 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 Detail: type: object properties: errorCode: type: string fieldName: type: string entityId: type: string entityName: type: string ValidationServiceAsyncResponse: type: object properties: id: type: string description: Property denoting the job id of the import job readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true GroupSettings: type: object properties: minimumGroupSize: type: integer format: int32 description: The minimum size of a group for a session maximumGroupSize: type: integer format: int32 description: The maximum size of a group for a session maximumTotalSessions: type: integer format: int32 description: The maximum total number of sessions maximumConcurrentSessions: type: integer format: int32 description: The maximum number of sessions that can be scheduled concurrently WfmIntegrationResponse: type: object required: - active properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string active: type: boolean description: Whether integration state is active selfUri: type: string format: uri description: The URI for this object readOnly: true BuHeadcountForecastBuPlanningGroupHeadcountForecastUploadSchema: type: object properties: entities: type: array items: $ref: '#/definitions/BuPlanningGroupHeadcountForecastUploadSchema' referenceStartDate: type: string format: date-time description: 'Reference start date for the interval values in each forecast entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' WeekScheduleReference: type: object required: - id 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 weekDate: type: string description: First day of this week schedule in yyyy-MM-dd format ShiftTradeBulkUpdateTradeStateBuJobResponse: type: object required: - id - status - type properties: id: type: string description: The globally unique identifier for the object. status: type: string description: The status of the job enum: - Processing - Complete - Canceled - Error type: type: string description: The type of the job enum: - AddTrade - BulkUpdateTradeStates - EvaluateTrades - MatchTrade - QueryAgentTrades - QueryTrades - QueryWeekSummaries - SearchUnmatchedTrades - UpdateTrade - UpdateTradeState downloadUrl: type: string description: The URL where completed results might be available for download in case the result body for that job type is too large error: description: Any error information, only set if the status == 'Error' $ref: '#/definitions/ErrorBody' bulkUpdateTradeStatesResult: description: Results for BulkUpdateTradeStates job type $ref: '#/definitions/BulkUpdateShiftTradeStateResult' selfUri: type: string format: uri description: The URI for this object readOnly: true WorkPlanListItemResponse: type: object required: - id - metadata properties: id: type: string description: The globally unique identifier for the object. name: type: string enabled: type: boolean description: Whether the work plan is enabled for scheduling valid: type: boolean description: Whether the work plan is valid or not readOnly: true constrainWeeklyPaidTime: type: boolean description: Whether the weekly paid time constraint is enabled for this work plan flexibleWeeklyPaidTime: type: boolean description: Whether the weekly paid time constraint is flexible for this work plan weeklyExactPaidMinutes: type: integer format: int32 description: Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false weeklyMinimumPaidMinutes: type: integer format: int32 description: Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true weeklyMaximumPaidMinutes: type: integer format: int32 description: Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true constrainPaidTimeGranularity: type: boolean description: Whether paid time granularity is constrained for this work plan paidTimeGranularityMinutes: type: integer format: int32 description: Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true constrainMinimumTimeBetweenShifts: type: boolean description: Whether the minimum time between shifts constraint is enabled for this work plan minimumTimeBetweenShiftsMinutes: type: integer format: int32 description: Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true maximumDays: type: integer format: int32 description: Maximum number days in a week allowed to be scheduled for this work plan minimumConsecutiveNonWorkingMinutesPerWeek: type: integer format: int32 description: Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off constrainMaximumConsecutiveWorkingWeekends: type: boolean description: Whether to constrain the maximum consecutive working weekends maximumConsecutiveWorkingWeekends: type: integer format: int32 description: The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work minimumWorkingDaysPerWeek: type: integer format: int32 description: The minimum number of days that agents assigned to a work plan must work per week constrainMaximumConsecutiveWorkingDays: type: boolean description: Whether to constrain the maximum consecutive working days maximumConsecutiveWorkingDays: type: integer format: int32 description: The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true minimumShiftStartDistanceMinutes: type: integer format: int32 description: The time period in minutes for the duration between the start times of two consecutive working days minimumDaysOffPerPlanningPeriod: type: integer format: int32 description: Minimum days off in the planning period maximumDaysOffPerPlanningPeriod: type: integer format: int32 description: Maximum days off in the planning period minimumPaidMinutesPerPlanningPeriod: type: integer format: int32 description: Minimum paid minutes in the planning period maximumPaidMinutesPerPlanningPeriod: type: integer format: int32 description: Maximum paid minutes in the planning period constrainMaximumWorkingWeekendsPerPlanningPeriod: type: boolean description: Whether to constrain the maximum working weekends in the planning period maximumWorkingWeekendsPerPlanningPeriod: type: integer format: int32 description: Maximum working weekends in the planning period optionalDays: description: Optional days to schedule for this work plan. Populate with expand=details $ref: '#/definitions/SetWrapperDayOfWeek' shiftStartVarianceType: type: string description: This constraint ensures that an agent starts each workday within a user-defined time threshold enum: - ShiftStart - ShiftStartAndPaidDuration shiftStartVariancePeriod: type: string description: The length of the period over which the maximum shift start time variance is applied enum: - Weekly - PlanningPeriod shiftStartVariances: description: Variance in minutes among start times of shifts in this work plan. Populate with expand=details $ref: '#/definitions/ListWrapperShiftStartVariance' shifts: type: array description: Shifts in this work plan. Populate with expand=details (defaults to empty list) items: $ref: '#/definitions/WorkPlanShift' agents: type: array description: Agents in this work plan. Populate with expand=details (defaults to empty list) items: $ref: '#/definitions/DeletableUserReference' agentCount: type: integer format: int32 description: Number of agents in this work plan. Populate with expand=agentCount metadata: description: Version metadata for this work plan $ref: '#/definitions/WfmVersionedEntityMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true AdminAgentScheduleBidBiddingPreference: type: object required: - agent - agentScheduleBidPreferencePriorities - submitted properties: agent: description: The agent to whom this schedule bid preference applies $ref: '#/definitions/UserReference' submitted: type: boolean description: Indicates whether the preference has been submitted assignedScheduleSetId: type: string description: The schedule set assigned to the agent by the bid process. This will be set after bid is processed overriddenScheduleSetId: type: string description: The schedule set that overrides the assigned schedule set for the agent overrideReason: type: string description: The reason the assigned schedule set has been overridden. This must be null if no override schedule is set enum: - UnableToBid - ChangeOfCircumstance - NewHire - EmployeeMove agentScheduleBidPreferencePriorities: type: array description: The agent schedule set preferences items: $ref: '#/definitions/AgentScheduleBiddingPreferencePriority' endDate: type: string format: date description: 'The end date of this scheduling set preference relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' UpdateShiftTradeStateJobRequest: type: object required: - metadata - state - weekDate properties: weekDate: type: string format: date description: 'The start week date of this shift in the business unit time zone (yyyy-MM-dd format). Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' state: type: string description: The new state to set on the shift trade enum: - Unmatched - Matched - Approved - Denied - Expired - Canceled metadata: description: Version metadata for the shift trade $ref: '#/definitions/WfmVersionedEntityMetadata' AlternativeShiftScheduleLookup: type: object required: - id - weekDate properties: id: type: string description: The unique identifier of the schedule weekDate: type: string format: date description: 'The start date for this schedule in yyyy-MM-dd. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' ForecastServiceGoalTemplateResponse: type: object properties: serviceLevel: description: The service level goal for this forecast $ref: '#/definitions/ForecastServiceLevelResponse' averageSpeedOfAnswer: description: The average speed of answer goal for this forecast $ref: '#/definitions/ForecastAverageSpeedOfAnswerResponse' abandonRate: description: The abandon rate goal for this forecast $ref: '#/definitions/ForecastAbandonRateResponse' impactOverride: description: The service goal impact overrides for this forecast $ref: '#/definitions/ForecastServiceGoalTemplateImpactOverrideResponse' ManagementUnitAvailabilitySettingsResponse: type: object required: - enabled properties: enabled: type: boolean description: Indicates whether agent availability is enabled for the management unit BuForecastGenerationResult: type: object properties: planningGroupResults: type: array description: Generation results, broken down by planning group items: $ref: '#/definitions/BuForecastGenerationPlanningGroupResult' WorkPlanValidationRequest: type: object required: - id properties: id: type: string description: The globally unique identifier for the object. name: type: string enabled: type: boolean description: Whether the work plan is enabled for scheduling valid: type: boolean description: Whether the work plan is valid or not readOnly: true constrainWeeklyPaidTime: type: boolean description: Whether the weekly paid time constraint is enabled for this work plan flexibleWeeklyPaidTime: type: boolean description: Whether the weekly paid time constraint is flexible for this work plan weeklyExactPaidMinutes: type: integer format: int32 description: Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false weeklyMinimumPaidMinutes: type: integer format: int32 description: Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true weeklyMaximumPaidMinutes: type: integer format: int32 description: Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true constrainPaidTimeGranularity: type: boolean description: Whether paid time granularity is constrained for this work plan paidTimeGranularityMinutes: type: integer format: int32 description: Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true constrainMinimumTimeBetweenShifts: type: boolean description: Whether the minimum time between shifts constraint is enabled for this work plan minimumTimeBetweenShiftsMinutes: type: integer format: int32 description: Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true maximumDays: type: integer format: int32 description: Maximum number days in a week allowed to be scheduled for this work plan minimumConsecutiveNonWorkingMinutesPerWeek: type: integer format: int32 description: Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off constrainMaximumConsecutiveWorkingWeekends: type: boolean description: Whether to constrain the maximum consecutive working weekends maximumConsecutiveWorkingWeekends: type: integer format: int32 description: The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work minimumWorkingDaysPerWeek: type: integer format: int32 description: The minimum number of days that agents assigned to a work plan must work per week constrainMaximumConsecutiveWorkingDays: type: boolean description: Whether to constrain the maximum consecutive working days maximumConsecutiveWorkingDays: type: integer format: int32 description: The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true minimumShiftStartDistanceMinutes: type: integer format: int32 description: The time period in minutes for the duration between the start times of two consecutive working days minimumDaysOffPerPlanningPeriod: type: integer format: int32 description: Minimum days off in the planning period maximumDaysOffPerPlanningPeriod: type: integer format: int32 description: Maximum days off in the planning period minimumPaidMinutesPerPlanningPeriod: type: integer format: int32 description: Minimum paid minutes in the planning period maximumPaidMinutesPerPlanningPeriod: type: integer format: int32 description: Maximum paid minutes in the planning period constrainMaximumWorkingWeekendsPerPlanningPeriod: type: boolean description: Whether to constrain the maximum working weekends in the planning period maximumWorkingWeekendsPerPlanningPeriod: type: integer format: int32 description: Maximum working weekends in the planning period optionalDays: description: Optional days to schedule for this work plan $ref: '#/definitions/SetWrapperDayOfWeek' shiftStartVarianceType: type: string description: This constraint ensures that an agent starts each workday within a user-defined time threshold enum: - ShiftStart - ShiftStartAndPaidDuration shiftStartVariancePeriod: type: string description: The length of the period over which the maximum shift start time variance is applied enum: - Weekly - PlanningPeriod shiftStartVariances: description: Variance in minutes among start times of shifts in this work plan $ref: '#/definitions/ListWrapperShiftStartVariance' shifts: type: array description: Shifts in this work plan items: $ref: '#/definitions/WorkPlanShift' agents: type: array description: Agents in this work plan items: $ref: '#/definitions/DeletableUserReference' agentCount: type: integer format: int32 description: Number of agents in this work plan selfUri: type: string format: uri description: The URI for this object readOnly: true AgentWorkPlans: type: object required: - user - workPlanLookupKeysPerWeek properties: user: description: The user (agent) for whom the work plans were requested $ref: '#/definitions/UserReference' workPlanLookupKeysPerWeek: type: array description: The list of weekly work plan lookup keys. Keys to be searched under workPlanLookup property at top level of result items: type: integer format: int32 BusinessUnitListItem: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string authorized: type: boolean description: Whether the user has authorization to interact with this business unit readOnly: true division: description: The division to which this entity belongs. $ref: '#/definitions/DivisionReference' selfUri: type: string format: uri description: The URI for this object readOnly: true BuTimeOffLimitRange: type: object required: - startDate properties: startDate: type: string format: date description: 'Start date of the range. The end date is determined by the size of ''limitMinutesPerDay''. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' limitMinutesPerDay: type: array description: The list of time-off limit values in minutes per day. If 'null' is specified, then the day-specific value is cleared. Such a day will have a value of 0 items: type: integer format: int32 QueryOpportunityEnrollmentMetadata: type: object required: - version properties: modifiedBy: description: The user who last modified the associated entity. The id may be 'System' if it was an automated process readOnly: true $ref: '#/definitions/UserReference' dateModified: type: string format: date-time description: 'The date the associated entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true createdBy: description: The user who created the associated entity, if available. The id may be 'System' if it was an automated process readOnly: true $ref: '#/definitions/UserReference' dateCreated: type: string format: date-time description: 'The date the associated entity was created, if available. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: The version of the associated entity. Used to prevent conflicts on concurrent edits reviewedBy: description: The user who reviewed the enrollment $ref: '#/definitions/UserReference' dateReviewed: type: string format: date-time description: 'The date the enrollment was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' ListAlternativeShiftTradesResponse: type: object properties: job: description: The asynchronous job handling the request. Null if result returns synchronously $ref: '#/definitions/AlternativeShiftJobResponse' result: description: The result of the request. May come via notification. Null if job is populated $ref: '#/definitions/AlternativeShiftTradeListing' BulkOpportunitiesStatusUpdateResponse: type: object required: - errorCount - results properties: results: type: array description: The result for each requested item items: $ref: '#/definitions/BulkOpportunitiesReferenceResult' errorCount: type: integer format: int32 description: The count of failed operations in the bulk request OpportunityReference: type: object required: - id 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 TransfersFullTimeEquivalent: type: object properties: destinationStaffingGroupId: type: string description: The target staffing group that will receive the full time equivalent when agents are transferred from one staffing group to another transferType: type: string description: The duration of the transfer full time equivalent from one staffing group to another enum: - Permanent - Temporary EstimateAvailableTimeOffResponse: type: object required: - activityCodeId - paid - user properties: fullDayDates: type: array description: Full day dates. partialDayDates must be empty if this field is populated items: $ref: '#/definitions/EstimateAvailableFullDayTimeOffResponse' partialDayDates: type: array description: Partial day dates. fullDayDates must be empty if this field is populated items: $ref: '#/definitions/EstimateAvailablePartialDayTimeOffResponse' user: description: The user to whom the time off request belongs $ref: '#/definitions/UserReference' activityCodeId: type: string description: The ID of the activity code associated with the time off request. Activity code must be of the TimeOff category paid: type: boolean description: Whether this estimate is for a paid time off request BulkAddOpportunitiesResponse: type: object required: - opportunities properties: opportunities: type: array description: The list of opportunities items: $ref: '#/definitions/OpportunityResult' ForecastAbandonRateResponse: type: object properties: percent: type: integer format: int32 description: The target percent abandon rate goal AgentWorkPlanShift: type: object required: - activities - constrainLatestStopTime - days - earliestStartTimeMinutesFromMidnight - earliestStopTimeMinutesFromMidnight - exactPaidTimeMinutes - exactStartTimeMinutesFromMidnight - flexiblePaidTime - flexibleStartTime - latestStartTimeMinutesFromMidnight - latestStopTimeMinutesFromMidnight - maximumPaidTimeMinutes - minimumPaidTimeMinutes properties: days: description: Days of the week applicable for this shift $ref: '#/definitions/SetWrapperDayOfWeek' flexibleStartTime: type: boolean description: Whether the start time of the shift is flexible exactStartTimeMinutesFromMidnight: type: integer format: int32 description: Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false earliestStartTimeMinutesFromMidnight: type: integer format: int32 description: Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true latestStartTimeMinutesFromMidnight: type: integer format: int32 description: Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true earliestStopTimeMinutesFromMidnight: type: integer format: int32 description: This is the earliest time a shift can end constrainLatestStopTime: type: boolean description: Whether the latest stop time constraint for the shift is enabled latestStopTimeMinutesFromMidnight: type: integer format: int32 description: Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true flexiblePaidTime: type: boolean description: Whether the paid time setting for the shift is flexible exactPaidTimeMinutes: type: integer format: int32 description: Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false minimumPaidTimeMinutes: type: integer format: int32 description: Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true maximumPaidTimeMinutes: type: integer format: int32 description: Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true activities: type: array description: Activities configured for this shift items: $ref: '#/definitions/AgentWorkPlanActivity' BuAsyncScheduleRunResponse: type: object properties: status: type: string description: The status of the operation enum: - Processing - Complete - Canceled - Error operationId: type: string description: The ID for the operation result: description: The result of the operation. Null unless status == Complete $ref: '#/definitions/BuScheduleRun' ActivityPlanJobResponse: type: object required: - activityPlan - exceptions - id - status - type properties: id: type: string description: The globally unique identifier for the object. status: type: string description: The status of the job enum: - Processing - Complete - Error exceptions: type: array description: The list of exceptions that occurred while running this activity plan job. These are exceptions that affect individual occurrences but didn't prevent the job from completing items: $ref: '#/definitions/ActivityPlanJobException' error: description: Error details if status == 'Error'. These are errors that caused the job to fail to complete $ref: '#/definitions/ErrorBody' activityPlan: description: The activity plan associated with this job $ref: '#/definitions/ActivityPlanStructureWithOccurrenceSessionsUsersReference' type: type: string description: The type of the job enum: - RunPlan - DeleteActivityPlan - DeleteOccurrence - DeleteOccurrences - DeleteSessions - DeleteSessionUsers occurrence: description: The occurrence associated with this job if type == 'DeleteOccurrence' $ref: '#/definitions/ActivityPlanOccurrenceReference' selfUri: type: string format: uri description: The URI for this object readOnly: true AddAdherenceExplanationAdminRequest: type: object required: - lengthMinutes - startDate - type properties: type: type: string description: The type of the adherence explanation enum: - Late startDate: type: string format: date-time description: The start timestamp of the adherence explanation in ISO-8601 format lengthMinutes: type: integer format: int32 description: The length of the adherence explanation in minutes notes: type: string description: Notes about the adherence explanation status: type: string description: The status of the adherence explanation enum: - Pending - Approved - Denied QueryAdherenceExplanationsResponse: type: object properties: job: description: The asynchronous job handling the query $ref: '#/definitions/AdherenceExplanationJobReference' result: description: The result of the query. May come via notification $ref: '#/definitions/AdherenceExplanationListing' downloadUrl: type: string description: The URL from which to download the result. May come via notification BuForecastStaffingRequirementsResultResponse: type: object required: - businessUnitId - forecast - intervalLengthMinutes - referenceStartDate - state - weekCount properties: businessUnitId: type: string description: The ID of the business unit to which the forecast staffing requirements belongs forecast: description: The forecast reference $ref: '#/definitions/BuShortTermForecastReference' referenceStartDate: type: string format: date-time description: The reference start date for interval-based data for this forecast as an ISO-8601 string weekCount: type: integer format: int32 description: The number of weeks in this forecast intervalLengthMinutes: type: integer format: int32 description: The period/interval in minutes for which to aggregate the data state: type: string description: The state of the staffing requirements generation enum: - Processing - Complete - Error results: type: array description: The forecast staffing requirement results, Will be populated when state == 'Complete' items: $ref: '#/definitions/BuForecastStaffingRequirementsResult' ActivityCodeSummary: type: object required: - id properties: id: type: string description: The globally unique identifier for the object. name: type: string secondaryPresences: type: array description: The secondary presences of this activity code. items: $ref: '#/definitions/SecondaryPresence' selfUri: type: string format: uri description: The URI for this object readOnly: true UnavailableTimeListing: type: object properties: entities: type: array items: $ref: '#/definitions/UnavailableTime' 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 BusinessUnitReference: 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 QueryTimeOffLimitValuesRequest: type: object required: - dateRanges properties: timeOffLimitId: type: string description: The time off limit object id to retrieve values for. Required if activityCodeId is not specified activityCodeId: type: string description: The ID of the activity code by which to filter the affected limit objects. Required if timeOffLimitId is not specified dateRanges: type: array description: The list of the date ranges to return time off limit, allocated and waitlisted minutes. The valid number of date ranges is between 1 and 30. Maximum total number of days in all ranges in 366. items: $ref: '#/definitions/LocalDateRange' PlanningPeriodShiftConstraints: type: object properties: enabled: type: boolean description: Whether shifts per planning period is enabled. This field is non-nullable on the response minimumCount: type: integer format: int32 description: The minimum number of shifts required per planning period. This field is non-nullable on the response maximumCount: type: integer format: int32 description: The maximum number of shifts allowed per planning period. This field is non-nullable on the response OpportunityEnrollmentCounts: type: object required: - approved - denied - pending - withdrawn properties: pending: type: integer format: int32 description: The number of pending enrollments for this opportunity approved: type: integer format: int32 description: The number of approved enrollments for this opportunity denied: type: integer format: int32 description: The number of denied enrollments for this opportunity withdrawn: type: integer format: int32 description: The number of withdrawn enrollments for this opportunity UpdateManagementUnitsSettingsRequest: type: object properties: enabled: type: boolean description: Indicates whether agent availability is enabled for the management unit WorkPlanRotationReference: type: object required: - id 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 CreateScheduleBid: type: object required: - agentRankingType - bidWindowEndDate - bidWindowStartDate - effectiveDate - name - rankingTiebreakerType - weeksToSchedule properties: name: type: string description: The name of the schedule bid forecast: description: The selected forecast used for schedule set generation for this bid $ref: '#/definitions/BuShortTermForecastWeekReference' bidWindowStartDate: type: string format: date description: 'The bid start date where agents start participating in schedule bidding relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' bidWindowEndDate: type: string format: date description: 'The bid end date relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' effectiveDate: type: string format: date description: 'The date when schedule sets would be effective for schedule generation relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' weeksToSchedule: type: integer format: int32 description: The number of weeks to generate schedule set through this bid endOverridesAndRotations: type: boolean description: If true, all existing overrides, work plan rotations will be ended one day before effective date of this bid agentRankingType: type: string description: The type of agent ranking selected for this bid enum: - HireDate - Performance rankingTiebreakerType: type: string description: Ranking tiebreaker to be used enum: - HireDate - Performance - Custom - RandomlyAssign UpdateManagementUnitRequest: type: object properties: name: type: string description: The new name of the management unit divisionId: type: string description: The new division id for the management unit settings: description: Updated settings for the management unit $ref: '#/definitions/ManagementUnitSettingsRequest' WfmProcessUploadRequest: type: object required: - uploadKey properties: uploadKey: type: string description: The uploadKey provided by the request to get an upload URL AgentBulkAddOpportunityEnrollmentsResponse: type: object required: - errorCount - results properties: results: type: array description: The result for each requested item items: $ref: '#/definitions/AgentBulkAddOpportunityEnrollmentResult' errorCount: type: integer format: int32 description: The count of failed operations in the bulk request WfmIntradayPlanningGroupListing: type: object properties: entities: type: array items: $ref: '#/definitions/ForecastPlanningGroupResponse' noDataReason: type: string description: The reason there was no data for the request enum: - NoPublishedSchedule - NoSourceForecast AlternativeShiftBulkUpdateTradesResponseTemplate: type: object properties: entities: type: array items: $ref: '#/definitions/AlternativeShiftTradeBulkUpdateTemplateItem' HistoricalDataDisallowedDeleteEntity: type: object properties: requestId: type: string description: The requestId associated with this disallowed entity reason: type: string description: The error code explaining why the delete request for the requestId was disallowed enum: - InvalidRequest - ValidationInProgress - DeleteInProgress - RequestIdNotFound PatchOpportunityRequest: type: object required: - metadata properties: startDate: type: string format: date-time description: The start date and time of the opportunity in ISO-8601 format endDate: type: string format: date-time description: The end date and time of the opportunity in ISO-8601 format openDate: description: The date and time when the opportunity opens for enrollment in ISO-8601 format. If not provided or in the past, it will be automatically updated to the current time when the opportunity is published $ref: '#/definitions/ValueWrapperInstant' deadlineDate: type: string format: date-time description: The deadline date and time for enrollment in the opportunity in ISO-8601 format name: type: string description: The name of the opportunity description: description: Additional details describing the purpose or context of this opportunity $ref: '#/definitions/ValueWrapperString' activityCodeId: type: string description: The ID of the activity code associated with the opportunity approvalType: type: string description: The approval type for enrollments enum: - Automatic - Manual capacity: type: integer format: int32 description: The maximum capacity (enrollment slots) for this opportunity agentIds: description: The IDs of the agents that are invited to the opportunity $ref: '#/definitions/ListWrapperString' metadata: description: The metadata for the opportunity $ref: '#/definitions/WfmVersionedEntityMetadata' WorkPlanOverrideRequest: type: object required: - startDate properties: action: type: string description: The action to perform on work plan override, defaults to add enum: - Add - Update - Delete startDate: type: string format: date description: 'The start date in yyyy-MM-dd format for the updated work plan. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' weekCount: type: integer format: int32 description: The week count of the updated work plan, required if action is Add or Update workPlanId: type: string description: The updated work plan id WfmAgent: type: object required: - id properties: id: type: string description: The globally unique identifier for the object. user: description: The user associated with this data $ref: '#/definitions/UserReference' workPlan: description: The work plan associated with this agent, if applicable $ref: '#/definitions/WorkPlanReference' workPlanRotation: description: The work plan rotation associated with this agent, if applicable $ref: '#/definitions/WorkPlanRotationReference' acceptDirectShiftTrades: type: boolean description: Whether the agent accepts direct shift trade requests workPlanOverrides: type: array description: The work plan overrides associated with this agent. Populate with expand=workPlanOverrides items: $ref: '#/definitions/WorkPlanOverride' queues: type: array description: List of queues to which this agent is capable of handling items: $ref: '#/definitions/QueueReference' languages: type: array description: The list of languages this agent is capable of handling items: $ref: '#/definitions/LanguageReference' skills: type: array description: The list of skills this agent is capable of handling items: $ref: '#/definitions/RoutingSkillReference' schedulable: type: boolean description: Whether the agent can be included in schedule generation metadata: description: Metadata for this agent $ref: '#/definitions/WfmVersionedEntityMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true ManagementUnitSettingsResponse: type: object required: - metadata properties: adherence: description: Adherence settings for this management unit $ref: '#/definitions/AdherenceSettings' shortTermForecasting: description: Short term forecasting settings for this management unit $ref: '#/definitions/ShortTermForecastingSettings' timeOff: description: Time off request settings for this management unit $ref: '#/definitions/TimeOffSettingsResponse' scheduling: description: Scheduling settings for this management unit. These settings are only available if you have the permission wfm:managementUnit:view $ref: '#/definitions/SchedulingSettingsResponse' shiftTrading: description: Shift trade settings for this management unit $ref: '#/definitions/ShiftTradeSettings' metadata: description: Version info metadata for the associated management unit $ref: '#/definitions/WfmVersionedEntityMetadata' BulkOpportunitiesStatusUpdateRequest: type: object required: - opportunityIds - status properties: opportunityIds: type: array description: The IDs of the opportunities to update items: type: string status: type: string description: The status to set for all opportunities specified in this request enum: - Closed SchedulingProcessingError: type: object properties: internalErrorCode: type: string description: An internal code representing the type of error. BadJson for 'Unable to parse json.' NotFound for 'Resource not found.' Fail for 'An unexpected server error occured.' readOnly: true enum: - BadJson - NotFound - Fail description: type: string description: A text description of the error readOnly: true UserScheduleContainer: type: object properties: managementUnitTimeZone: type: string description: The reference time zone used for the management unit publishedSchedules: type: array description: References to all published week schedules overlapping the start/end date query parameters items: $ref: '#/definitions/WeekScheduleReference' userSchedules: type: object description: Map of user id to user schedule additionalProperties: $ref: '#/definitions/UserSchedule' CreateWorkPlanBid: type: object required: - agentRankingType - bidWindowEndDate - bidWindowStartDate - effectiveDate - name - rankingTiebreakerType - workPlanFieldsVisibleToAgents properties: name: type: string description: The name of the work plan bid forecast: description: The selected forecast in this work plan bid $ref: '#/definitions/BuShortTermForecastWeekReference' bidWindowStartDate: type: string format: date description: 'The bid start date where agents start participate in work plan bidding in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' bidWindowEndDate: type: string format: date description: 'The bid end date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' effectiveDate: type: string format: date description: 'The date when agents will be assigned to the new work plan in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' agentRankingType: type: string description: The type of agent ranking selected for this bid enum: - HireDate - Performance rankingTiebreakerType: type: string description: Ranking tiebreaker to be used enum: - HireDate - Performance - Custom - RandomlyAssign endOverridesAndRotations: type: boolean description: If true, all existing overrides, workplan rotations will be ended one day before effective date of this bid workPlanFieldsVisibleToAgents: type: array description: The work plan fields visible to agents whenever work plan preferences are made items: type: string enum: - Name - PaidHours description: Create work plan bid model ScheduleGenerationResultSummary: type: object properties: failed: type: boolean description: Whether the schedule generation run failed runId: type: string description: The ID of the schedule generation run. Reference this when requesting support messageCount: type: integer format: int32 description: The number of schedule generation messages for this schedule generation run messageSeverityCounts: type: array description: The list of schedule generation message counts by severity for this schedule generation run items: $ref: '#/definitions/SchedulerMessageSeverityCount' UpdateMuAgentWorkPlansBatchRequest: type: object properties: entities: type: array items: $ref: '#/definitions/UpdateMuAgentWorkPlanRequest' UserTimeOffIntegrationStatusResponseListing: type: object properties: entities: type: array items: $ref: '#/definitions/UserTimeOffIntegrationStatusResponse' BidGroupWorkPlanRequest: type: object required: - workPlanId properties: workPlanId: type: string description: The ID of the work plan used in the bid group overrideAgentCount: type: integer format: int32 description: The modified agent count for this work plan suggestedAgentCount: type: integer format: int32 description: The number of agents needed for this work plan to produce the optimal schedule readOnly: true agentCountRange: description: The range of agent slot count per work plan. The suggested slot count must be in agent count range readOnly: true $ref: '#/definitions/AgentCountRange' WorkPlanBidGroupSummary: type: object required: - agentCount - id - managementUnit - name - planningGroupCount - workPlanCount properties: id: type: string description: The globally unique identifier for the object. name: type: string description: The name assigned to this bid group managementUnit: description: The management unit this bid group belongs to $ref: '#/definitions/ManagementUnitReference' agentCount: type: integer format: int32 description: The number of agents in this bid group workPlanCount: type: integer format: int32 description: The number of work plans in this bid group planningGroupCount: type: integer format: int32 description: The number of planning groups in this bid group selfUri: type: string format: uri description: The URI for this object readOnly: true TimeOffBalanceResponse: type: object required: - activityCodeId - hrisTimeOffTypeId properties: activityCodeId: type: string description: The ID for activity code associated with time off balance hrisTimeOffTypeId: type: string description: The ID of the time off type configured in HRIS integration hrisTimeOffTypeSecondaryId: type: string description: The secondary ID of the time off type configured in HRIS integration startDate: type: string format: date description: 'The Start date of the requested date range. The end date is determined by the size of interval list. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' balanceMinutesPerDay: type: array description: The list of available time off balance values in minutes for each day items: type: integer format: int32 CopyBuForecastRequest: type: object required: - description - weekDate properties: description: type: string description: The description for the forecast weekDate: type: string format: date description: 'The start date of the new forecast to create from the existing forecast. Must correspond to the start day of week for the business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' WfmVersionedEntityMetadata: type: object required: - version properties: modifiedBy: description: The user who last modified the associated entity. The id may be 'System' if it was an automated process readOnly: true $ref: '#/definitions/UserReference' dateModified: type: string format: date-time description: 'The date the associated entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true createdBy: description: The user who created the associated entity, if available. The id may be 'System' if it was an automated process readOnly: true $ref: '#/definitions/UserReference' dateCreated: type: string format: date-time description: 'The date the associated entity was created, if available. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: The version of the associated entity. Used to prevent conflicts on concurrent edits ForecastMetadata: type: object properties: dateCreated: type: string format: date-time description: 'Forecast creation date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' forecastId: type: string description: Forecast ID intervalLengthInMinutes: type: string description: Interval length source: type: string description: Forecast source enum: - AutomaticBestMethod - MainForecast dateStart: type: string format: date-time description: 'Forecast start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' timeZone: type: string description: Timezone of the business unit BuImportAgentScheduleUploadSchema: type: object required: - userId properties: userId: type: string description: The ID of the user to whom this agent schedule applies workPlanId: description: The ID of the work plan for this user. Mutually exclusive with workPlanIdsPerWeek $ref: '#/definitions/ValueWrapperString' workPlanIdsPerWeek: description: The IDs of the work plans per week for this user. Mutually exclusive with workPlanId $ref: '#/definitions/ListWrapperString' shifts: type: array description: The shift definitions for this agent schedule items: $ref: '#/definitions/BuAgentScheduleShiftRequest' fullDayTimeOffMarkers: type: array description: Any full day time off markers that apply to this agent schedule items: $ref: '#/definitions/BuFullDayTimeOffMarker' WeekSchedule: type: object required: - id 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 weekDate: type: string description: First day of this week schedule in yyyy-MM-dd format description: type: string description: Description of the week schedule published: type: boolean description: Whether the week schedule is published generationResults: description: Summary of the results from the schedule run $ref: '#/definitions/WeekScheduleGenerationResult' shortTermForecast: description: Short term forecast associated with this schedule $ref: '#/definitions/ShortTermForecastReference' metadata: description: Version metadata for this work plan $ref: '#/definitions/WfmVersionedEntityMetadata' userSchedules: type: object description: User schedules in the week additionalProperties: $ref: '#/definitions/UserSchedule' headcountForecast: description: Headcount information for the week schedule $ref: '#/definitions/HeadcountForecast' agentSchedulesVersion: type: integer format: int32 description: Version of agent schedules in the week schedule PlanningGroupMinimumsResponse: type: object required: - dayOfWeekMinimums - planningGroup properties: planningGroup: description: The planning group to which the day of week minimum staff values apply $ref: '#/definitions/PlanningGroupReference' dayOfWeekMinimums: type: array description: The list of day of week minimum staff values for this planning group items: $ref: '#/definitions/DayOfWeekMinimums' ListWrapperString: type: object properties: values: type: array items: type: string WorkPlan: type: object required: - id - metadata properties: id: type: string description: The globally unique identifier for the object. name: type: string enabled: type: boolean description: Whether the work plan is enabled for scheduling valid: type: boolean description: Whether the work plan is valid or not readOnly: true constrainWeeklyPaidTime: type: boolean description: Whether the weekly paid time constraint is enabled for this work plan flexibleWeeklyPaidTime: type: boolean description: Whether the weekly paid time constraint is flexible for this work plan weeklyExactPaidMinutes: type: integer format: int32 description: Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false weeklyMinimumPaidMinutes: type: integer format: int32 description: Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true weeklyMaximumPaidMinutes: type: integer format: int32 description: Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true constrainPaidTimeGranularity: type: boolean description: Whether paid time granularity is constrained for this work plan paidTimeGranularityMinutes: type: integer format: int32 description: Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true constrainMinimumTimeBetweenShifts: type: boolean description: Whether the minimum time between shifts constraint is enabled for this work plan minimumTimeBetweenShiftsMinutes: type: integer format: int32 description: Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true maximumDays: type: integer format: int32 description: Maximum number days in a week allowed to be scheduled for this work plan minimumConsecutiveNonWorkingMinutesPerWeek: type: integer format: int32 description: Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off constrainMaximumConsecutiveWorkingWeekends: type: boolean description: Whether to constrain the maximum consecutive working weekends maximumConsecutiveWorkingWeekends: type: integer format: int32 description: The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work minimumWorkingDaysPerWeek: type: integer format: int32 description: The minimum number of days that agents assigned to a work plan must work per week constrainMaximumConsecutiveWorkingDays: type: boolean description: Whether to constrain the maximum consecutive working days maximumConsecutiveWorkingDays: type: integer format: int32 description: The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true minimumShiftStartDistanceMinutes: type: integer format: int32 description: The time period in minutes for the duration between the start times of two consecutive working days minimumDaysOffPerPlanningPeriod: type: integer format: int32 description: Minimum days off in the planning period maximumDaysOffPerPlanningPeriod: type: integer format: int32 description: Maximum days off in the planning period minimumPaidMinutesPerPlanningPeriod: type: integer format: int32 description: Minimum paid minutes in the planning period maximumPaidMinutesPerPlanningPeriod: type: integer format: int32 description: Maximum paid minutes in the planning period constrainMaximumWorkingWeekendsPerPlanningPeriod: type: boolean description: Whether to constrain the maximum working weekends in the planning period maximumWorkingWeekendsPerPlanningPeriod: type: integer format: int32 description: Maximum working weekends in the planning period optionalDays: description: Optional days to schedule for this work plan $ref: '#/definitions/SetWrapperDayOfWeek' shiftStartVarianceType: type: string description: This constraint ensures that an agent starts each workday within a user-defined time threshold enum: - ShiftStart - ShiftStartAndPaidDuration shiftStartVariancePeriod: type: string description: The length of the period over which the maximum shift start time variance is applied enum: - Weekly - PlanningPeriod shiftStartVariances: description: Variance in minutes among start times of shifts in this work plan $ref: '#/definitions/ListWrapperShiftStartVariance' shifts: type: array description: Shifts in this work plan items: $ref: '#/definitions/WorkPlanShift' agents: type: array description: Agents in this work plan items: $ref: '#/definitions/DeletableUserReference' agentCount: type: integer format: int32 description: Number of agents in this work plan metadata: description: Version metadata for this work plan $ref: '#/definitions/WfmVersionedEntityMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true EstimateAvailablePartialDayTimeOffResponse: type: object required: - date - durationMinutes - flexible - payableMinutes properties: date: type: string format: date-time description: Start date-time in ISO-8601 format for partial day request durationMinutes: type: integer format: int32 description: An estimation of time off request length in minutes payableMinutes: type: integer format: int32 description: An estimation of payable part of time off request in minutes flexible: type: boolean description: Whether there is flexibility for a user to choose different hours than the system estimated overrideDateType: type: string description: The override date type, if the partial day request overlaps with an override date enum: - Blocked - ManualReview BuPlanningGroupHeadcountForecastResult: type: object properties: requiredPerInterval: type: array description: Required headcount per interval, referenced against the reference start date items: type: number format: double requiredWithoutShrinkagePerInterval: type: array description: Required headcount per interval without accounting for shrinkage, referenced against the reference start date items: type: number format: double planningGroup: description: The planning group to which this portion of the headcount forecast applies $ref: '#/definitions/PlanningGroupReference' BuIntradayResponse: type: object properties: startDate: type: string format: date-time description: 'The start of the date range for which this data applies. This is also the start reference point for the intervals represented in the various arrays. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endDate: type: string format: date-time description: 'The end of the date range for which this data applies. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' intervalLengthMinutes: type: integer format: int32 description: The aggregation period in minutes, which determines the interval duration of the returned data noDataReason: type: string description: If not null, the reason there was no data for the request enum: - NoPublishedSchedule - NoSourceForecast categories: type: array description: The categories to which this data corresponds items: type: string enum: - ForecastData - ScheduleData - PerformancePredictionData shortTermForecast: description: Short term forecast reference $ref: '#/definitions/BuShortTermForecastReference' schedule: description: Schedule reference $ref: '#/definitions/BuScheduleReference' intradayDataGroupings: type: array description: Intraday data grouped by a single media type and set of planning group IDs items: $ref: '#/definitions/BuIntradayDataGroup' MoveAgentsRequest: type: object required: - userIds properties: userIds: type: array description: The list of user ids to move uniqueItems: true items: type: string destinationManagementUnitId: type: string description: The id of the management unit for which the move will be performed. To remove users from their management unit this should be set to null. UpdateAlternativeShiftBuSettingsRequest: type: object required: - metadata properties: enabledGranularities: description: The granularity at which alternative shifts is allowed. An empty list as the wrapped value will indicate alternative shifts is disabled $ref: '#/definitions/ListWrapperAlternativeShiftBuSettingsGranularity' minMinutesBeforeStartTime: type: integer format: int32 description: The minimum number of minutes before the start of a shift that an alternative shift can be automatically approved retainedActivityCategories: description: Categories of activities that are required to remain at the same time slot for the alternative shifts offered. An empty list indicates no retained activities $ref: '#/definitions/ListWrapperAlternativeShiftBuSettingsActivityCategory' metadata: description: Version metadata for this business unit's alternative shift settings $ref: '#/definitions/WfmVersionedEntityMetadata' BuForecastStaffingRequirementsResult: type: object required: - downloadUrl - downloadUrlExpirationDate - weekNumber properties: weekNumber: type: integer format: int32 description: The week number represented by this response downloadUrl: type: string description: The url to get the requirements results for this week downloadUrlExpirationDate: type: string format: date-time description: The expiration date of the download url, as an ISO-8601 string planningGroupStaffingRequirements: type: array description: Results will always come via downloadUrl, however the schema is included for documentation items: $ref: '#/definitions/StaffingRequirementsPlanningGroupData' QueryEnrollmentOpportunityResult: type: object required: - activityCodeId - capacity - deadlineDate - endDate - enrollmentCounts - name - startDate - status properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the opportunity activityCodeId: type: string description: The ID of the activity code associated with the opportunity startDate: type: string format: date-time description: The start date and time of the opportunity in ISO-8601 format endDate: type: string format: date-time description: The end date and time of the opportunity in ISO-8601 format deadlineDate: type: string format: date-time description: The deadline date and time for enrollment in the opportunity in ISO-8601 format status: type: string description: The current status of the opportunity enum: - Draft - Published - Open - Pending - Closed capacity: type: integer format: int32 description: The maximum capacity (enrollment slots) for this opportunity enrollmentCounts: description: The counts for enrollment statuses $ref: '#/definitions/PendingAndApprovedOpportunityEnrollmentCounts' SearchUnmatchedShiftTradeListJobResponseItem: type: object required: - trades properties: trades: type: array description: The shift trades that match the search criteria items: $ref: '#/definitions/SearchUnmatchedShiftTradeResponseItem' WfmAgentHistoricalAdherenceResponse: type: object required: - job properties: job: description: A reference to the job that was started by the request $ref: '#/definitions/WfmAgentHistoricalAdherenceJobReference' downloadUrls: type: array description: The url list to GET the results of the agent adherence query. This field is populated only if query state is Complete items: type: string result: description: Results will come via downloadUrls, however it may come inline if small enough $ref: '#/definitions/WfmAgentHistoricalAdherenceResult' PlanningGroup: type: object required: - id properties: id: type: string description: The globally unique identifier for the object. name: type: string serviceGoalTemplate: description: The ID of the service goal template associated with this planning group $ref: '#/definitions/ServiceGoalTemplateReference' routePaths: type: array description: Set of route paths associated with the planning group uniqueItems: true items: $ref: '#/definitions/RoutePathResponse' metadata: description: Version metadata for the planning group $ref: '#/definitions/WfmVersionedEntityMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true BuTimeOffLimitValuesResponse: type: object properties: values: type: array items: $ref: '#/definitions/BuTimeOffLimitValueRange' UpdateServiceGoalTemplate: type: object required: - metadata properties: name: type: string description: The name of the service goal template. serviceLevel: description: Service level targets for this service goal template $ref: '#/definitions/BuServiceLevel' averageSpeedOfAnswer: description: Average speed of answer targets for this service goal template $ref: '#/definitions/BuAverageSpeedOfAnswer' abandonRate: description: Abandon rate targets for this service goal template $ref: '#/definitions/BuAbandonRate' metadata: description: Version metadata for the service goal template $ref: '#/definitions/WfmVersionedEntityMetadata' impactOverride: description: Settings controlling max percent increase and decrease of service goals for this service goal template $ref: '#/definitions/ServiceGoalTemplateImpactOverride' BulkOpportunitiesReferenceResult: type: object required: - opportunity - status properties: status: type: string description: The status indicating the result of the bulk operation for this item enum: - Complete - Error error: description: The error result if the operation failed $ref: '#/definitions/BulkOpportunitiesError' opportunity: description: Reference to the opportunity $ref: '#/definitions/OpportunityReference' AgentBidWorkPlanOverrideRequest: type: object required: - agentId properties: agentId: type: string description: The ID of agent overrideWorkPlanId: type: string description: The ID of the work plan that overrides the assigned work plan for the agent overrideReason: type: string description: The reason for overriding the assigned work plan. This must be null if overrideWorkPlanId is not specified enum: - UnableToBid - ChangeOfCircumstance - NewHire - EmployeeMove WeekScheduleListResponse: type: object properties: entities: type: array items: $ref: '#/definitions/WeekScheduleListItemResponse' ScheduleBidScheduledActivity: type: object required: - activityCategory - activityCodeId - description - lengthMinutes - startDate properties: startDate: type: string format: date-time description: 'The start date/time of this activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' lengthMinutes: type: integer format: int32 description: The length of this activity in minutes description: type: string description: The description of this activity activityCategory: type: string description: The activity code's category enum: - OnQueueWork - Break - Meal - Meeting - OffQueueWork - TimeOff - Training - Unavailable activityCodeId: type: string description: The ID of the activity code associated with this activity paid: type: boolean description: Whether this activity is paid TimeOffRequestNotification: type: object properties: timeOffRequestId: type: string description: The ID of this time off request user: description: The user associated with this time off request $ref: '#/definitions/UserReference' isFullDayRequest: type: boolean description: Whether this is a full day request (false means partial day) status: type: string description: The status of this time off request enum: - PENDING - APPROVED - DENIED - CANCELED partialDayStartDateTimes: type: array description: A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false items: type: string format: date-time fullDayManagementUnitDates: type: array description: A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true items: type: string ListWrapperSecondaryPresence: type: object properties: values: type: array items: $ref: '#/definitions/SecondaryPresence' QueryExternalActivityOpportunityResult: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true opportunityName: type: string description: The name of the opportunity associated with this external activity ImportScheduleUploadResponse: type: object properties: uploadKey: type: string description: The key to pass to the secondary request to start processing of the upload url: type: string description: The url to which to PUT the upload body headers: type: object description: Required headers for the PUT request to the url additionalProperties: type: string uploadBodySchema: description: Always null. Defines the schema of the json body to be PUT to the url. The json body should be gzip encoded before uploading $ref: '#/definitions/ImportScheduleUploadSchema' QueryAgentShiftTradeListJobRequest: type: object required: - weekDates properties: weekDates: type: array description: The start week dates in which to query shift trades in the business unit time zone (yyyy-MM-dd format) uniqueItems: true items: type: string format: date DivisionReference: 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 AgentWorkPlanListResponse: type: object required: - managementUnit properties: entities: type: array items: $ref: '#/definitions/AgentWorkPlan' managementUnit: description: The management unit of the work plans $ref: '#/definitions/ManagementUnitReference' QueryAgentScheduleUnavailableTimesRequest: type: object required: - agentId - schedule properties: agentId: type: string description: The ID of the agent for whom to fetch unavailable times schedule: description: The schedule for which to fetch unavailable times for the agent $ref: '#/definitions/BuScheduleReference' WfmAgentHistoricalAdherenceJobReference: type: object properties: id: type: string description: The ID of the historical adherence job to listen for via notification or query using the jobs route status: type: string description: The status of the historical adherence job enum: - Processing - Complete - Error selfUri: type: string format: uri description: The URI for this object readOnly: true UpdateActivityCodeRequest: type: object required: - metadata properties: name: type: string description: The name of the activity code category: type: string description: The activity code's category. Attempting to change the category of a default activity code will return an error enum: - OnQueueWork - Break - Meal - Meeting - OffQueueWork - TimeOff - Training - Unavailable lengthInMinutes: type: integer format: int32 description: The default length of the activity in minutes countsAsPaidTime: type: boolean description: Whether an agent is paid while performing this activity countsAsWorkTime: type: boolean description: Indicates whether or not the activity should be counted as work time agentTimeOffSelectable: type: boolean description: Whether an agent can select this activity code when creating or editing a time off request countsTowardShrinkage: type: boolean description: Whether or not this activity code counts toward shrinkage calculations plannedShrinkage: type: boolean description: Whether this activity code is considered planned or unplanned shrinkage interruptible: type: boolean description: Whether this activity code is considered interruptible planningGroupIds: description: The planning group IDs associated with this activity code $ref: '#/definitions/ListWrapperString' metadata: description: Version metadata for the associated business unit's list of activity codes $ref: '#/definitions/WfmVersionedEntityMetadata' secondaryPresences: description: The secondary presences of this activity code $ref: '#/definitions/ListWrapperSecondaryPresence' BuAgentScheduleHistoryResponse: type: object properties: priorPublishedSchedules: type: array description: The list of previously published schedules items: $ref: '#/definitions/BuScheduleReference' basePublishedSchedule: description: The originally published agent schedules $ref: '#/definitions/BuAgentScheduleHistoryChange' droppedChanges: type: array description: The changes dropped from the schedule history. This will happen if the schedule history is too large items: $ref: '#/definitions/BuAgentScheduleHistoryDroppedChange' changes: type: array description: The list of changes for the schedule history items: $ref: '#/definitions/BuAgentScheduleHistoryChange' AgentCountRange: type: object required: - maximum - minimum properties: minimum: type: integer format: int32 description: The minimum value of agent count per work plan maximum: type: integer format: int32 description: The maximum value of agent count per work plan UserNextActivityReminder: type: object properties: activityCategory: type: string description: Upcoming activity for which the user is scheduled readOnly: true enum: - OnQueueWork - Break - Meal - Meeting - OffQueueWork - TimeOff - Training - Unavailable - Unscheduled startDate: type: string format: date-time description: The start timestamp of the scheduled activity in ISO-8601 format readOnly: true IntradayPlanningGroupRequest: type: object required: - businessUnitDate - categories properties: businessUnitDate: type: string format: date description: 'Requested date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' categories: type: array description: The metric categories items: type: string enum: - ForecastData - ScheduleData - PerformancePredictionData planningGroupIds: type: array description: The IDs of the planning groups for which to fetch data. Omitting or passing an empty list will return all available planning groups items: type: string intervalLengthMinutes: type: integer format: int32 description: The period/interval in minutes for which to aggregate the data. Required, defaults to 15 ScheduleReferenceWithBusinessUnit: type: object required: - businessUnit - id - weekDate properties: id: type: string description: The globally unique identifier for the object. weekDate: type: string format: date description: 'The start date for this schedule in the business unit time zone (yyyy-MM-dd format). Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' businessUnit: description: The reference of the associated business unit $ref: '#/definitions/BusinessUnitReference' selfUri: type: string format: uri description: The URI for this object readOnly: true ForecastPlanningGroupResponse: type: object properties: id: type: string description: The ID of the planning group name: type: string description: The name of the planning group routePaths: type: array description: Route path configuration for this planning group items: $ref: '#/definitions/RoutePathResponse' serviceGoalTemplate: description: Service goals for this planning group $ref: '#/definitions/ForecastServiceGoalTemplateResponse' HrisTimeOffType: type: object required: - hrisIntegrationId - id - name properties: id: type: string description: The ID of the time off type configured in integration. name: type: string description: The name of the time off type configured in integration. hrisIntegrationId: type: string description: The ID of the integration. secondaryId: type: string description: Secondary ID of the time off type, if configured in integration. PerformancePredictionResponse: type: object required: - id - scheduleId - state - weekDate properties: id: type: string description: The globally unique identifier for the object. weekDate: type: string format: date description: 'The weekDate of the short term forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' scheduleId: type: string description: The ID of the schedule this performance prediction is associated with downloadUrl: type: string description: The url to GET the results of the performance prediction. This field is populated only if query state is 'Complete' downloadResult: description: Result will always come via downloadUrls; however the schema is included for documentation $ref: '#/definitions/PerformancePredictionOutputs' state: type: string description: The state of the performance prediction enum: - Processing - Complete - Error selfUri: type: string format: uri description: The URI for this object readOnly: true CapacityPlanStaffingGroupMetricChangeResponse: type: object required: - createdBy - createdDate - metric - numberOfWeeks - staffingGroups - value - version - weekStartNumber properties: numberOfWeeks: type: integer format: int32 description: The number of weeks to which the metric change applies weekStartNumber: type: integer format: int32 description: The start number of the week (starting from 1) to which the metric change applies, related to numberOfWeeks value: type: number format: double description: The value of the metric metric: type: string description: The metric which is going to be modified for the selected staffing groups enum: - StartingWeeklyFullTimeEquivalentCount - NewHiresFullTimeEquivalentCount - AttritionPercentage - ShrinkagePercentage - TransfersFullTimeEquivalentCount - ExtraTimeUnderTimeFullTimeEquivalentCount notes: type: string description: Notes about the staffing groups metric changes transfersFullTimeEquivalent: description: Full time equivalent transfer from one staffing group to another $ref: '#/definitions/TransfersFullTimeEquivalent' staffingGroups: type: array description: The staffing groups affected by the metric change items: $ref: '#/definitions/StaffingGroupReference' createdBy: description: The user who created the metric change $ref: '#/definitions/UserReference' createdDate: type: string format: date-time description: The date the entity was created, in ISO-8601 format version: type: integer format: int32 description: The version of the capacity plan WorkPlanConfigurationViolationMessage: type: object properties: type: type: string description: Type of configuration violation message for this work plan enum: - ActivitiesOverlap - ActivityEndGreaterThanShiftStop - ActivityPaidTimeGreaterThanShiftPaidTime - ActivityStartBeforeShiftStart - ActivityStartGreaterThanEqualToShiftStop - ActivityStartIncrementMinutesNotDivisibleByScheduleIntervalMinutes - DailyExactPaidMinutes - DailyMaxTotalLessThanWeeklyMin - DailyMaxTotalLessThanWeeklyMinWithOptional - DailyMaxTotalLessThanWeeklyMinWithoutOptional - DailyMinTotalGreaterThanWeeklyMax - DailyMinTotalGreaterThanWeeklyMaxWithOptional - DailyMinTotalGreaterThanWeeklyMaxWithoutOptional - DailyRequiredDaysGreaterThanWeeklyMaxDays - DailyShiftHasNoDaysSelected - DailyShiftMaxPossibilitiesViolated - EarliestShiftStopIsTooLate - ExactPaidTimeNotDivisibleByGranularity - MaxConsecutiveWorkingDaysNoMoreThanDoubleMaxWorkingDaysPerWeek - MaxDaysOffPerPlanningPeriodNotCorrect - MaxPaidTimeIsMoreThanShiftLength - MaxPaidTimeNotDivisibleByGranularity - MaxPaidTimePerMonthlyPlanningPeriod - MaxPaidTimePerPlanningPeriod - MaxShifts - MinPaidTimeNotDivisibleByGranularity - MinPaidTimePerMonthlyPlanningPeriod - MinPaidTimePerPlanningPeriod - NoShifts - PaidTimeGreaterThanMaxWorkTime - PaidTimeLessThanMinWorkTime - PaidTimeNotMetByShiftStartStop - PlanningPeriodMaxWorkingWeekendsCannotBeMet - ShiftDaysSelectMoreThanMinWorkingDays - ShiftStopEarlierThanStart - ShiftMaxCountPerPlanningPeriodCannotBeMet - ShiftMinCountPerPlanningPeriodCannotBeMet - ShiftVarianceCannotBeMet - WeeklyExactPaidMinutes arguments: type: array description: Arguments of the message that provide information about the misconfigured value or the threshold that is exceeded by the misconfigured value items: $ref: '#/definitions/WorkPlanValidationMessageArgument' severity: type: string description: Severity of the message. A message with Error severity indicates the scheduler won't be able to produce schedules and thus the work plan is invalid. enum: - Information - Warning - Error BidGroupWorkPlanRotationResponse: type: object required: - agentCount - id - managementUnit properties: id: type: string description: The globally unique identifier for the object. managementUnit: description: The management unit to which the work plan rotation belongs $ref: '#/definitions/ManagementUnitReference' agentCount: type: integer format: int32 description: The count of agents that can be assigned to this work plan rotation selfUri: type: string format: uri description: The URI for this object readOnly: true SecondaryPresence: type: object required: - id 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 ListWrapperFixedAvailability: type: object properties: values: type: array items: $ref: '#/definitions/FixedAvailability' UserScheduleActivity: type: object properties: activityCodeId: type: string description: The id for the activity code. Look up a map of activity codes with the activities route startDate: type: string format: date-time description: Start time in UTC for this activity, in ISO-8601 format lengthInMinutes: type: integer format: int32 description: Length in minutes for this activity description: type: string description: Description for this activity countsAsPaidTime: type: boolean description: Whether this activity is paid isDstFallback: type: boolean description: Whether this activity spans a DST fallback timeOffRequestId: type: string description: Time off request id of this activity UserScheduleFullDayTimeOffMarker: type: object properties: managementUnitDate: type: string description: The date associated with the time off request that this marker corresponds to. Date only, in ISO-8601 format. activityCodeId: type: string description: The id for the activity code. Look up a map of activity codes with the activities route isPaid: type: boolean description: Whether this is paid time off lengthInMinutes: type: integer format: int32 description: The length in minutes of this time off marker description: type: string description: The description associated with the time off request that this marker corresponds to delete: type: boolean description: If marked true for updating an existing full day time off marker, it will be deleted BuSchedulerSettingsResponse: type: object required: - consistentServiceLevelSmoothing - metadata properties: consistentServiceLevelSmoothing: type: boolean description: Indicates whether to provide consistent service level smoothing in schedule generation for this business unit metadata: description: Version metadata for this business unit's scheduler settings $ref: '#/definitions/WfmVersionedEntityMetadata' ShiftTradeQueryAgentTradesJobResponse: type: object required: - id - status - type properties: id: type: string description: The globally unique identifier for the object. status: type: string description: The status of the job enum: - Processing - Complete - Canceled - Error type: type: string description: The type of the job enum: - AddTrade - BulkUpdateTradeStates - EvaluateTrades - MatchTrade - QueryAgentTrades - QueryTrades - QueryWeekSummaries - SearchUnmatchedTrades - UpdateTrade - UpdateTradeState downloadUrl: type: string description: The URL where completed results might be available for download in case the result body for that job type is too large error: description: Any error information, only set if the status == 'Error' $ref: '#/definitions/ErrorBody' queryAgentTradesResult: description: Results for QueryAgentTrades job type $ref: '#/definitions/ShiftTradeListJobResponse' selfUri: type: string format: uri description: The URI for this object readOnly: true BuShortTermForecastListing: type: object properties: entities: type: array items: $ref: '#/definitions/BuShortTermForecastListItem' UpdateMuAgentWorkPlanFailureResponse: type: object required: - failure - user properties: user: description: The user for whom the work plan update has failed $ref: '#/definitions/UserReference' failure: type: string description: The work plan update failure reason enum: - AgentNotInManagementUnit - OverlappingOverride - OverrideNotFound - TooManyOverrides - WorkPlanNotFound notFoundWorkPlanId: type: string description: The id of the work plan that has not been found ReceivingScheduleLookup: type: object required: - id properties: id: type: string description: The ID of the schedule TimeOffIntegrationStatusResponseListing: type: object properties: entities: type: array items: $ref: '#/definitions/TimeOffIntegrationStatusResponse' BuSearchAgentSchedulesRequest: type: object required: - endDate - startDate properties: startDate: type: string format: date-time description: 'Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endDate: type: string format: date-time description: 'End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' userIds: type: array description: IDs of the users for whose schedules to search items: type: string AgentIntegrationsRequest: type: object required: - associatedIntegrations properties: selectedIntegrationId: type: string description: The ID of the integration selected for the agent. If not set, no integration will be used for the agent associatedIntegrations: type: array description: The list of integrations associated with the agent items: $ref: '#/definitions/AgentIntegrationAssociationRequest' BuScheduleReferenceForMuRoute: type: object properties: id: type: string description: The ID of the schedule weekDate: type: string format: date description: 'The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' businessUnit: description: The start week date for this schedule $ref: '#/definitions/BusinessUnitReference' selfUri: type: string format: uri description: The URI for this object readOnly: true UpdateMuAgentRequest: type: object required: - userId properties: schedulable: type: boolean description: Whether the agent can be included in schedule generation userId: type: string description: User to be updated RecurrenceEndSettings: type: object properties: lastDate: type: string format: date-time description: The end date of the recurrence for the activity plan, in ISO-8601 format. Only one of lastDate or noEndDate may be set noEndDate: type: boolean description: Whether this activity plan should continue indefinitely. If set to true, lastDate must not be set ActivityCodeReference: type: object required: - id 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 QueryAvailabilityManagementUnitsSettingsResponse: type: object required: - managementUnits properties: managementUnits: type: array description: List of unavailable times settings, per management unit items: $ref: '#/definitions/UnavailableTimesManagementUnitSettings' BulkUpdateShiftTradeStateResult: type: object properties: entities: type: array items: $ref: '#/definitions/BulkUpdateShiftTradeStateResultItem' AgentAddOpportunityEnrollment: type: object required: - opportunityId properties: opportunityId: type: string description: The ID of the opportunity in which to enroll the agent TimeOffPlanManagementUnitAssociation: type: object required: - managementUnit properties: managementUnit: description: Management unit to which this time-off plan belongs $ref: '#/definitions/ManagementUnitReference' staffingGroups: type: array description: Staffing groups to which this time-off plan applies. If not defined, the plan applies to the management unit uniqueItems: true items: $ref: '#/definitions/StaffingGroupReference' UserTimeOffIntegrationStatusResponse: type: object required: - integrationStatus - timeOffRequest - user properties: timeOffRequest: description: The time off request associated with this integration status $ref: '#/definitions/TimeOffRequestReference' integrationStatus: type: string description: The value of integration status for the time off request enum: - Processing - Error - AutomaticallyComplete - ManuallyComplete user: description: The user to whom the time off request belongs $ref: '#/definitions/UserReference' PerformancePredictionRecalculationUploadResponse: type: object properties: uploadKey: type: string description: The key to pass to the secondary request to start processing of the upload url: type: string description: The url to which to PUT the upload body headers: type: object description: Required headers for the PUT request to the url additionalProperties: type: string uploadBodySchema: description: Always null. Defines the schema of the json body to be PUT to the url. The json body should be gzip encoded before uploading $ref: '#/definitions/PerformancePredictionUploadSchema' BuTimeOffLimitValueRange: type: object required: - allocatedMinutesPerInterval - granularity - id - limitMinutesPerInterval - metadata - startDate - timeOffLimit - waitlistedMinutesPerInterval - waitlistedRequestsPerInterval properties: id: type: string description: The globally unique identifier for the object. timeOffLimit: description: The ID of the time-off limit $ref: '#/definitions/BuTimeOffLimitReference' startDate: type: string format: date description: Start date of the requested date range, in ISO-8601 format. The end date is determined by the size of interval lists granularity: type: string description: Granularity choice for time-off limit enum: - Daily - FifteenMinutes limitMinutesPerInterval: type: array description: A list of time-off limit values in minutes per granularity interval items: type: integer format: int32 allocatedMinutesPerInterval: type: array description: A list of allocated time-off minutes per granularity interval items: type: integer format: int32 waitlistedMinutesPerInterval: type: array description: A list of waitlisted time-off minutes per granularity interval items: type: integer format: int32 waitlistedRequestsPerInterval: type: array description: The current number of waitlisted time-off requests for every interval per granularity items: type: integer format: int32 metadata: description: Version metadata for the time-off limit $ref: '#/definitions/WfmVersionedEntityMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true ShiftTradeWeekSummaryResponseItem: type: object required: - crossWeekReceivingMatchedCount - initiatingMatchedCount - weekDate properties: weekDate: type: string format: date description: 'The schedule week date in the business unit time zone (yyyy-MM-dd format). Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' initiatingMatchedCount: type: integer format: int32 description: The number of trades in the 'Matched' state with the initiating shift in the given week crossWeekReceivingMatchedCount: type: integer format: int32 description: The number of cross-week trades in the 'Matched' state with the receiving shift for the given week ListWrapperScheduleSetRequest: type: object properties: values: type: array items: $ref: '#/definitions/ScheduleSetRequest' RequiredLocalDateRange: type: object required: - endDate - startDate properties: startDate: type: string format: date description: 'The inclusive start of a date range in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' endDate: type: string format: date description: 'The inclusive end of a date range in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' 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 AdminBulkUpdateAlternativeShiftTradeState: type: object required: - metadata - state - tradeId properties: tradeId: type: string description: The ID of the trade for this alternative shift trade state: type: string description: The new alternative shift trade state enum: - Approved - Denied metadata: description: Version metadata for this alternative shift trade $ref: '#/definitions/WfmVersionedEntityMetadata' HistoricalAdherenceExceptionInfo: type: object properties: startOffsetSeconds: type: integer format: int32 description: Exception start offset in seconds relative to query start time endOffsetSeconds: type: integer format: int32 description: Exception end offset in seconds relative to query start time scheduledActivityCodeId: type: string description: The ID of the scheduled activity code for this user scheduledActivityCategory: type: string description: Activity for which the user is scheduled enum: - OnQueueWork - Break - Meal - Meeting - OffQueueWork - TimeOff - Training - Unavailable - Unscheduled scheduledSecondaryPresenceLookupIds: type: array description: The lookup IDs used to retrieve the scheduled secondary statuses from map of lookup ID to corresponding secondary presence ID uniqueItems: true items: type: string actualActivityCodeId: type: string description: The ID of the actual activity code for this user actualActivityCategory: type: string description: Activity for which the user is actually engaged enum: - OnQueueWork - Break - Meal - Meeting - OffQueueWork - TimeOff - Training - Unavailable - Unscheduled systemPresence: type: string description: Actual underlying system presence value enum: - Available - Away - Busy - Offline - Idle - OnQueue - Meal - Training - Meeting - Break routingStatus: type: string description: Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue enum: - OFF_QUEUE - IDLE - INTERACTING - NOT_RESPONDING - COMMUNICATING impact: type: string description: The impact of the current adherence state for this user enum: - Positive - Negative - Neutral - Unknown secondaryPresenceLookupId: type: string description: The lookup ID used to retrieve the actual secondary status from map of lookup ID to corresponding secondary presence ID QueryOpportunityEnrollmentsResult: type: object required: - enrollments properties: nextStartDate: type: string format: date-time description: The start date to use for the next query to retrieve additional results in ISO-8601 format. Null if there are no more results enrollments: type: array description: The enrollments for the query operation items: $ref: '#/definitions/QueryOpportunityEnrollmentResult' opportunities: type: array description: The referenced opportunities when expand=opportunities is specified items: $ref: '#/definitions/QueryEnrollmentOpportunityResult' UpdateAdherenceExplanationStatusRequest: type: object properties: status: type: string description: The status of the adherence explanation enum: - Pending - Approved - Denied ShiftTradeNotification: type: object properties: weekDate: type: string description: The start week date of the initiating shift of the shift trade in yyyy-MM-dd format tradeId: type: string description: The ID of the shift trade oneSided: type: boolean description: Whether this is a one sided shift trade newState: type: string description: The new state of the shift trade, null if there was no change enum: - Unmatched - Matched - Approved - Denied - Expired - Canceled initiatingUser: description: The user who initiated the shift trade $ref: '#/definitions/UserReference' initiatingShiftDate: type: string format: date-time description: 'The start date and time of the initiating shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' receivingUser: description: The user on the receiving side of this shift trade (null if not matched) $ref: '#/definitions/UserReference' receivingShiftDate: type: string format: date-time description: 'The start date and time of the receiving shift (null if not matched or if one-sided. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' WeekScheduleGenerationResult: type: object properties: failed: type: boolean description: Whether the schedule generation failed runId: type: string description: ID of the schedule run agentWarnings: type: array description: Warning messages from the schedule run. This will be available only when requesting information for a single week schedule items: $ref: '#/definitions/ScheduleGenerationWarning' agentWarningCount: type: integer format: int32 description: Count of warning messages from the schedule run. This will be available only when requesting multiple week schedules SchedulingPeriod: type: object required: - earliestStartDate - latestEndDate properties: latestEndDate: type: string format: date description: 'The latest date the associated activity plan can end, in YYYY-MM-DD format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' earliestStartDate: type: string format: date description: 'The earliest date the associated activity plan can begin, in YYYY-MM-DD format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' ServiceGoalTemplateReference: type: object required: - id 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 ActivityPlanAsaImpactOverride: type: object required: - increaseByPercent properties: increaseByPercent: type: number format: double description: Allowed average speed of answer increase percent, from 0.0 to 100.0 CapacityPlanRequest: type: object required: - endBusinessUnitDate - forecast - fullTimeEquivalentWeeklyHours - name - staffingGroupAllocations - startBusinessUnitDate properties: name: type: string description: The name of the capacity plan description: type: string description: Description of the capacity plan startBusinessUnitDate: type: string format: date description: 'The start date for the capacity plan relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' endBusinessUnitDate: type: string format: date description: 'The end date for the capacity plan relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' forecast: description: The selected forecast for this capacity plan. Null when main forecast is used in the future $ref: '#/definitions/BuShortTermForecastReference' fullTimeEquivalentWeeklyHours: type: number format: double description: The weekly hours used to calculate full time equivalent agents staffingGroupAllocations: type: array description: List of staffing group allocations to be used for the capacity plan items: $ref: '#/definitions/CreateStaffingGroupAllocation' CreatePlanningGroupRequest: type: object required: - name - routePaths - serviceGoalTemplateId properties: name: type: string description: The name of the planning group routePaths: type: array description: Set of route paths to associate with the planning group uniqueItems: true items: $ref: '#/definitions/RoutePathRequest' serviceGoalTemplateId: type: string description: The ID of the service goal template to associate with this planning group WfmHistoricalShrinkageRequest: type: object required: - startDate properties: startDate: type: string format: date-time description: Beginning of the date range to query in ISO-8601 format endDate: type: string format: date-time description: End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time timeZone: type: string description: The time zone, in olson format, to use in defining days when computing shrinkage for requested granularity. If it is not set, the business unit time zone will be used. The results will be returned as UTC timestamps regardless of the time zone input. granularity: type: string description: Shrinkage aggregation interval granularity. enum: - Daily - Weekly HrisTimeOffTypesResponse: type: object properties: job: description: The asynchronous job handling the query $ref: '#/definitions/HrisTimeOffTypesJobReference' entities: type: array description: List of time off types. It is available only via notification items: $ref: '#/definitions/HrisTimeOffTypeResponse' CapacityPlanForecastInputsResponse: type: object required: - businessUnit - capacityPlan - downloadUrl properties: businessUnit: description: The business unit to which the capacity plan forecast inputs belongs $ref: '#/definitions/BusinessUnitReference' capacityPlan: description: The capacity plan associated with these forecast inputs $ref: '#/definitions/CapacityPlanReference' downloadUrl: type: string description: The URL to get the forecast inputs for the capacity plan downloadTemplate: description: Forecast inputs always come through downloadUrl, the schema included here is just for documentation $ref: '#/definitions/CapacityPlanForecastInputsTemplate' MinimumStaffingResponse: type: object required: - applicableIntervals - enabled - metadata - minimumValue - planningGroupOverrides properties: enabled: type: boolean description: Whether the setting is turned on or off minimumValue: type: number format: double description: Default minimum staff value to be applied to all planning groups planningGroupOverrides: type: array description: List of planning groups with their minimum staff value overrides and the days to which the overrides apply items: $ref: '#/definitions/PlanningGroupMinimumsResponse' applicableIntervals: type: string description: The intervals to which the minimum staff values will apply enum: - AllIntervals - VolumeOnlyIntervals metadata: description: Metadata for the business unit's minimum staffing settings $ref: '#/definitions/WfmVersionedEntityMetadata' AvailableTimeOffResponse: type: object properties: values: type: array items: $ref: '#/definitions/AvailableTimeOffRange' WfmHistoricalAdherenceBulkUserDayMetrics: type: object properties: dayStartOffsetSeconds: type: integer format: int32 description: Start of day offset in seconds relative to query start time adherenceScheduleSeconds: type: integer format: int32 description: Duration of schedule in seconds included for adherence percentage calculation conformanceScheduleSeconds: type: integer format: int32 description: Total scheduled duration in seconds for OnQueue activities conformanceActualSeconds: type: integer format: int32 description: Total actually worked duration in seconds for OnQueue activities exceptionCount: type: integer format: int32 description: Total number of adherence exceptions for this user exceptionDurationSeconds: type: integer format: int32 description: Total duration in seconds of adherence exceptions for this user impactSeconds: type: integer format: int32 description: The impact duration in seconds of current adherence state for this user scheduleLengthSeconds: type: integer format: int32 description: Total duration in seconds for all scheduled activities actualLengthSeconds: type: integer format: int32 description: Total duration in seconds for all actually worked activities adherencePercentage: type: number format: double description: Total adherence percentage for this user, in the scale of 0 - 100 conformancePercentage: type: number format: double description: Total conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on-queue time is greater than the scheduled on-queue time for the same period. QueryOpportunityEnrollmentsRequest: type: object properties: range: description: The date range for the query. Exactly one of opportunityId or range must be set $ref: '#/definitions/RequiredDateRange' opportunityId: type: string description: The ID of the specific opportunity by which to filter. Exactly one of opportunityId or range must be set UpdateCapacityPlanRequest: type: object required: - metadata properties: name: type: string description: The name of the capacity plan description: type: string description: Description of the capacity plan startBusinessUnitDate: type: string format: date description: 'The start date for the capacity plan relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' endBusinessUnitDate: type: string format: date description: 'The end date for the capacity plan relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' forecast: description: The selected forecast for this capacity plan $ref: '#/definitions/ValueWrapperBuShortTermForecastReference' fullTimeEquivalentWeeklyHours: type: number format: double description: The weekly hours used to calculate full time equivalent agents useLatestPlanningGroupStaffingGroupAssociation: type: boolean description: Whether to use latest staffing group to planning group association metadata: description: The metadata of this capacity plan $ref: '#/definitions/CapacityPlanMetadata' CreateManagementUnitApiRequest: type: object required: - businessUnitId - name properties: name: type: string description: The name of the management unit timeZone: type: string description: The default time zone to use for this management unit. Moving to Business Unit startDayOfWeek: type: string description: The configured first day of the week for scheduling and forecasting purposes. Moving to Business Unit enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday settings: description: The configuration for the management unit. If omitted, reasonable defaults will be assigned $ref: '#/definitions/CreateManagementUnitSettingsRequest' divisionId: type: string description: The id of the division to which this management unit belongs. Defaults to home division ID businessUnitId: type: string description: The id of the business unit to which this management unit belongs CreateTimeOffPlanBusinessUnitAssociation: type: object properties: managementUnitIds: type: array description: The IDs of management units to which this time-off plan applies. This must not be set if staffingGroupIds is populated uniqueItems: true items: type: string staffingGroupIds: type: array description: The IDs of staffing groups to which this time-off plan applies. This must not be set if managementUnitIds is populated uniqueItems: true items: type: string HistoricalDataJobEntityStatus: type: object properties: id: type: string description: The Job Id Request readOnly: true state: type: string description: Property denoting the status of the delete job enum: - Processing - Complete - Error selfUri: type: string format: uri description: The URI for this object readOnly: true WfmServiceGoalImpact: type: object required: - decreaseByPercent - increaseByPercent properties: increaseByPercent: type: number format: double description: The maximum allowed percent increase from the configured goal decreaseByPercent: type: number format: double description: The maximum allowed percent decrease from the configured goal BulkUpdateShiftTradeStateResponse: type: object properties: status: type: string description: The status of the operation enum: - Processing - Complete - Canceled - Error operationId: type: string description: The ID for the operation result: description: The result of the operation. Null unless status == Complete $ref: '#/definitions/BulkUpdateShiftTradeStateResult' ListWrapperAlternativeShiftBuSettingsGranularity: type: object properties: values: type: array items: type: string enum: - Daily WorkPlanBidMetadata: type: object required: - createdBy - createdDate properties: createdBy: description: The user who created the associated entity $ref: '#/definitions/UserReference' createdDate: type: string format: date-time description: 'The date the entity created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' modifiedBy: description: The user who modified the entity. The id may be 'System' if it was an automated process $ref: '#/definitions/UserReference' modifiedDate: type: string format: date-time description: 'The entity last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' AgentQueryOpportunitiesResponse: type: object properties: result: description: The query result. Null if downloadUrl is populated $ref: '#/definitions/AgentQueryOpportunities' downloadUrl: type: string description: The URL used to retrieve large datasets. If present, the response conforms to the schema for the result field LongTermRequirementsResponse: type: object required: - status properties: status: type: string description: Status of the long term forecast enum: - Processing - Complete - Canceled - Error errorCode: type: string description: Error code when status is Failed enum: - TimedOut - NoData - ClientDataInvalid - ConfigurationInvalid - RequirementsFailed longTermRequirements: description: For schema documentation only, always null, schema for staffing forecast result at downloadUrl $ref: '#/definitions/LongTermRequirements' downloadUrl: type: string description: Download URL for the staffing forecast result CreateManagementUnitSettingsRequest: type: object properties: adherence: description: Adherence settings for this management unit $ref: '#/definitions/AdherenceSettings' shortTermForecasting: description: Short term forecasting settings for this management unit. Moving to Business Unit $ref: '#/definitions/ShortTermForecastingSettings' timeOff: description: Time off request settings for this management unit $ref: '#/definitions/TimeOffSettingsRequest' scheduling: description: Scheduling settings for this management unit $ref: '#/definitions/SchedulingSettingsRequest' shiftTrading: description: Shift trade settings for this management unit $ref: '#/definitions/ShiftTradeSettings' NotificationsResponse: type: object properties: entities: type: array items: $ref: '#/definitions/WfmUserNotification' WfmHistoricalAdherenceResponse: type: object properties: id: type: string description: The query ID to listen for downloadUrl: type: string description: Deprecated. Use downloadUrls instead. downloadResult: description: Result will always come via downloadUrls; however the schema is included for documentation $ref: '#/definitions/WfmHistoricalAdherenceResultWrapper' downloadUrls: type: array description: The uri list to GET the results of the Historical Adherence query. For notification purposes only items: type: string queryState: type: string description: The state of the adherence query enum: - Processing - Complete - Error AgentIntegrationsResponse: type: object required: - agent - associatedIntegrations properties: agent: description: The user associated with the integrations $ref: '#/definitions/UserReference' selectedIntegration: description: The integration selected for the agent. If not set, no integration will be used for the agent $ref: '#/definitions/WfmIntegrationReference' userSelected: type: boolean description: Whether the integration association has been manually selected associatedIntegrations: type: array description: The list of integrations associated with the agent items: $ref: '#/definitions/AgentIntegrationAssociationResponse' ValidateAgentUnavailableTimesRequest: type: object required: - unavailableTimes - validationWeekDate properties: validationWeekDate: type: string format: date description: 'The ID of the week to validate. Must correspond to the start day of week of the business unit to which the agent belongs in the format YYYY-MM-dd. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' unavailableTimes: type: array description: Proposed changes to agent's unavailable time spans to be validated items: $ref: '#/definitions/UpdateUnavailableTime' TimeOffLimitListing: type: object properties: entities: type: array items: $ref: '#/definitions/TimeOffLimit' ScheduleBidListResponse: type: object properties: entities: type: array items: $ref: '#/definitions/ScheduleBid' BuTimeOffLimitResponse: type: object required: - id - metadata properties: id: type: string description: The globally unique identifier for the object. staffingGroup: description: The staffing group to which this time-off limit is associated. If managementUnit is set, then the staffing group belongs to that management unit.Otherwise, if managementUnit is not set, it is a business unit level staffing group.At least one of managementUnit and staffingGroup must be set $ref: '#/definitions/StaffingGroupReference' managementUnit: description: The management unit to which this time-off limit is associated. If staffingGroup is set, then the limit is associated with that staffing group, which belongs to this management unit.At least one of managementUnit and staffingGroup must be set $ref: '#/definitions/ManagementUnitReference' metadata: description: Version metadata for the time-off limit $ref: '#/definitions/WfmVersionedEntityMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true ScheduleSetRequest: type: object required: - scheduleSetId properties: scheduleSetId: type: string description: The ID of the schedule set overrideAgentCount: type: integer format: int32 description: The overridden agent count for the schedule set WfmHistoricalAdherenceBulkUserResult: type: object properties: userId: type: string description: The ID of the user for whom the adherence is queried adherencePercentage: type: number format: double description: Adherence percentage for this user, in the scale of 0 - 100 conformancePercentage: type: number format: double description: Conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on-queue time is greater than the scheduled on-queue time for the same period. impact: type: string description: The impact of the current adherence state for this user enum: - Positive - Negative - Neutral - Unknown exceptionInfo: type: array description: List of adherence exceptions for this user items: $ref: '#/definitions/HistoricalAdherenceExceptionInfo' actuals: type: array description: List of adherence actuals for this user items: $ref: '#/definitions/HistoricalAdherenceActuals' dayMetrics: type: array description: Adherence and conformance metrics for days in query range items: $ref: '#/definitions/WfmHistoricalAdherenceBulkUserDayMetrics' DeletableUserReference: type: object properties: id: type: string description: The globally unique identifier for the object. delete: type: boolean description: If marked true, the user will be removed an associated entity selfUri: type: string format: uri description: The URI for this object readOnly: true RecurrenceSettings: type: object required: - endAfter - minimumTimeBetweenOccurrences - recurrencePeriod properties: endAfter: description: Settings controlling when to end the recurrence for the activity plan $ref: '#/definitions/RecurrenceEndSettings' recurrencePeriod: description: The recurrence period of the activity plan $ref: '#/definitions/RecurrencePeriod' minimumTimeBetweenOccurrences: description: Constraint indicating the minimum time in hours between recurrences of the activity plan $ref: '#/definitions/RecurrencePeriod' MonthlyPlanningPeriodSettings: type: object required: - startDate properties: startDate: type: string format: date description: 'Start date of the monthly planning period in yyyy-MM-dd format. The date must represent the first day of the given month. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' AdminAgentWorkPlanPreferenceResponse: type: object required: - agentWorkPlanBidPreferences - id - workPlans properties: id: type: string description: The globally unique identifier for the object. workPlans: type: array description: The list of work plans that belong to this bid group items: $ref: '#/definitions/WorkPlanReference' agentWorkPlanBidPreferences: type: array description: The list of agents work plan bidding preferences items: $ref: '#/definitions/AdminAgentWorkPlanBiddingPreference' selfUri: type: string format: uri description: The URI for this object readOnly: true AlternativeShiftSearchOffersRequest: type: object required: - initiatingShift - queryWeekDate - schedule properties: schedule: description: The existing schedule being used to find alternative shift offers $ref: '#/definitions/AlternativeShiftScheduleLookup' queryWeekDate: type: string format: date description: 'The start date for the week in this schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' initiatingShift: description: The shift a user puts up for alternative shift offers $ref: '#/definitions/InitiatingAlternativeShift' acceptableIntervals: type: array description: 'The acceptable intervals in offers. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss' items: type: string format: interval description: 'Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss' BuCurrentAgentScheduleSearchResponse: type: object properties: agentSchedules: type: array description: The requested agent schedules items: $ref: '#/definitions/BuAgentScheduleSearchResponse' businessUnitTimeZone: type: string description: The time zone configured for the business unit to which this schedule applies publishedSchedules: type: array description: References to all published week schedules overlapping the start/end date query parameters items: $ref: '#/definitions/BuAgentSchedulePublishedScheduleReference' startDate: type: string format: date-time description: 'The start date of the schedules. Only populated on notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endDate: type: string format: date-time description: 'The end date of the schedules. Only populated on notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' updates: type: array description: The list of updates for the schedule. Only used in notifications items: $ref: '#/definitions/BuAgentScheduleUpdate' ShiftTradeListResponse: type: object properties: entities: type: array items: $ref: '#/definitions/ShiftTradeResponse' OpportunitiesResultWithPagination: type: object required: - opportunities properties: nextStartDate: type: string format: date-time description: The start date to use for the next query to retrieve additional results in ISO-8601 format. Null if there are no more results opportunities: type: array description: The list of opportunities items: $ref: '#/definitions/OpportunityResult' WfmUserNotification: type: object required: - id - markedAsRead - mutableGroupId properties: id: type: string description: The immutable globally unique identifier for the object. mutableGroupId: type: string description: The group ID of the notification (mutable, may change on update) timestamp: type: string format: date-time description: 'The timestamp for this notification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true type: type: string description: The type of this notification readOnly: true enum: - AdherenceExplanation - ShiftTrade - TimeOffRequest - AlternativeShift shiftTrade: description: A shift trade notification. Only set if type == ShiftTrade readOnly: true $ref: '#/definitions/ShiftTradeNotification' timeOffRequest: description: A time off request notification. Only set if type == TimeOffRequest readOnly: true $ref: '#/definitions/TimeOffRequestNotification' adherenceExplanation: description: An adherence explanation notification. Only set if type == AdherenceExplanation readOnly: true $ref: '#/definitions/AdherenceExplanationNotification' alternativeShift: description: An alternative shift trade notification. Only set if type == AlternativeShift readOnly: true $ref: '#/definitions/AlternativeShiftNotification' markedAsRead: type: boolean description: Whether this notification has been marked "read" agentNotification: type: boolean description: Whether this notification is for an agent readOnly: true otherNotificationIdsInGroup: type: array description: Other notification IDs in group. This field is only populated in real-time notifications readOnly: true uniqueItems: true items: type: string MoveAgentResponse: type: object properties: user: description: The user associated with the move $ref: '#/definitions/UserReference' result: type: string description: The result of the move enum: - AlreadyMoved - DestinationBusinessUnitAgentLimitExceeded - DestinationManagementUnitAgentLimitExceeded - DestinationManagementUnitDoesNotExist - MoveSuccessful - MovingToDifferentManagementUnit - NothingToDo - SourceManagementUnitNotAuthorized WfmIntegrationReference: 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 UserListScheduleRequestBody: type: object required: - endDate - startDate - userIds properties: userIds: type: array description: The user ids for which to fetch schedules items: type: string startDate: type: string format: date-time description: Beginning of the range of schedules to fetch, in ISO-8601 format endDate: type: string format: date-time description: End of the range of schedules to fetch, in ISO-8601 format loadFullWeeks: type: boolean description: Whether to load the full week's schedule (for the requested users) of any week overlapping the start/end date query parameters, defaults to false ValueWrapperPlanningPeriodSettings: type: object properties: value: description: The value for the associated field $ref: '#/definitions/PlanningPeriodSettings' CalendarUrlResponse: type: object properties: calendarUrl: type: string description: The calendar url for the user to subscribe with supported clients selfUri: type: string format: uri description: The URI for this object readOnly: true UserScheduleAdherence: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string user: description: The user for whom this status applies readOnly: true $ref: '#/definitions/UserReference' businessUnit: description: The business unit to which this user belongs readOnly: true $ref: '#/definitions/BusinessUnitReference' managementUnit: description: The management unit to which this user belongs readOnly: true $ref: '#/definitions/ManagementUnitReference' team: description: The team to which this user belongs readOnly: true $ref: '#/definitions/TeamReference' scheduledActivityCategory: type: string description: Activity for which the user is scheduled readOnly: true enum: - OnQueueWork - Break - Meal - Meeting - OffQueueWork - TimeOff - Training - Unavailable - Unscheduled scheduledActivityCode: description: Activity code for which the user is currently scheduled readOnly: true $ref: '#/definitions/ActivityCodeSummary' systemPresence: type: string description: Actual underlying system presence value readOnly: true enum: - Available - Away - Busy - Offline - Idle - OnQueue - Meal - Training - Meeting - Break organizationSecondaryPresenceId: type: string description: Organization Secondary Presence Id. readOnly: true routingStatus: type: string description: Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue readOnly: true enum: - OFF_QUEUE - IDLE - INTERACTING - NOT_RESPONDING - COMMUNICATING actualActivityCategory: type: string description: Activity in which the user is actually engaged readOnly: true enum: - OnQueueWork - Break - Meal - Meeting - OffQueueWork - TimeOff - Training - Unavailable - Unscheduled isOutOfOffice: type: boolean description: Whether the user is marked OutOfOffice readOnly: true adherenceState: type: string description: The user's current adherence state readOnly: true enum: - InAdherence - OutOfAdherence - Unscheduled - Unknown - Ignored - Explained impact: type: string description: The impact of the user's current adherenceState readOnly: true enum: - Positive - Negative - Neutral - Unknown adherenceExplanation: description: Currently applicable explanation for the adherence state readOnly: true $ref: '#/definitions/RealTimeAdherenceExplanation' timeOfAdherenceChange: type: string format: date-time description: Time when the user entered the current adherenceState in ISO-8601 format readOnly: true presenceUpdateTime: type: string format: date-time description: 'Time when presence was last updated. Used to calculate time in current status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true activeQueues: type: array description: The list of queues to which this user is joined readOnly: true items: $ref: '#/definitions/QueueReference' activeQueuesModifiedTime: type: string format: date-time description: 'Time when the list of active queues for this user was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true removedFromManagementUnit: type: boolean description: For notification purposes. Used to indicate that a user was removed from the management unit readOnly: true nextActivityReminders: type: array description: A list of upcoming activities for which the user is scheduled readOnly: true items: $ref: '#/definitions/UserNextActivityReminder' suppressOnTimeReminder: type: boolean description: Indicates whether the on-time adherence notification should be suppressed for the user readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true AgentAssignedScheduleSetList: type: object required: - agentAssignedShiftSets properties: agentAssignedShiftSets: type: array description: The shift sets, along with the assigned agents items: $ref: '#/definitions/AgentAssignedShiftSet' IntradayPerformancePredictionData: type: object properties: serviceLevelPercent: type: number format: double description: Percentage of interactions that meets service level target as defined in the matching service goal templates averageSpeedOfAnswerSeconds: type: number format: double description: Predicted average time in seconds it takes to answer an interaction once the interaction becomes available to be routed occupancyPercent: type: number format: double description: Percentage of on-queue time for all agents in this group that are occupied handling interactions BuCreateBlankScheduleRequest: type: object required: - description - weekCount properties: description: type: string description: The description for the schedule shortTermForecast: description: The forecast to use when generating the schedule. Note that the forecast must fully encompass the schedule's start week + week count $ref: '#/definitions/BuShortTermForecastReference' weekCount: type: integer format: int32 description: The number of weeks in the schedule. One extra day is added at the end ManagementUnitReference: 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 BuTimeOffPlanResponse: type: object required: - activityCodeIds - autoApprovalRule - countAgainstTimeOffLimits - daysBeforeStartToExpireFromWaitlist - enabled - id - metadata - name properties: id: type: string description: The globally unique identifier for the object. name: type: string description: The name of this time-off plan activityCodeIds: type: array description: The IDs of activity codes associated with this time-off plan uniqueItems: true items: type: string timeOffLimits: type: array description: The IDs of time-off limits associated with this time-off plan uniqueItems: true items: $ref: '#/definitions/BuTimeOffLimitReference' autoApprovalRule: type: string description: Auto approval rule for this time-off plan enum: - Never - Always - CheckLimits - CheckActivityCodes - CheckLimitsAndActivityCodes daysBeforeStartToExpireFromWaitlist: type: integer format: int32 description: The number of days before the time-off request start date for when the request will be expired from the waitlist autoPublishApprovedTimeOffRequests: type: boolean description: Whether newly approved time-off requests with activity codes associated with this time-off plan should be automatically published to the schedule restrictedActivityCodes: description: The IDs of non time-off activity codes to check for conflicts in case the auto approval rule specifies checking activity codes. If these activity codes are present in schedule and overlap with the time-off request duration, the request will not be auto approved $ref: '#/definitions/ActivityCodesReference' overrideDates: type: array description: A list of override dates to check for conflicts with time-off request dates. If a conflict is found, the request will not be auto-approved items: $ref: '#/definitions/OverrideDate' hrisTimeOffType: description: Time-off type, if this time-off plan is associated with the integration $ref: '#/definitions/HrisTimeOffType' enabled: type: boolean description: Whether this time-off plan is currently being used by agents countAgainstTimeOffLimits: type: boolean description: Whether this time-off plan counts against time-off limits businessUnitAssociation: description: Business unit association, if the time-off plan belongs to a business unit. managementUnitAssociation must not be set if this is populated $ref: '#/definitions/TimeOffPlanBusinessUnitAssociation' managementUnitAssociation: description: Management Unit association, if the time-off plan belongs to a management unit. businessUnitAssociation must not be set if this is populated $ref: '#/definitions/TimeOffPlanManagementUnitAssociation' metadata: description: Version metadata for the time-off plan $ref: '#/definitions/WfmVersionedEntityMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true AgentScheduleBiddingPreferencePriority: type: object required: - scheduleSetId properties: scheduleSetId: type: string description: The ID of the schedule set that belongs to agent's bid group priority: type: integer format: int32 description: The agent's priority for this schedule set. Lower numbers indicate higher priority, with 1 being the highest priority. Minimum value is 1. Null if priority is not set for the schedule set ShiftTradeShiftResponseItem: type: object required: - endDate - id - startDate - weekDate properties: id: type: string description: The ID of the shift startDate: type: string format: date-time description: The start date/time for the shift in ISO-8601 format endDate: type: string format: date-time description: The end date/time for the shift in ISO-8601 format weekDate: type: string format: date description: 'The start week date of the user shift in the business unit time zone (yyyy-MM-dd format). Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' SchedulerMessageTypeSeverity: type: object properties: type: type: string description: The type of the message enum: - AgentNotFound - AgentNotInSelectedManagementUnit - AgentNotLicensed - AgentWithoutWorkPlan - WorkPlanNotEnabled - WorkPlanNotFound - AgentWithoutCapability - NoNeedDays - UnableToProduceAgentSchedule - UnableToScheduleMinCoverageForPlanningGroup - UnableToScheduleMaxConsecutiveWorkingDays - UnableToScheduleMaxConsecutiveWorkingWeekends - UnableToScheduleMaxWeeklyPaidTime - UnableToScheduleMaxWeeklyWorkDays - UnableToScheduleMaxWorkDayPaidTime - UnableToScheduleMinConsecutiveNonWorkingTimePerWeek - UnableToScheduleMinIntershiftTime - UnableToScheduleMinShiftStartDistance - UnableToScheduleMinWeeklyPaidTime - UnableToScheduleMinWeeklyWorkDays - UnableToScheduleMinWorkDayPaidTime - UnableToSchedulePlanningPeriodMaxDaysOff - UnableToSchedulePlanningPeriodMaxPaidTime - UnableToSchedulePlanningPeriodMinDaysOff - UnableToSchedulePlanningPeriodMinPaidTime - UnableToScheduleShiftVariance - UnableToScheduleWorkDay - UnableToScheduleMaxConsecutiveWorkingDaysFromAgentHistory - UnableToScheduleMaxConsecutiveWorkingWeekendsFromAgentHistory - UnableToScheduleMaxWeeklyPaidTimeFromTimeOff - UnableToScheduleMaxWorkDayPaidTimeFromTimeOff - UnableToScheduleMinIntershiftTimeFromAgentHistory - UnableToScheduleMinIntershiftTimeFromDst - UnableToScheduleMinShiftStartDistanceFromAgentHistory - UnableToScheduleMinShiftStartDistanceFromDst - UnableToScheduleMinWeeklyPaidTimeFromTimeOff - UnableToScheduleMinWeeklyWorkDaysFromTimeOff - UnableToScheduleMinWorkDayPaidTimeFromTimeOff - UnableToSchedulePlanningPeriodMaxDaysOffFromAgentHistory - UnableToSchedulePlanningPeriodMaxDaysOffFromTimeOff - UnableToSchedulePlanningPeriodMaxPaidTimeFromAgentHistory - UnableToSchedulePlanningPeriodMaxPaidTimeFromTimeOff - UnableToSchedulePlanningPeriodMinDaysOffFromAgentHistory - UnableToSchedulePlanningPeriodMinPaidTimeFromAgentHistory - UnableToSchedulePlanningPeriodMinPaidTimeFromTimeOff - UnableToScheduleWorkDayFromTimeOff - AgentWithoutCapabilityToHandleActivityOnQueueWork - UnableToProduceAgentScheduleDueToUnavailableTimes - UnableToScheduleMaxActivityLengthFromShiftEndFromDst - UnableToScheduleMaxActivityLengthFromShiftEndFromTimeOff - UnableToScheduleMaxShiftStartAndPaidDurationVarianceFromTimeOff - UnableToScheduleMaxShiftStartTimeVarianceFromDst - UnableToScheduleMaxShiftStartTimeVarianceFromTimeOff - UnableToScheduleMinActivityLengthFromShiftEndFromDst - UnableToScheduleMinActivityLengthFromShiftStartFromDst - UnableToSchedulePlanningPeriodMaxShiftStartAndPaidDurationVarianceFromAgentHistory - UnableToSchedulePlanningPeriodMaxShiftStartAndPaidDurationVarianceFromTimeOff - UnableToSchedulePlanningPeriodMaxShiftStartTimeVarianceFromAgentHistory - UnableToSchedulePlanningPeriodMaxShiftStartTimeVarianceFromDst - UnableToSchedulePlanningPeriodMaxShiftStartTimeVarianceFromTimeOff - UnableToSchedulePlanningPeriodMaxWorkingWeekendsFromAgentHistory - UnableToSchedulePlanningPeriodShiftMaxCountFromAgentHistory - UnableToSchedulePlanningPeriodShiftMinCountFromAgentHistory severity: type: string description: The severity of the message enum: - Ignore - Information - Warning - Error ForecastInputPlanningGroupData: type: object required: - capacityPlanForecastMetrics - planningGroupId properties: planningGroupId: type: string description: The ID of the planning group for which this data applies capacityPlanForecastMetrics: description: The capacity plan forecast metrics for this planning group $ref: '#/definitions/CapacityPlanForecastMetrics' AvailableTimeOffRequest: type: object required: - activityCodeId properties: activityCodeId: type: string description: The ID for activity code to query available time off minutes dateRanges: type: array description: A list of date ranges of available time off minutes. A maximum number of date ranges is 30. The maximum total number of days in all ranges is 366. If no ranges are specified, then only the presence of the associated time off limit object will be checked. In such case, if the association exists, then the response will contain a list with of a single element filled with timeOffLimitId only. items: $ref: '#/definitions/LocalDateRange' CapacityPlanMetadata: type: object required: - modifiedBy - modifiedDate - version properties: modifiedBy: description: The user who modified the entity readOnly: true $ref: '#/definitions/UserReference' modifiedDate: type: string format: date-time description: 'The entity last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true createdDate: type: string format: date-time description: 'The date the entity created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true createdBy: description: The user who created the associated entity readOnly: true $ref: '#/definitions/UserReference' version: type: integer format: int32 description: The version of the capacity plan TimeOffPlan: type: object required: - id properties: id: type: string description: The globally unique identifier for the object. name: type: string description: The name of this time off plan. activityCodeIds: type: array description: The set of activity code IDs associated with this time off plan. uniqueItems: true items: type: string timeOffLimits: type: array description: The set of time off limit IDs associated with this time off plan. uniqueItems: true items: $ref: '#/definitions/TimeOffLimitReference' autoApprovalRule: type: string description: Auto approval rule for this time off plan enum: - Never - Always - CheckLimits - CheckActivityCodes - CheckLimitsAndActivityCodes daysBeforeStartToExpireFromWaitlist: type: integer format: int32 description: The number of days before the time off request start date for when the request will be expired from the waitlist. hrisTimeOffType: description: Time off type, if this time off plan is associated with the integration. $ref: '#/definitions/HrisTimeOffType' active: type: boolean description: Whether this time off plan is currently being used by agents. metadata: description: Version metadata for the time off plan. $ref: '#/definitions/WfmVersionedEntityMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true BuScheduleNotificationsSettingsResponse: type: object required: - activityCategorySettings - earlyReminderMinutes properties: earlyReminderMinutes: type: integer format: int32 description: The number of minutes prior to the scheduled event to display an early reminder notification activityCategorySettings: type: array description: List of activity category notification settings items: $ref: '#/definitions/BuScheduleNotificationsCategorySettings' AddShiftTradeJobRequest: type: object required: - initiatingShift properties: initiatingShift: description: The shift that the initiating user wants to give up in this trade $ref: '#/definitions/InitiatingShiftRequestItem' acceptableIntervals: type: array description: Time frames when the initiating user is willing to accept a shift in exchange. Empty means giving up the shift without taking on another one items: $ref: '#/definitions/RequiredDateRange' target: description: Optional shift trade target, can be used for example for direct user to user trade $ref: '#/definitions/ShiftTradeTargetRequestItem' expirationDate: type: string format: date-time description: When this shift trade will expire. Date time is represented as an ISO-8601 string WfmHistoricalShrinkageTeamsRequest: type: object required: - startDate - timeZone properties: startDate: type: string format: date-time description: Beginning of the date range to query in ISO-8601 format endDate: type: string format: date-time description: End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time timeZone: type: string description: The time zone, in olson format, to use in defining days when computing shrinkage for requested granularity. The results will be returned as UTC timestamps regardless of the time zone input. granularity: type: string description: Shrinkage aggregation interval granularity enum: - Daily - Weekly PerformancePredictionRecalculationResponse: type: object required: - operationId - state properties: operationId: type: string description: The operationId for which to listen downloadUrl: type: string description: The url to GET the results of the performance prediction. This field is populated only if query state is 'Complete' downloadResult: description: Result will always come via downloadUrls; however the schema is included for documentation $ref: '#/definitions/PerformancePredictionOutputs' state: type: string description: The state of the performance prediction enum: - Processing - Complete - Error DailyPossibleShift: type: object properties: dayOfWeek: type: string description: Day of the shift enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday earliestShiftStartMinutesFromMidnight: type: integer format: int32 description: Minutes of the earliest shift start from midnight. Note that midnight is 12:00 am in the time zone specified in the timeZone field (in the top level of the response) required: type: boolean description: Whether this is a required shift minimumPaidTimeMinutes: type: integer format: int32 description: Minimum paid time in minutes of this daily shift maximumPaidTimeMinutes: type: integer format: int32 description: Maximum paid time in minutes of this daily shift intervalScheduleProbabilities: type: array description: 'The percentage of being scheduled in each interval between the earliest shift start and latest shift end. Range of the values: [0, 100].' items: type: integer format: int32 BidGroupWorkPlanRotationRequest: type: object required: - agentCount - workPlanRotationId properties: workPlanRotationId: type: string description: The ID of the work plan rotation used in the bid group agentCount: type: integer format: int32 description: The count of agents that can be assigned to this work plan rotation BuRescheduleAgentScheduleResult: type: object properties: managementUnit: description: The management unit to which this part of the result applies $ref: '#/definitions/ManagementUnitReference' downloadResult: description: The agent schedules. Result will always come via the downloadUrl; however the schema is included for documentation $ref: '#/definitions/MuRescheduleResultWrapper' downloadUrl: type: string description: The download URL from which to fetch the result CapacityPlanningPlanningGroupAllocation: type: object required: - overUnderFullTimeEquivalentCount - planningGroupId - requiredStaffFullTimeEquivalentCount - staffingGroupFullTimeEquivalentContributions - totalPlannedFullTimeEquivalentCount properties: planningGroupId: type: string description: The planning group ID to which the capacity planning allocations apply requiredStaffFullTimeEquivalentCount: type: array description: The weekly required staff to this planning group items: type: number format: double staffingGroupFullTimeEquivalentContributions: type: array description: The weekly planned full time equivalent contributions from associated staffing groups items: $ref: '#/definitions/StaffingGroupFullTimeEquivalentContribution' totalPlannedFullTimeEquivalentCount: type: array description: The total weekly full time equivalent planned for this planning group, based on the associated staffing groups items: type: number format: double overUnderFullTimeEquivalentCount: type: array description: The weekly difference between the total planned full time equivalent and the required staff items: type: number format: double BusinessUnitActivityCodeListing: type: object properties: entities: type: array items: $ref: '#/definitions/BusinessUnitActivityCode' downloadUrl: type: string description: URL from which to fetch results for requests with a large result set. If populated, the downloaded data will conform to the same schema as would normally be returned, excepting downloaded data will never itself contain a downloadUrl UserTimeOffRequestReference: type: object required: - user properties: id: type: string description: The id of the time off request user: description: The ID of the user to whom the time off request applies $ref: '#/definitions/UserReference' selfUri: type: string format: uri description: The URI for this object readOnly: true SchedulerMessageArgument: type: object properties: type: type: string description: The type of this message parameter enum: - AgentId - Date - PlanningGroupId value: type: string description: The value of this message parameter CreateAdminTimeOffRequest: type: object required: - activityCodeId - status - users properties: status: type: string description: The status of this time off request enum: - PENDING - APPROVED users: type: array description: A set of IDs for users to associate with this time off request uniqueItems: true items: $ref: '#/definitions/UserReference' activityCodeId: type: string description: The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category notes: type: string description: Notes about the time off request fullDayManagementUnitDates: type: array description: A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone items: type: string fullDayEarliestStartOffsetMinutes: type: array description: Earliest start offset in minutes for each full-day request date. Values may be null when time-off estimation is disabled or no estimate is available items: type: integer format: int32 fullDayLatestEndOffsetMinutes: type: array description: Latest end offset in minutes for each full-day request date. Values may be null when time-off estimation is disabled or no estimate is available items: type: integer format: int32 partialDayStartDateTimes: type: array description: A set of start date-times in ISO-8601 format for partial day requests items: type: string format: date-time dailyDurationMinutes: type: integer format: int32 description: Daily duration in minutes applied to all days of this time off request. Ignored if durationMinutes is specified. At least one of dailyDurationMinutes or durationMinutes is required durationMinutes: type: array description: Duration in minutes for each day of this time off request. Must match the size of fullDayManagementUnitDates or partialDayStartDateTimes. At least one of dailyDurationMinutes or durationMinutes is required items: type: integer format: int32 payableMinutes: type: array description: Payable minutes for each day of this time off request, representing scheduled paid time displaced by this request. Defaults to dailyDurationMinutes if not specified items: type: integer format: int32 paid: type: boolean description: Whether this is a paid time off request. Defaults to the activity code's paid value if not specified SchedulerMessageSeverityCount: type: object properties: severity: type: string description: The schedule message severity enum: - Ignore - Information - Warning - Error count: type: integer format: int32 description: The number of schedule messages with the given severity PerformancePredictionUploadSchema: type: object required: - calculationStartDate - onQueueTimes properties: calculationStartDate: type: string format: date-time description: Date as an ISO-8601 string, corresponding to the beginning of the performance prediction results onQueueTimes: type: array description: List of agent on-queue times by management unit items: $ref: '#/definitions/MuAgentQueueTimeRequest' WorkPlanPatternRequest: type: object required: - workPlanIds properties: workPlanIds: type: array description: List of work plan IDs in order of rotation on a weekly basis. Values in the list cannot be null or empty items: type: string 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 MuAgentQueueTimeRequest: type: object required: - agentOnQueueTimes - managementUnitId properties: managementUnitId: type: string description: ID of the management unit agentOnQueueTimes: type: array description: List of Agent queue times within the management unit items: $ref: '#/definitions/AgentQueueTimeRequest' BuActivitySettingsResponse: type: object properties: defaultActivityCode: description: Default Activity Code settings $ref: '#/definitions/ActivityCodeReference' UpdateWorkPlanRotationAgentRequest: type: object required: - userId properties: userId: type: string description: The ID of an agent in this work plan rotation dateRange: description: The date range to which this agent is effective in the work plan rotation $ref: '#/definitions/DateRangeWithOptionalEnd' position: type: integer format: int32 description: Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0 delete: type: boolean description: If marked true for this agent when updating, then this agent will be removed from this work plan rotation AlternativeShiftJobReference: type: object required: - status - type properties: id: type: string description: The globally unique identifier for the object. readOnly: true status: type: string description: The status of the alternative shift job enum: - Processing - Complete - Error type: type: string description: The type of alternative shift asynchronous job enum: - ListOffers - SearchOffers - ListUserTrades - SearchTrades - BulkUpdateTrades selfUri: type: string format: uri description: The URI for this object readOnly: true CopyWorkPlan: type: object required: - name properties: name: type: string description: Name of the copied work plan AvailabilityRange: type: object required: - earliestStartMinutesFromMidnight - latestEndMinutesFromMidnight properties: earliestStartMinutesFromMidnight: type: integer format: int32 description: The earliest time of day the activity can be scheduled to begin, in minutes from midnight in the configured time zone of the business unit latestEndMinutesFromMidnight: type: integer format: int32 description: The latest time of day the activity can be scheduled to end, in minutes from midnight in the configured time zone of the business unit QueryEffectiveScheduleSetsRequest: type: object required: - startDate - weekCount properties: startDate: type: string format: date description: 'The start date for querying effective bids relative to the business unit time zone in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' weekCount: type: integer format: int32 description: The number of weeks to query for effective bids SearchUnmatchedShiftTradeListJobRequest: type: object required: - managementUnitIds - receivingSchedule - weekDates properties: managementUnitIds: type: array description: The IDs of management units from which to query shift trades uniqueItems: true items: type: string weekDates: type: array description: The start week dates in which to query shift trades in the business unit time zone (yyyy-MM-dd format) uniqueItems: true items: type: string format: date receivingSchedule: description: Associated schedule information for the receiving user $ref: '#/definitions/ReceivingScheduleLookup' receivingShiftIds: type: array description: The IDs of shifts that the receiving user would potentially be willing to trade. If empty, only returns one-sided trades uniqueItems: true items: type: string QueryExternalActivityOpportunitiesResponse: type: object required: - externalActivities properties: externalActivities: type: array description: The external activities and associated opportunity details items: $ref: '#/definitions/QueryExternalActivityOpportunityResult' CopyWorkPlanRotationRequest: type: object required: - name properties: name: type: string description: Name to apply to the new copy of the work plan rotation TimeOffSettingsRequest: type: object properties: submissionRangeEnforced: type: boolean description: Whether to enforce a submission range for agent time off requests submissionRangeType: type: string description: The type of the submission range enum: - Relative - FixedEnd submissionEarliestDaysFromNow: type: integer format: int32 description: The earliest number of days from now for which an agent can submit a time off request. Use negative numbers to indicate days in the past submissionLatestDaysFromNow: type: integer format: int32 description: The latest number of days from now for which an agent can submit a time off request submissionLatestDate: description: The latest date for the time off request submission interpreted in the business unit time zone in yyyy-MM-dd format $ref: '#/definitions/ValueWrapperLocalDate' BuNotificationSettingsRequest: type: object properties: scheduling: description: Schedule notification settings $ref: '#/definitions/BuScheduleNotificationsSettingsRequest' TimeOffPlanBusinessUnitAssociation: type: object properties: managementUnits: type: array description: Management units to which this time-off plan applies. This must not be set if staffingGroups is populated uniqueItems: true items: $ref: '#/definitions/ManagementUnitReference' staffingGroups: type: array description: Staffing groups to which this time-off plan applies. This must not be set if managementUnits is populated uniqueItems: true items: $ref: '#/definitions/StaffingGroupReference' BuAgentScheduleRescheduleResponse: type: object properties: user: description: The user to whom this agent schedule applies $ref: '#/definitions/UserReference' shifts: type: array description: The shift definitions for this agent schedule items: $ref: '#/definitions/BuAgentScheduleShift' fullDayTimeOffMarkers: type: array description: Full day time off markers which apply to this agent schedule items: $ref: '#/definitions/BuFullDayTimeOffMarker' workPlan: description: The work plan for this user $ref: '#/definitions/WorkPlanReference' workPlansPerWeek: type: array description: The work plans per week for this user from the work plan rotation. Null values in the list denotes that user is not part of any work plan for that week items: $ref: '#/definitions/WorkPlanReference' BuAgentScheduleUpdate: type: object properties: type: type: string description: The type of update enum: - Added - Edited - Deleted shiftStartDates: type: array description: The start date for the affected shifts items: type: string format: date-time QueryPlanningGroupToStaffingGroupsRequest: type: object properties: planningGroupIds: type: array description: The list of planning group IDs to request capacity group associations items: type: string staffingGroupIds: type: array description: The list of staffing group IDs to request capacity group associations items: type: string ForecastPlanningGroupsResponse: type: object properties: entities: type: array items: $ref: '#/definitions/ForecastPlanningGroupResponse' businessUnitServiceGoalImpact: description: A snapshot of a business unit’s service goal impact settings taken at forecast generation time. $ref: '#/definitions/WfmServiceGoalImpactSettings' PerformancePredictionOutputs: type: object required: - calculationIntervalLengthMinutes - calculationStartDate - planningGroupResults properties: calculationStartDate: type: string format: date-time description: Date as an ISO-8601 string, corresponding to the beginning of the performance prediction results calculationIntervalLengthMinutes: type: integer format: int32 description: Interval length of the response metrics planningGroupResults: type: array description: List of planning group level performance prediction results items: $ref: '#/definitions/PlanningGroupOutputs' BuAgentScheduleHistoryChangeMetadata: type: object properties: dateModified: type: string format: date-time description: 'The timestamp of the schedule change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' modifiedBy: description: The user that made the schedule change. The id may be 'System' if it was an automated process $ref: '#/definitions/UserReference' ServiceGoalTemplate: type: object required: - id properties: id: type: string description: The globally unique identifier for the object. name: type: string serviceLevel: description: Service level targets for this service goal template $ref: '#/definitions/BuServiceLevel' averageSpeedOfAnswer: description: Average speed of answer targets for this service goal template $ref: '#/definitions/BuAverageSpeedOfAnswer' abandonRate: description: Abandon rate targets for this service goal template $ref: '#/definitions/BuAbandonRate' metadata: description: Version metadata for the service goal template $ref: '#/definitions/WfmVersionedEntityMetadata' impactOverride: description: Settings controlling max percent increase and decrease of service goals for this service goal template $ref: '#/definitions/ServiceGoalTemplateImpactOverride' selfUri: type: string format: uri description: The URI for this object readOnly: true ShiftTradeMatchesSummaryResponse: type: object properties: entities: type: array items: $ref: '#/definitions/WeekShiftTradeMatchesSummaryResponse' ActivityCodeContainer: type: object required: - metadata properties: activityCodes: type: object description: Map of activity code id to activity code additionalProperties: $ref: '#/definitions/ActivityCode' metadata: description: Version metadata for the associated management unit's list of activity codes $ref: '#/definitions/WfmVersionedEntityMetadata' ShiftTradeMatchViolation: type: object properties: type: type: string description: The type of constraint violation enum: - AgentCapabilityMismatch - CannotTradeWithYourself - DirectTradeForOtherUser - InitiatingAgentMinimumTimeBetweenShifts - InitiatingAgentScheduleDoesNotExist - InitiatingExternalActivityCannotInterruptReceivingShift - InitiatingExternalActivityOutsideReceivingShift - InitiatingPlanningPeriodMaxPaidTime - InitiatingPlanningPeriodMinPaidTime - InitiatingShiftDisallowedActivityCategory - InitiatingShiftDoesNotExist - InitiatingShiftHasExternalActivities - InitiatingShiftOverlapsExisting - InitiatingShiftStartTooClose - InitiatingShiftTimesChanged - InitiatingWeeklyMaxPaidTime - InitiatingWeeklyMinPaidTime - InvalidState - OneSidedTradeCreation - ReceivingAgentMinimumTimeBetweenShifts - ReceivingAgentScheduleDoesNotExist - ReceivingExternalActivityCannotInterruptInitiatingShift - ReceivingExternalActivityOutsideInitiatingShift - ReceivingPlanningPeriodMaxPaidTime - ReceivingPlanningPeriodMinPaidTime - ReceivingShiftDisallowedActivityCategory - ReceivingShiftDoesNotExist - ReceivingShiftForOneSidedTrade - ReceivingShiftHasExternalActivities - ReceivingShiftMissingForTwoSidedTrade - ReceivingShiftOutsideAcceptableIntervals - ReceivingShiftOverlapsExisting - ReceivingShiftStartTooClose - ReceivingShiftTimesChanged - ReceivingWeeklyMaxPaidTime - ReceivingWeeklyMinPaidTime - ShiftTradingNotEnabled - UnequalPaidTime - WeekScheduleDifferent - WeekScheduleDoesNotExist - WeekScheduleUnpublished params: type: object description: Clarifying user params for constructing helpful error messages additionalProperties: type: string UpdateAgentScheduleBiddingPreference: type: object required: - agentScheduleBidPreferences - submitted properties: submitted: type: boolean description: Whether the preference is submitted agentScheduleBidPreferences: type: array description: The schedule bidding preferences items: $ref: '#/definitions/AgentScheduleBiddingPreferencePriority' WorkPlanConstraintMessage: type: object properties: type: type: string description: Type of the work plan constraint in this message enum: - ActivityEarliestStartTimeMinutesFromMidnight - ActivityEarliestStartTimeMinutesFromShiftStart - ActivityLatestStartTimeMinutesFromMidnight - ActivityLatestStartTimeMinutesFromShiftStart - ActivityMaximumLengthFromShiftEndMinutes - ActivityMinimumLengthFromShiftEndMinutes - ActivityMinimumLengthFromShiftStartMinutes - ActivityStartTimeIncrementInMinutes - PlanningPeriodMaximumDaysOff - PlanningPeriodMaximumPaidTimeMinutes - PlanningPeriodMaximumWorkingWeekends - PlanningPeriodMinimumDaysOff - PlanningPeriodMinimumPaidTimeMinutes - ShiftDayOffRule - ShiftEarliestStartTimeMinutesFromMidnight - ShiftEarliestStopTimeMinutesFromMidnight - ShiftLatestStartTimeMinutesFromMidnight - ShiftLatestStopTimeMinutesFromMidnight - ShiftMaximumContiguousTimeMinutes - ShiftMaximumCountPerPlanningPeriod - ShiftMaximumPaidTimeMinutes - ShiftMinimumContiguousTimeMinutes - ShiftMinimumCountPerPlanningPeriod - ShiftMinimumPaidTimeMinutes - ShiftStartTimeIncrementInMinutes - ShiftStartVarianceMaximumVarianceMinutes - ShiftStartVariancePaidDuration - WorkPlanMaximumConsecutiveWorkingDays - WorkPlanMaximumConsecutiveWorkingWeekends - WorkPlanMaximumWeeklyPaidTimeMinutes - WorkPlanMaximumWorkingDaysPerWeek - WorkPlanMinimumConsecutiveNonWorkingTimePerWeekMinutes - WorkPlanMinimumInterShiftTimeMinutes - WorkPlanMinimumShiftStartDistanceMinutes - WorkPlanMinimumWeeklyPaidTimeMinutes - WorkPlanMinimumWorkingDaysPerWeek - WorkPlanOptionalDays - WorkPlanPaidTimeGranularityMinutes arguments: type: array description: Arguments of the message that provide information about the constraint that is being conflicted with, such as the value of the constraint items: $ref: '#/definitions/WorkPlanValidationMessageArgument' BidGroupWorkPlanResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true managementUnit: description: The management unit to which this work plan belongs. Nullable in some routes $ref: '#/definitions/ManagementUnitReference' overrideAgentCount: type: integer format: int32 description: The modified agent count for this work plan suggestedAgentCount: type: integer format: int32 description: The number of agents needed for this work plan to produce the optimal schedule readOnly: true agentCountRange: description: The range of agent slot count per work plan. The suggested slot count must be in agent count range readOnly: true $ref: '#/definitions/AgentCountRange' selfUri: type: string format: uri description: The URI for this object readOnly: true ActivityPlanStructureWithOccurrenceSessionsUsersReference: type: object required: - id - occurrences properties: id: type: string description: The globally unique identifier for the object. occurrences: type: array description: The occurrences to delete from this activity plan items: $ref: '#/definitions/ActivityPlanOccurrenceSessionsUsersStructureReference' selfUri: type: string format: uri description: The URI for this object readOnly: true UnavailableTimesValidationResult: type: object required: - invalidWorkPlans - valid properties: valid: type: boolean description: Indicates whether there are no violations in the given unavailable times invalidWorkPlans: type: array description: Invalid work plans that were used when validating the agents unavailable times items: $ref: '#/definitions/WorkPlanReference' workPlanConstraintsViolationMessage: description: Message for set of agent unavailable times violating work plan constraints $ref: '#/definitions/WorkPlanConstraintsViolationMessage' WorkPlanConstraintsViolationMessage: type: object required: - fixableConstraintsMessages - type properties: type: type: string description: Message for how to resolve a set of conflicted work plan constraints enum: - ConstraintConflictWithPotentialFixes - ConstraintConflictUnknownFix fixableConstraintsMessages: type: array description: If type == 'ConstraintConflictWithPotentialFixes', messages for the set of conflicted work plan constraints. Each element indicates the message of potential fix to unavailable times to resolve work plan constraints items: $ref: '#/definitions/WorkPlanConstraintViolationMessage' ServiceGoalTemplateList: type: object properties: entities: type: array items: $ref: '#/definitions/ServiceGoalTemplate' metadata: description: Version metadata for the service goal templates $ref: '#/definitions/WfmVersionedEntityMetadata' HistoricalImportStatusJobResponse: type: object properties: id: type: string description: The job id for the import request readOnly: true importStatusResult: description: The historical import status result of the import job $ref: '#/definitions/HistoricalImportStatus' selfUri: type: string format: uri description: The URI for this object readOnly: true BuCreateTimeOffLimitRequest: type: object properties: staffingGroupId: type: string description: The ID of the staffing group to which this time-off limit is associated. It can be either management unit or business unit level staffing group. One of managementUnitId or staffingGroupId must be set. This must not be set if managementUnitId has value managementUnitId: type: string description: The ID of the management unit to which this time-off limit is associated. One of managementUnitId or staffingGroupId must be set. This must not be set if staffingGroupId has value PlanningGroupReference: type: object required: - id 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 EvaluateShiftTradeListJobRequest: type: object required: - managementUnitIds - weekDates properties: managementUnitIds: type: array description: The IDs of management units from which to query shift trades uniqueItems: true items: type: string weekDates: type: array description: The start week dates in which to query shift trades in the business unit time zone (yyyy-MM-dd format) uniqueItems: true items: type: string format: date PlanningGroupList: type: object properties: entities: type: array items: $ref: '#/definitions/PlanningGroup' metadata: description: Version metadata for the planning groups $ref: '#/definitions/WfmVersionedEntityMetadata' ActivityPlanListItem: type: object required: - activityCode - createdBy - createdDate - description - id - modifiedBy - modifiedDate - name - optimizationObjective - state - type properties: id: type: string description: The globally unique identifier for the object. name: type: string description: The name of the activity plan managementUnits: type: array description: The management units to which this activity plan applies. Empty list or null means this activity plan applies to all management units in the business unit items: $ref: '#/definitions/ManagementUnitReference' description: type: string description: The description of this activity plan activityCode: description: 'The activity code to which this activity plan applies. Note: It is recommended to load and cache the entire list of activity codes rather than look up individual codes' $ref: '#/definitions/ActivityCodeReference' type: type: string description: The type of the activity plan enum: - Individual - Group optimizationObjective: type: string description: The optimization objective of this activity plan enum: - FavorServiceGoals - FavorSchedulingAll recurrenceSettings: description: Recurrence settings for this activity plan $ref: '#/definitions/RecurrenceSettings' state: type: string description: The state of this activity plan enum: - Active - Inactive lastRunDate: type: string format: date-time description: The date on which the activity plan was last manually run, in ISO-8601 format lastRunBy: description: The last user to run this activity plan $ref: '#/definitions/UserReference' createdDate: type: string format: date-time description: The date the activity plan was created, in ISO-8601 format createdBy: description: The user who created this activity plan $ref: '#/definitions/UserReference' modifiedDate: type: string format: date-time description: The date the activity plan was modified, in ISO-8601 format modifiedBy: description: The last user to modify this activity plan. The id may be 'System' if it was an automated process $ref: '#/definitions/UserReference' initialSchedulePeriod: description: The initial schedule period of the activity plan $ref: '#/definitions/SchedulingPeriodBase' selfUri: type: string format: uri description: The URI for this object readOnly: true AgentScheduleBidScheduleSetResponse: type: object required: - downloadUrl properties: downloadUrl: type: string description: The download URL to fetch the schedule set of the bid group to which the agent belongs downloadTemplate: description: Schedule sets always come through downloadUrl, the schema included here is just for documentation $ref: '#/definitions/BidGroupScheduleSet' BuFullDayTimeOffMarker: type: object properties: businessUnitDate: type: string format: date description: 'The date of the time off marker, interpreted in the business unit''s time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' startOffsetMinutes: type: integer format: int32 description: The start offset in minutes for the time-off marker endOffsetMinutes: type: integer format: int32 description: The end offset in minutes for the time-off marker lengthMinutes: type: integer format: int32 description: The length of the time off marker in minutes description: type: string description: The description of the time off marker activityCodeId: type: string description: The ID of the activity code associated with the time off marker paid: type: boolean description: Whether the time off marker is paid payableMinutes: type: integer format: int32 description: Payable minutes for the time off marker. Must not exceed lengthMinutes timeOffRequestId: type: string description: The ID of the time off request timeOffRequestSyncVersion: type: integer format: int32 description: The sync version of the full day time off request for which the scheduled activity is associated delete: type: boolean description: Set to 'true' to delete this time off marker. Will always be null on responses, only has an effect on schedule update StaffingGroupAllocation: type: object required: - attritionPercentages - shrinkagePercentages - staffingGroupId - startingWeeklyFullTimeEquivalentCount properties: staffingGroupId: type: string description: The staffing group to which the result allocation belongs shrinkagePercentages: type: array description: The weekly projected shrinkage percentage of staffing group, in the scale of 0 - 100 items: type: number format: double attritionPercentages: type: array description: The weekly projected attrition percentage of the staffing group, in the scale of 0 - 100 items: type: number format: double newHiresFullTimeEquivalentCount: type: array description: The weekly projected full time equivalent agents of new hire agents added to the staffing group items: type: number format: double startingWeeklyFullTimeEquivalentCount: type: number format: double description: The weekly count of full time equivalent agents that can be used for the first week of the capacity plan planningGroupIds: type: array description: The IDs of the planning groups associated with this staffing group items: type: string baseStartingFullTimeEquivalentCount: type: array description: The weekly calculated starting full time equivalent count items: type: number format: double attritionFullTimeEquivalentCount: type: array description: The weekly projected attrition full time equivalent count items: type: number format: double staffingGroupPlannedFullTimeEquivalentCount: type: array description: The weekly calculated staffing group full time equivalent count items: type: number format: double endOfMonthPlannedFullTimeEquivalentCount: type: array description: The end of month planned full time equivalent count of this staffing group items: type: number format: double shrinkageFullTimeEquivalentCount: type: array description: The weekly projected shrinkage full time equivalent count of this staffing group items: type: number format: double netFullTimeEquivalentCount: type: array description: The weekly net full time equivalent count of this staffing group items: type: number format: double extraTimeUnderTimeFullTimeEquivalentCount: type: array description: The weekly projected extra or under full time equivalent to the staffing group items: type: number format: double transfersFullTimeEquivalentCount: type: array description: The weekly projected full time equivalent transfers of agents into or out of this staffing group items: type: number format: double UpdateShiftTradeJobRequest: type: object required: - metadata - weekDate properties: weekDate: type: string format: date description: 'The start week date of this shift in the business unit time zone (yyyy-MM-dd format). Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' target: description: Target of the shift trade, if applicable $ref: '#/definitions/ValueWrapperShiftTradeTargetRequestItem' expirationDate: description: When this shift trade will expire. Date time is represented as an ISO-8601 string $ref: '#/definitions/ValueWrapperDate' acceptableIntervals: description: Time frames when the initiating user is willing to accept a shift in exchange. Setting the enclosed list to empty will make this a one sided trade request. $ref: '#/definitions/ListWrapperRequiredDateRange' metadata: description: Version metadata for the shift trade $ref: '#/definitions/WfmVersionedEntityMetadata' ShiftTradeSearchUnmatchedTradesBuJobResponse: type: object required: - id - status - type properties: id: type: string description: The globally unique identifier for the object. status: type: string description: The status of the job enum: - Processing - Complete - Canceled - Error type: type: string description: The type of the job enum: - AddTrade - BulkUpdateTradeStates - EvaluateTrades - MatchTrade - QueryAgentTrades - QueryTrades - QueryWeekSummaries - SearchUnmatchedTrades - UpdateTrade - UpdateTradeState downloadUrl: type: string description: The URL where completed results might be available for download in case the result body for that job type is too large error: description: Any error information, only set if the status == 'Error' $ref: '#/definitions/ErrorBody' searchUnmatchedTradesResult: description: Results for SearchUnmatchedTrades job type $ref: '#/definitions/SearchUnmatchedShiftTradeListJobResponseItem' selfUri: type: string format: uri description: The URI for this object readOnly: true BuShortTermForecastingSettings: type: object properties: defaultHistoryWeeks: type: integer format: int32 description: The number of historical weeks to consider when creating a forecast. This setting is only used for legacy weighted average forecasts BuActivitySettingsRequest: type: object properties: defaultActivityCodeId: type: string description: The ID of the activity code. This is the activity code that will be used by default for agent development activities added to the schedule ShiftTradeMatchReviewUserResponse: type: object properties: weeklyMinimumPaidMinutes: type: integer format: int32 description: The minimum weekly paid minutes for this user per the work plan tied to the agent schedule weeklyMaximumPaidMinutes: type: integer format: int32 description: The maximum weekly paid minutes for this user per the work plan tied to the agent schedule preTradeSchedulePaidMinutes: type: integer format: int32 description: The paid minutes on the week schedule for this user prior to the shift trade postTradeSchedulePaidMinutes: type: integer format: int32 description: The paid minutes on the week schedule for this user if the shift trade is approved postTradeNewShift: description: Preview of what the shift will look like for the opposite side of this trade after the match is approved $ref: '#/definitions/ShiftTradePreviewResponse' WfmHistoricalAdherenceResultWrapper: type: object properties: entityId: type: string description: The operation ID of the historical adherence query data: type: array description: The list of historical adherence query results items: $ref: '#/definitions/HistoricalAdherenceQueryResult' lookupIdToSecondaryPresenceId: type: object description: Map of secondary presence lookup ID to corresponding secondary presence ID additionalProperties: type: string BuUserListing: type: object required: - managementUnits properties: managementUnits: type: array description: Management units and their associated users items: $ref: '#/definitions/ManagementUnitUserListing' RoutePathResponse: type: object properties: queue: description: The ID of the queue associated with the route path $ref: '#/definitions/QueueReference' mediaType: type: string description: The media type of the given queue associated with the route path enum: - Voice - Chat - Email - Callback - Message - Workitem language: description: The ID of the language associated with the route path $ref: '#/definitions/LanguageReference' skills: type: array description: The set of skills associated with the route path uniqueItems: true items: $ref: '#/definitions/RoutingSkillReference' PlanningGroupMinimumsRequest: type: object required: - dayOfWeekMinimums - planningGroupId properties: planningGroupId: type: string description: The ID of the planning group to which the day of week minimum staff values apply dayOfWeekMinimums: type: array description: The list of day of week minimum staff values for this planning group items: $ref: '#/definitions/DayOfWeekMinimums' AgentQueueTimeRequest: type: object required: - agentId - onQueueLengthMinutesPerInterval - startOffsetMinutes properties: agentId: type: string description: ID of the agent startOffsetMinutes: type: array description: List of offsets in minutes from calculationStartDate items: type: integer format: int32 onQueueLengthMinutesPerInterval: type: array description: List of on-queue time lengths in minutes per interval of elements in startOffsetMinutes items: type: integer format: int32 onQueueActivityCodeIds: type: array description: List of on-queue activity code ids items: type: string WorkPlanBidListResponse: type: object properties: entities: type: array items: $ref: '#/definitions/WorkPlanBid' UpdateMuAgentWorkPlansBatchResponse: type: object required: - failures properties: failures: type: array description: The work plan update failures items: $ref: '#/definitions/UpdateMuAgentWorkPlanFailureResponse' WeekScheduleListItemResponse: type: object required: - id 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 weekDate: type: string description: First day of this week schedule in yyyy-MM-dd format description: type: string description: Description of the week schedule published: type: boolean description: Whether the week schedule is published generationResults: description: Summary of the results from the schedule run $ref: '#/definitions/WeekScheduleGenerationResult' shortTermForecast: description: Short term forecast associated with this schedule $ref: '#/definitions/ShortTermForecastReference' metadata: description: Version metadata for this work plan $ref: '#/definitions/WfmVersionedEntityMetadata' 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 AdherenceExplanationJob: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true type: type: string description: The type of the adherence explanation job enum: - AddExplanation - UpdateExplanation - QueryAgentExplanations - QueryBuExplanations status: type: string description: The status of the adherence explanation job enum: - Processing - Complete - Error adherenceExplanation: description: The adherence explanation added or modified by the job once complete; may be null if status == 'Error'. Used if type is in [ 'AddExplanation', 'UpdateExplanation' ] $ref: '#/definitions/AdherenceExplanationResponse' downloadUrl: type: string description: A URL to fetch results of the job. Only set if status == 'Complete' and type is in [ 'QueryAgentExplanations', 'QueryBuExplanations' ] error: description: Error details if status == 'Error' $ref: '#/definitions/ErrorBody' agentQueryResponseTemplate: description: Schema template for deserializing data returned from the downloadUrl. Use if type == 'QueryAgentExplanations' $ref: '#/definitions/AdherenceExplanationListingAgentQueryResponse' buQueryResponseTemplate: description: Schema template for deserializing data returned from the downloadUrl. Use if type == 'QueryBuExplanations' $ref: '#/definitions/AdherenceExplanationListingBuQueryResponse' selfUri: type: string format: uri description: The URI for this object readOnly: true ValueWrapperBuShortTermForecastReference: type: object properties: value: description: The value for the associated field $ref: '#/definitions/BuShortTermForecastReference' CapacityPlanForecastInputsTemplate: type: object required: - capacityPlanForecastSummary - granularity - planningGroupsForecastData - referenceBusinessUnitDate properties: referenceBusinessUnitDate: type: string format: date description: 'The reference date for interval-based data relative to the business unit time zone for the forecast inputs. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' granularity: type: string description: Granularity of the intervals enum: - Weekly - Monthly months: type: array description: The list of months covered by this capacity plan, formatted as yyyy-MM, populated for monthly granularity items: type: string format: year-month description: 'Year and month are represented as an ISO-8601 string. For example: yyyy-MM' planningGroupsForecastData: type: array description: The forecast data for the planning groups items: $ref: '#/definitions/ForecastInputPlanningGroupData' capacityPlanForecastSummary: description: The summary of forecast inputs for this capacity plan, for the selected granularity $ref: '#/definitions/CapacityPlanForecastMetrics' SearchShiftTradesRequest: type: object required: - receivingScheduleId properties: receivingScheduleId: type: string description: The ID of the schedule for which to search for available shift trades receivingShiftIds: type: array description: The IDs of shifts that the receiving user would potentially be willing to trade. If empty, only returns one sided trades (pick up a shift) uniqueItems: true items: type: string ListWrapperAlternativeShiftBuSettingsActivityCategory: type: object properties: values: type: array items: type: string enum: - Break - Meal - Meeting - OffQueueWork - TimeOff - Training - Unavailable ListWrapperOverrideDate: type: object properties: values: type: array items: $ref: '#/definitions/OverrideDate' ScheduleUploadProcessingResponse: type: object properties: status: type: string description: The status of the operation enum: - Processing - Complete - Canceled - Error operationId: type: string description: The ID for the operation result: description: The result of the operation. Null unless status == Complete $ref: '#/definitions/BuScheduleMetadata' BulkUpdateOpportunityEnrollmentsStatusResponse: type: object required: - errorCount - results properties: results: type: array description: The result for each requested item items: $ref: '#/definitions/BulkOpportunitiesEnrollmentResult' errorCount: type: integer format: int32 description: The count of failed operations in the bulk request WorkPlanBidGroupResponse: type: object required: - id properties: id: type: string description: The globally unique identifier for the object. workPlanBidGroup: description: The work plan bid group $ref: '#/definitions/WorkPlanBidGroup' metadata: description: The meta data of the bid group $ref: '#/definitions/WorkPlanBidMetadata' selfUri: type: string format: uri description: The URI for this object readOnly: true BuManagementUnitScheduleSummary: type: object properties: managementUnit: description: The management unit to which this summary applies $ref: '#/definitions/ManagementUnitReference' agentCount: type: integer format: int32 description: The number of agents from this management unit that are in the schedule startDate: type: string format: date-time description: 'The start of the schedule change in the management unit. Only populated in schedule update notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endDate: type: string format: date-time description: 'The end of the schedule change in the management unit. Only populated in schedule update notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' agents: type: array description: The agents in the management unit who are part of this schedule, or in schedule change notifications, the agents that were changed. Note this will come back as an empty list unless the appropriate expand query parameter is passed uniqueItems: true items: $ref: '#/definitions/UserReference' BuGenerateScheduleRequest: type: object required: - description - weekCount properties: description: type: string description: The description for the schedule shortTermForecast: description: The forecast to use when generating the schedule. Note that the forecast must fully encompass the schedule's start week + week count $ref: '#/definitions/BuShortTermForecastReference' weekCount: type: integer format: int32 description: The number of weeks in the schedule. One extra day is added at the end options: description: Additional scheduling options $ref: '#/definitions/SchedulingOptionsRequest' BuGetCurrentAgentScheduleRequest: type: object required: - endDate - startDate properties: startDate: type: string format: date-time description: 'Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endDate: type: string format: date-time description: 'End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' BusinessUnitResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string settings: description: Settings for this business unit $ref: '#/definitions/BusinessUnitSettingsResponse' division: description: The division to which this entity belongs. $ref: '#/definitions/DivisionReference' selfUri: type: string format: uri description: The URI for this object readOnly: true HistoricalImportStatusListing: type: object properties: entities: type: array items: $ref: '#/definitions/HistoricalImportStatus' downloadUrl: type: string description: URL from which to fetch results for requests with a large result set. If populated, the downloaded data will conform to the same schema as would normally be returned, excepting downloaded data will never itself contain a downloadUrl UpdateNotificationsResponse: type: object properties: entities: type: array items: $ref: '#/definitions/UpdateNotificationResponse' HistoricalAdherenceQueryResult: type: object properties: userId: type: string description: The ID of the user for whom the adherence is queried managementUnitId: type: string description: The ID of the management unit of the user for whom the adherence is queried startDate: type: string format: date-time description: Beginning of the date range that was queried, in ISO-8601 format endDate: type: string format: date-time description: End of the date range that was queried, in ISO-8601 format. If it was not set, end date will be set to the queried time adherencePercentage: type: number format: double description: Adherence percentage for this user, in the scale of 0 - 100 conformancePercentage: type: number format: double description: Conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on-queue time is greater than the scheduled on-queue time for the same period. impact: type: string description: The impact of the current adherence state for this user enum: - Positive - Negative - Neutral - Unknown exceptionInfo: type: array description: List of adherence exceptions for this user items: $ref: '#/definitions/HistoricalAdherenceExceptionInfo' dayMetrics: type: array description: Adherence and conformance metrics for days in query range items: $ref: '#/definitions/HistoricalAdherenceDayMetrics' actualsEndDate: type: string format: date-time description: The end date of the actual activities in ISO-8601 format. actuals: type: array description: List of actual activity with offset for this user items: $ref: '#/definitions/HistoricalAdherenceActuals' BuListAlternativeShiftTradesResponse: type: object properties: job: description: The asynchronous job handling the request. Null if result returns synchronously $ref: '#/definitions/BuAlternativeShiftJobResponse' result: description: The result of the request. May come via notification. Null if job is populated $ref: '#/definitions/AlternativeShiftTradeListing' BuSchedulingSettingsResponse: type: object required: - activitySmoothingType - induceScheduleVariability properties: messageSeverities: type: array description: Schedule generation message severity configuration items: $ref: '#/definitions/SchedulerMessageTypeSeverity' syncTimeOffProperties: type: array description: Synchronize set of time off properties from scheduled activities to time off requests when the schedule is published uniqueItems: true items: type: string enum: - PayableMinutes - FullDayEarliestStartOffsetMinutes - FullDayLatestEndOffsetMinutes enableTimeOffFullDayEstimation: type: boolean description: Enables start and end time estimation for full-day time-off requests serviceGoalImpact: description: Configures the max percent increase and decrease of service goals for this business unit $ref: '#/definitions/WfmServiceGoalImpactSettings' allowWorkPlanPerMinuteGranularity: type: boolean description: Indicates whether or not per minute granularity for scheduling will be enabled for this business unit. Defaults to false activitySmoothingType: type: string description: The activity smoothing type for schedule generation in this business unit enum: - ReduceConcurrentActivitiesAcrossBu - ReduceConcurrentActivitiesAcrossMu - ConsistentServiceLevel induceScheduleVariability: type: boolean description: Indicates whether to provide variability in schedule generation BuSchedulerSettingsRequest: type: object required: - metadata properties: consistentServiceLevelSmoothing: type: boolean description: Indicates whether to provide consistent service level smoothing in schedule generation for this business unit metadata: description: Version metadata for this business unit's scheduler settings $ref: '#/definitions/WfmVersionedEntityMetadata' QueryAgentScheduleUnavailableTimesResponse: type: object required: - consideredInScheduleGeneration - scheduleGenerationUnavailableTimes properties: consideredInScheduleGeneration: type: boolean description: Indicates whether the unavailability times were considered in schedule generation. Returns false when no schedule exists scheduleGenerationUnavailableTimes: type: array description: List of the unavailable times used in schedule generation items: $ref: '#/definitions/AgentScheduleUnavailableTime' ShiftStartVariance: type: object required: - applicableDays - maxShiftStartVarianceMinutes properties: applicableDays: type: array description: Days for which shift start variance is configured uniqueItems: true items: type: string enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday maxShiftStartVarianceMinutes: type: integer format: int32 description: Maximum variance in minutes across shift starts BulkOpportunitiesRequest: type: object required: - ids properties: ids: type: array description: The IDs of the opportunities items: type: string QueryTimeOffIntegrationStatusRequest: type: object required: - timeOffRequestLookups properties: timeOffRequestLookups: type: array description: A list of time off request lookups items: $ref: '#/definitions/TimeOffRequestLookup' WorkPlanConstraintViolationMessage: type: object required: - arguments - type properties: type: type: string description: Type of the work plan constraint in this message. enum: - MinimumWeeklyWorkDays - MinimumWeeklyPaidTime - RequiredShift - MaximumDaysOffPerPlanningPeriod - MinimumPaidTimePerPlanningPeriod - MinimumShiftCountPerPlanningPeriod arguments: type: array description: Arguments of the message that provide information about the constraint that is being conflicted with such as the value of the constraint. items: $ref: '#/definitions/UnavailableTimesViolationMessageArgument' AlternativeShiftNotification: type: object required: - granularity - initiatingShiftDate - initiatingUser - weekDate properties: id: type: string description: The globally unique identifier for the object. readOnly: true weekDate: type: string format: date description: 'The start date of the schedule with which this trade is associated. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' granularity: type: string description: The granularity of alternative shifts to be traded enum: - Daily newState: type: string description: The new state of the alternative shift trade, null if there was no change enum: - Canceled - Denied - Expired - Submitted - Approved initiatingUser: description: The user who initiated the alternative shift trade $ref: '#/definitions/UserReference' initiatingShiftDate: type: string format: date-time description: 'The start date and time of the initiating shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' receivingUser: description: The user on the receiving side of this alternative shift trade $ref: '#/definitions/UserReference' receivingShiftDate: type: string format: date-time description: 'The start date and time of the receiving alternative shift. 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 HistoricalImportStatus: type: object properties: requestId: type: string description: Request id of the historical import in the organization readOnly: true dateImportEnded: type: string format: date-time description: 'The last day of the data you are importing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateImportStarted: type: string format: date-time description: 'The first day of the data you are importing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true status: type: string description: Status of the historical import in the organization. readOnly: true enum: - Initiated - InProgress - Pending - Success - Failed - Cancelled - Purged - PurgePending error: type: string description: Error occured if the status of the import is failed readOnly: true dateCreated: type: string format: date-time description: 'Date in which the historical import is initiated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Date in which the historical import is modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true active: type: boolean description: Whether this historical import is active or not readOnly: true type: type: string description: Whether this historical import is of type csv or json readOnly: true enum: - Csv - Json fileName: type: string description: Name of the file that you are importing. readOnly: true fileSize: type: integer format: int64 description: Size of the file that you are importing. readOnly: true BuAgentScheduleHistoryDroppedChange: type: object properties: metadata: description: The metadata of the change, including who and when the change was made $ref: '#/definitions/BuAgentScheduleHistoryChangeMetadata' shiftIds: type: array description: The IDs of deleted shifts uniqueItems: true items: type: string fullDayTimeOffMarkerDates: type: array description: The dates of any deleted full day time off markers uniqueItems: true items: type: string format: date deletes: description: The deleted shifts, full day time off markers, or the entire agent schedule $ref: '#/definitions/BuAgentScheduleHistoryDeletedChange' TimeOffBalanceJobResponse: type: object properties: entities: type: array items: $ref: '#/definitions/TimeOffBalanceResponse' status: type: string description: The status of the time off balance job enum: - Processing - Complete - Error AgentScheduleUnavailableTime: type: object required: - timeSpan properties: timeSpan: description: Exact date, time and length of the unavailability time span $ref: '#/definitions/WfmTimeSpan' notes: type: string description: Comments explaining the unavailability time span ShiftTradeMatchResponseItem: type: object required: - preview - shiftIds properties: shiftIds: type: array description: The IDs of the receiving shift trades which match the initiating shift trade uniqueItems: true items: type: string preview: description: A preview of what the shift trade would look like if matched $ref: '#/definitions/ShiftTradePreviewResponse' IgnoredActivityCategories: type: object properties: values: type: array description: Activity categories list items: type: string enum: - OnQueueWork - Break - Meal - Meeting - OffQueueWork - TimeOff - Training - Unavailable SourcePlanningGroupRequest: type: object required: - id - metadata properties: id: type: string description: The ID of the planning group metadata: description: Version metadata for the planning group $ref: '#/definitions/WfmVersionedEntityMetadata' WfmHistoricalAdherenceBulkResponse: type: object properties: job: description: A reference to the job that was started by the request $ref: '#/definitions/WfmHistoricalAdherenceBulkJobReference' downloadUrls: type: array description: The uri list to GET the results of the Historical Adherence query. This field is populated only if query state is Complete items: type: string downloadResult: description: Results will always come via downloadUrls; however the schema is included for documentation $ref: '#/definitions/WfmHistoricalAdherenceBulkResult' 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/