{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants Workforce Management API", "version": "v2" }, "items": [ { "info": { "name": "Workforce Management", "type": "folder" }, "items": [ { "info": { "name": "Get ics formatted calendar based on shareable link", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/calendar/data/ics", "params": [ { "name": "calendarId", "value": "", "type": "query", "description": "The id of the ics-formatted calendar" } ] }, "docs": "Get ics formatted calendar based on shareable link" }, { "info": { "name": "Deprecated: Instead use /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes. Get the list of activity codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/activitycodes", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." } ] }, "docs": "Deprecated: Instead use /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes. Get the list of activity codes" }, { "info": { "name": "Get activity codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/activitycodes", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit, or 'mine' for the business unit of the logged-in user." }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Get activity codes" }, { "info": { "name": "Create a new activity code", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/activitycodes", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit, or 'mine' for the business unit of the logged-in user." } ] }, "docs": "Create a new activity code" }, { "info": { "name": "Get an activity code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/activitycodes/:activityCodeId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit, or 'mine' for the business unit of the logged-in user." }, { "name": "activityCodeId", "value": "", "type": "path", "description": "The ID of the activity code to fetch" } ] }, "docs": "Get an activity code" }, { "info": { "name": "Update an activity code", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/activitycodes/:activityCodeId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit, or 'mine' for the business unit of the logged-in user." }, { "name": "activityCodeId", "value": "", "type": "path", "description": "The ID of the activity code to update" } ] }, "docs": "Update an activity code" }, { "info": { "name": "Deletes an activity code", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/activitycodes/:activityCodeId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit, or 'mine' for the business unit of the logged-in user." }, { "name": "activityCodeId", "value": "", "type": "path", "description": "The ID of the activity code to delete" } ] }, "docs": "Deletes an activity code" }, { "info": { "name": "Get intraday planning groups for the given date", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/intraday/planninggroups", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "date", "value": "", "type": "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" } ] }, "docs": "Get intraday planning groups for the given date" }, { "info": { "name": "Get intraday data for the given date for the requested planningGroupIds", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/intraday", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" } ] }, "docs": "Get intraday data for the given date for the requested planningGroupIds" }, { "info": { "name": "Creates a signed upload URL for importing a short term forecast", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekDateId/shorttermforecasts/import/uploadurl", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit to which the forecast belongs" }, { "name": "weekDateId", "value": "", "type": "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" } ] }, "docs": "Once the upload is complete, call the /import route to start the short term forecast import process" }, { "info": { "name": "Starts importing the uploaded short term forecast", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekDateId/shorttermforecasts/import", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit to which the forecast belongs" }, { "name": "weekDateId", "value": "", "type": "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" } ] }, "docs": "Call after uploading the forecast data to the url supplied by the /import/uploadurl route" }, { "info": { "name": "Gets the forecast generation results", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekDateId/shorttermforecasts/:forecastId/generationresults", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit to which the forecast belongs" }, { "name": "weekDateId", "value": "", "type": "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" }, { "name": "forecastId", "value": "", "type": "path", "description": "The ID of the forecast" } ] }, "docs": "Gets the forecast generation results" }, { "info": { "name": "Get short term forecasts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekDateId/shorttermforecasts", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit to which the forecast belongs" }, { "name": "weekDateId", "value": "", "type": "path", "description": "The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts" } ] }, "docs": "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" }, { "info": { "name": "Generate a short term forecast", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekDateId/shorttermforecasts/generate", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit to which the forecast belongs" }, { "name": "weekDateId", "value": "", "type": "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" }, { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" } ] }, "docs": "Generate a short term forecast" }, { "info": { "name": "Get a short term forecast", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekDateId/shorttermforecasts/:forecastId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit to which the forecast belongs" }, { "name": "weekDateId", "value": "", "type": "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" }, { "name": "forecastId", "value": "", "type": "path", "description": "The ID of the forecast" }, { "name": "expand", "value": "", "type": "query", "description": "Include to access additional data on the forecast" } ] }, "docs": "Get a short term forecast" }, { "info": { "name": "Delete a short term forecast", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekDateId/shorttermforecasts/:forecastId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit to which the forecast belongs" }, { "name": "weekDateId", "value": "", "type": "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" }, { "name": "forecastId", "value": "", "type": "path", "description": "The ID of the forecast" } ] }, "docs": "Must not be tied to any schedules" }, { "info": { "name": "Gets the forecast planning group snapshot", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekDateId/shorttermforecasts/:forecastId/planninggroups", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit to which the forecast belongs" }, { "name": "weekDateId", "value": "", "type": "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" }, { "name": "forecastId", "value": "", "type": "path", "description": "The ID of the forecast" } ] }, "docs": "Gets the forecast planning group snapshot" }, { "info": { "name": "Get the result of a short term forecast calculation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekDateId/shorttermforecasts/:forecastId/data", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit to which the forecast belongs" }, { "name": "weekDateId", "value": "", "type": "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" }, { "name": "forecastId", "value": "", "type": "path", "description": "The ID of the forecast" }, { "name": "weekNumber", "value": "", "type": "query", "description": "The week number to fetch (for multi-week forecasts)" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Includes modifications unless you pass the doNotApplyModifications query parameter" }, { "info": { "name": "Get the staffing requirement by planning group for a forecast", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekDateId/shorttermforecasts/:forecastId/staffingrequirement", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit to which the forecast belongs" }, { "name": "weekDateId", "value": "", "type": "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" }, { "name": "forecastId", "value": "", "type": "path", "description": "The ID of the forecast" }, { "name": "weekNumbers", "value": "", "type": "query", "description": "The week numbers to fetch (for multi-week forecasts) staffing requirements. Returns all week data if the list is not specified" }, { "name": "expand", "value": "", "type": "query", "description": "Expand to include minimum staffing values in (staffing requirement response or applied to base staffing requirement values)" } ] }, "docs": "Get the staffing requirement by planning group for a forecast" }, { "info": { "name": "Get the result of a long term forecast calculation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekDateId/shorttermforecasts/:forecastId/longtermforecastdata", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit to which the forecast belongs" }, { "name": "weekDateId", "value": "", "type": "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" }, { "name": "forecastId", "value": "", "type": "path", "description": "The ID of the forecast" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Includes modifications unless you pass the doNotApplyModifications query parameter" }, { "info": { "name": "Copy a short term forecast", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekDateId/shorttermforecasts/:forecastId/copy", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit to which the forecast belongs" }, { "name": "weekDateId", "value": "", "type": "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" }, { "name": "forecastId", "value": "", "type": "path", "description": "The ID of the forecast to copy" }, { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" } ] }, "docs": "Copy a short term forecast" }, { "info": { "name": "Get users in the business unit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/users", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "managementUnitIds", "value": "", "type": "query", "description": "The IDs of the management units for which to retrieve users" } ] }, "docs": "Get users in the business unit" }, { "info": { "name": "Get business unit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit, or 'mine' for the business unit of the logged-in user." }, { "name": "expand", "value": "", "type": "query", "description": "Include to access additional data on the business unit" }, { "name": "includeSchedulingDefaultMessageSeverities", "value": "", "type": "query", "description": "Whether to include scheduling default message severities" } ] }, "docs": "Expanding \"settings\" will retrieve all settings. All other expands will retrieve only the requested settings field(s)." }, { "info": { "name": "Update business unit", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit, or 'mine' for the business unit of the logged-in user." }, { "name": "includeSchedulingDefaultMessageSeverities", "value": "", "type": "query", "description": "Whether to include scheduling default message severities" } ] }, "docs": "Update business unit" }, { "info": { "name": "Delete business unit", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit, or 'mine' for the business unit of the logged-in user." } ] }, "docs": "A business unit cannot be deleted if it contains one or more management units" }, { "info": { "name": "Get all authorized management units in the business unit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/managementunits", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit, or 'mine' for the business unit of the logged-in user." }, { "name": "feature", "value": "", "type": "query", "description": "If specified, the list of management units for which the user is authorized to use the requested feature will be returned" }, { "name": "divisionId", "value": "", "type": "query", "description": "If specified, the list of management units belonging to the specified division will be returned" } ] }, "docs": "Get all authorized management units in the business unit" }, { "info": { "name": "Get business units", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits", "params": [ { "name": "feature", "value": "", "type": "query", "description": "If specified, the list of business units for which the user is authorized to use the requested feature will be returned" }, { "name": "divisionId", "value": "", "type": "query", "description": "If specified, the list of business units belonging to the specified division will be returned" } ] }, "docs": "Get business units" }, { "info": { "name": "Add a new business unit", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits", "params": [ { "name": "includeSchedulingDefaultMessageSeverities", "value": "", "type": "query", "description": "Whether to include scheduling default message severities" } ] }, "docs": "It may take a minute or two for a new business unit to be available for api operations" }, { "info": { "name": "Get business units across divisions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/divisionviews", "params": [ { "name": "divisionId", "value": "", "type": "query", "description": "The divisionIds to filter by. If omitted, will return business units in all divisions" } ] }, "docs": "Get business units across divisions" }, { "info": { "name": "Get management unit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "expand", "value": "", "type": "query" } ] }, "docs": "settings.shortTermForecasting is deprecated and now lives on the business unit" }, { "info": { "name": "Update the requested management unit", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." } ] }, "docs": "Update the requested management unit" }, { "info": { "name": "Delete management unit", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." } ] }, "docs": "Delete management unit" }, { "info": { "name": "Move the requested management unit to a new business unit", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/move", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." } ] }, "docs": "Returns status 200 if the management unit is already in the requested business unit" }, { "info": { "name": "Get management units", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Deprecated, paging is not supported" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Deprecated, paging is not supported" }, { "name": "expand", "value": "", "type": "query", "description": "Deprecated, expand settings on the single MU route" }, { "name": "feature", "value": "", "type": "query", "description": "If specified, the list of management units for which the user is authorized to use the requested feature will be returned" }, { "name": "divisionId", "value": "", "type": "query", "description": "If specified, the list of management units belonging to the specified division will be returned" } ] }, "docs": "Get management units" }, { "info": { "name": "Add a management unit", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits" }, "docs": "It may take a minute or two for a new management unit to be available for api operations" }, { "info": { "name": "Get management units across divisions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/divisionviews", "params": [ { "name": "divisionId", "value": "", "type": "query", "description": "The divisionIds to filter by. If omitted, will return all divisions" } ] }, "docs": "Get management units across divisions" }, { "info": { "name": "Get data for agent in the management unit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/agents/:agentId", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "agentId", "value": "", "type": "path", "description": "The agent id" }, { "name": "excludeCapabilities", "value": "", "type": "query", "description": "Excludes all capabilities of the agent such as queues, languages, and skills" }, { "name": "expand", "value": "", "type": "query" } ] }, "docs": "Get data for agent in the management unit" }, { "info": { "name": "Gets all the shift trades for a given agent", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/agents/:agentId/shifttrades", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "agentId", "value": "", "type": "path", "description": "The agent id" } ] }, "docs": "Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/query/jobs)" }, { "info": { "name": "Update agent configurations", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/agents", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." } ] }, "docs": "Update agent configurations" }, { "info": { "name": "Get agents work plans configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/agents/workplans/query", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Get agents work plans configuration" }, { "info": { "name": "Updates agent work plan configuration", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/agents/workplans/bulk", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." } ] }, "docs": "Updates agent work plan configuration" }, { "info": { "name": "Get users in the management unit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/users", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." } ] }, "docs": "Get users in the management unit" }, { "info": { "name": "Get a planning group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/planninggroups/:planningGroupId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit." }, { "name": "planningGroupId", "value": "", "type": "path", "description": "The ID of a planning group to fetch" } ] }, "docs": "Get a planning group" }, { "info": { "name": "Updates the planning group", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/planninggroups/:planningGroupId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit." }, { "name": "planningGroupId", "value": "", "type": "path", "description": "The ID of a planning group to update" } ] }, "docs": "If the request body contains queue references in route paths, routing:queue:view is required in each referenced queue's division." }, { "info": { "name": "Deletes the planning group", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/planninggroups/:planningGroupId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit." }, { "name": "planningGroupId", "value": "", "type": "path", "description": "The ID of a planning group to delete" } ] }, "docs": "Deletes the planning group" }, { "info": { "name": "Gets list of planning groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/planninggroups", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit." } ] }, "docs": "Gets list of planning groups" }, { "info": { "name": "Adds a new planning group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/planninggroups", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit." } ] }, "docs": "If the request body contains queue references in route paths, routing:queue:view is required in each referenced queue's division." }, { "info": { "name": "Get a service goal template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/servicegoaltemplates/:serviceGoalTemplateId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit." }, { "name": "serviceGoalTemplateId", "value": "", "type": "path", "description": "The ID of a service goal template to fetch" }, { "name": "expand", "value": "", "type": "query", "description": "Include to access additional data on the service goal template" } ] }, "docs": "Get a service goal template" }, { "info": { "name": "Updates a service goal template", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/servicegoaltemplates/:serviceGoalTemplateId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit." }, { "name": "serviceGoalTemplateId", "value": "", "type": "path", "description": "The ID of a service goal template to update" } ] }, "docs": "Updates a service goal template" }, { "info": { "name": "Delete a service goal template", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/servicegoaltemplates/:serviceGoalTemplateId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit." }, { "name": "serviceGoalTemplateId", "value": "", "type": "path", "description": "The ID of the service goal template to delete" } ] }, "docs": "Delete a service goal template" }, { "info": { "name": "Gets list of service goal templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/servicegoaltemplates", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit." }, { "name": "expand", "value": "", "type": "query", "description": "Include to access additional data on the service goal template" } ] }, "docs": "Gets list of service goal templates" }, { "info": { "name": "Adds a new service goal template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/servicegoaltemplates", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit." } ] }, "docs": "Adds a new service goal template" }, { "info": { "name": "Gets list of users available for whom you can send direct shift trade requests", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/shifttrades/users", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." } ] }, "docs": "Gets list of users available for whom you can send direct shift trade requests" }, { "info": { "name": "Gets a summary of all shift trades in the matched state", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/shifttrades/matched", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." } ] }, "docs": "Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs)" }, { "info": { "name": "Gets a list of staffing groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/staffinggroups", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "managementUnitId", "value": "", "type": "query", "description": "The ID of the management unit to get management unit specific staffing groups" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Gets a list of staffing groups" }, { "info": { "name": "Creates a new staffing group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/staffinggroups", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Creates a new staffing group" }, { "info": { "name": "Gets a staffing group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/staffinggroups/:staffingGroupId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "staffingGroupId", "value": "", "type": "path", "description": "The ID of the staffing group to fetch" } ] }, "docs": "Gets a staffing group" }, { "info": { "name": "Updates a staffing group", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/staffinggroups/:staffingGroupId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "staffingGroupId", "value": "", "type": "path", "description": "The ID of the staffing group to update" } ] }, "docs": "Updates a staffing group" }, { "info": { "name": "Deletes a staffing group", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/staffinggroups/:staffingGroupId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "staffingGroupId", "value": "", "type": "path", "description": "The ID of the staffing group to delete" } ] }, "docs": "Deletes a staffing group" }, { "info": { "name": "Gets a list of planning group to staffing groups list association", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/staffinggroups/planninggroups/query", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Gets a list of planning group to staffing groups list association" }, { "info": { "name": "Gets staffing group associations for a list of user IDs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/staffinggroups/query", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service" } ] }, "docs": "Gets staffing group associations for a list of user IDs" }, { "info": { "name": "Searches for potential shift trade matches for the current agent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/weeks/:weekDateId/shifttrades/search", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "weekDateId", "value": "", "type": "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" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs)" }, { "info": { "name": "Gets all the shift trades for a given week", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/weeks/:weekDateId/shifttrades", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "weekDateId", "value": "", "type": "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" }, { "name": "evaluateMatches", "value": "", "type": "query", "description": "Whether to evaluate the matches for violations" }, { "name": "includeCrossWeekShifts", "value": "", "type": "query", "description": "Whether to include all shift trades with either the initiating shift or the receiving shift in the week" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs)" }, { "info": { "name": "Adds a shift trade", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/weeks/:weekDateId/shifttrades", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "weekDateId", "value": "", "type": "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" } ] }, "docs": "Deprecated. Use new route instead (/shifttrading/trades/jobs)" }, { "info": { "name": "Updates the state of a batch of shift trades", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/weeks/:weekDateId/shifttrades/state/bulk", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "weekDateId", "value": "", "type": "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" }, { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" } ] }, "docs": "Admin functionality is not supported with \"mine\". Deprecated. Use new route instead (/businessunits/{buId}/shifttrading/trades/state/bulk/jobs)" }, { "info": { "name": "Updates a shift trade. This route can only be called by the initiating agent", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/weeks/:weekDateId/shifttrades/:tradeId", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "weekDateId", "value": "", "type": "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" }, { "name": "tradeId", "value": "", "type": "path", "description": "The ID of the shift trade to update" } ] }, "docs": "Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/jobs)" }, { "info": { "name": "Matches a shift trade. This route can only be called by the receiving agent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/weeks/:weekDateId/shifttrades/:tradeId/match", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "weekDateId", "value": "", "type": "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" }, { "name": "tradeId", "value": "", "type": "path", "description": "The ID of the shift trade to update" } ] }, "docs": "Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/match/jobs)" }, { "info": { "name": "Move agents in and out of management unit", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/agents" }, "docs": "Move agents in and out of management unit" }, { "info": { "name": "Get the management unit to which the agent belongs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/agents/:agentId/managementunit", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The ID of the agent to look up" } ] }, "docs": "Get the management unit to which the agent belongs" }, { "info": { "name": "Get the management unit to which the currently logged in agent belongs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/agents/me/managementunit" }, "docs": "Get the management unit to which the currently logged in agent belongs" }, { "info": { "name": "Validate Work Plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/workplans/:workPlanId/validate", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "workPlanId", "value": "", "type": "path", "description": "The ID of the work plan to validate. For new work plan, use the word 'new' for the ID." }, { "name": "expand", "value": "", "type": "query" } ] }, "docs": "Validate Work Plan" }, { "info": { "name": "Get a work plan", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/workplans/:workPlanId", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "workPlanId", "value": "", "type": "path", "description": "The ID of the work plan to fetch" }, { "name": "includeOnly", "value": "", "type": "query", "description": "limit response to the specified fields" } ] }, "docs": "Get a work plan" }, { "info": { "name": "Update a work plan", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/workplans/:workPlanId", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "workPlanId", "value": "", "type": "path", "description": "The ID of the work plan to update" }, { "name": "validationMode", "value": "", "type": "query", "description": "Allows to update work plan even if validation result is invalid" } ] }, "docs": "Update a work plan" }, { "info": { "name": "Delete a work plan", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/workplans/:workPlanId", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "workPlanId", "value": "", "type": "path", "description": "The ID of the work plan to delete" } ] }, "docs": "Delete a work plan" }, { "info": { "name": "Get work plans", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/workplans", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "expand", "value": "", "type": "query", "description": "Include to access additional data on the work plans" }, { "name": "exclude", "value": "", "type": "query", "description": "Exclude specific data on the work plans from the response" } ] }, "docs": "\"expand=details\" is deprecated" }, { "info": { "name": "Create a new work plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/workplans", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "validationMode", "value": "", "type": "query", "description": "Allows to create work plan even if the validation result is invalid" } ] }, "docs": "Create a new work plan" }, { "info": { "name": "Create a copy of work plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/workplans/:workPlanId/copy", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "workPlanId", "value": "", "type": "path", "description": "The ID of the work plan to create a copy" } ] }, "docs": "Create a copy of work plan" }, { "info": { "name": "Get work plan rotations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/workplanrotations", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "expand", "value": "", "type": "query" } ] }, "docs": "Get work plan rotations" }, { "info": { "name": "Create a new work plan rotation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/workplanrotations", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." } ] }, "docs": "Create a new work plan rotation" }, { "info": { "name": "Get a work plan rotation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/workplanrotations/:workPlanRotationId", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "workPlanRotationId", "value": "", "type": "path", "description": "The ID of the work plan rotation to fetch" } ] }, "docs": "Get a work plan rotation" }, { "info": { "name": "Update a work plan rotation", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/workplanrotations/:workPlanRotationId", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "workPlanRotationId", "value": "", "type": "path", "description": "The ID of the work plan rotation to update" } ] }, "docs": "Update a work plan rotation" }, { "info": { "name": "Delete a work plan rotation", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/workplanrotations/:workPlanRotationId", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "workPlanRotationId", "value": "", "type": "path", "description": "The ID of the work plan rotation to be deleted" } ] }, "docs": "Delete a work plan rotation" }, { "info": { "name": "Create a copy of work plan rotation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/workplanrotations/:workPlanRotationId/copy", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "workPlanRotationId", "value": "", "type": "path", "description": "The ID of the work plan rotation to create a copy" } ] }, "docs": "Create a copy of work plan rotation" }, { "info": { "name": "Gets the latest job for all activity plans in the business unit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/activityplans/jobs", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Gets the latest job for all activity plans in the business unit" }, { "info": { "name": "Get activity plans", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/activityplans", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "state", "value": "", "type": "query", "description": "Optionally filter by activity plan state" } ] }, "docs": "Get activity plans" }, { "info": { "name": "Create an activity plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/activityplans", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Create an activity plan" }, { "info": { "name": "Get an activity plan", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/activityplans/:activityPlanId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "activityPlanId", "value": "", "type": "path", "description": "The ID of the activity plan to fetch" } ] }, "docs": "Get an activity plan" }, { "info": { "name": "Update an activity plan", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/activityplans/:activityPlanId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "activityPlanId", "value": "", "type": "path", "description": "The ID of the activity plan to update" } ] }, "docs": "If a job associated with the activity plan is in 'Processing' state the activity plan cannot be updated" }, { "info": { "name": "Run an activity plan manually", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/activityplans/:activityPlanId/runs/jobs", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "activityPlanId", "value": "", "type": "path", "description": "The ID of the activity plan to run" } ] }, "docs": "Triggers a job running the activity plan. The activity plan cannot be updated until the job completes" }, { "info": { "name": "Gets an activity plan run job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/activityplans/:activityPlanId/runs/jobs/:jobId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "activityPlanId", "value": "", "type": "path", "description": "The ID of the activity plan associated with the run job" }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the activity plan run job" } ] }, "docs": "Gets an activity plan run job" }, { "info": { "name": "Query the status of an adherence explanation operation. Only the user who started the operation can query the status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/adherence/explanations/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job" } ] }, "docs": "Job details are only retained if the initial request returned a 202 ACCEPTED response" }, { "info": { "name": "Add an adherence explanation for the requested user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/agents/:agentId/adherence/explanations", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The ID of the agent to query" } ] }, "docs": "Add an adherence explanation for the requested user" }, { "info": { "name": "Get an adherence explanation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/agents/:agentId/adherence/explanations/:explanationId", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The ID of the agent to query" }, { "name": "explanationId", "value": "", "type": "path", "description": "The ID of the explanation to update" } ] }, "docs": "Get an adherence explanation" }, { "info": { "name": "Update an adherence explanation", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/agents/:agentId/adherence/explanations/:explanationId", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The ID of the agent to query" }, { "name": "explanationId", "value": "", "type": "path", "description": "The ID of the explanation to update" } ] }, "docs": "Update an adherence explanation" }, { "info": { "name": "Query adherence explanations for the given agent across a specified range", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/agents/:agentId/adherence/explanations/query", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The ID of the agent to query" }, { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Query adherence explanations for the given agent across a specified range" }, { "info": { "name": "Query adherence explanations across an entire business unit for the requested period", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/adherence/explanations/query", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Query adherence explanations across an entire business unit for the requested period" }, { "info": { "name": "Submit an adherence explanation for the current user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/adherence/explanations" }, "docs": "Submit an adherence explanation for the current user" }, { "info": { "name": "Get an adherence explanation for the current user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/adherence/explanations/:explanationId", "params": [ { "name": "explanationId", "value": "", "type": "path", "description": "The ID of the explanation to update" } ] }, "docs": "Get an adherence explanation for the current user" }, { "info": { "name": "Query adherence explanations for the current user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/adherence/explanations/query", "params": [ { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Query adherence explanations for the current user" }, { "info": { "name": "Request to fetch the status of the agent adherence job. Only the user who started the operation can query the status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/agents/me/adherence/historical/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "ID of the job to get" } ] }, "docs": "Job details are only retained if the initial request returned a 202 ACCEPTED response" }, { "info": { "name": "Request an agent historical adherence report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/agents/me/adherence/historical/jobs", "params": [ { "name": "expand", "value": "", "type": "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." } ] }, "docs": "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" }, { "info": { "name": "Request a historical adherence report in bulk", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/adherence/historical/bulk" }, "docs": "Request a historical adherence report in bulk" }, { "info": { "name": "Request to fetch the status of the historical adherence bulk job. Only the user who started the operation can query the status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/adherence/historical/bulk/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "ID of the job to get" } ] }, "docs": "Job details are only retained if the initial request returned a 202 ACCEPTED response" }, { "info": { "name": "Query the status of a historical adherence request operation. Only the user who started the operation can query the status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/adherence/historical/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Job details are only retained if the initial request returned a 202 ACCEPTED response" }, { "info": { "name": "Request a historical adherence report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/historicaladherencequery", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit" } ] }, "docs": "The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true" }, { "info": { "name": "Request a teams historical adherence report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/teams/:teamId/adherence/historical", "params": [ { "name": "teamId", "value": "", "type": "path", "description": "The ID of the team" } ] }, "docs": "The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true" }, { "info": { "name": "Get a list of user schedule adherence records for the requested management unit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/adherence", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Get a list of user schedule adherence records for the requested management unit" }, { "info": { "name": "Get a list of user schedule adherence records for the requested team", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/teams/:teamId/adherence", "params": [ { "name": "teamId", "value": "", "type": "path", "description": "The ID of the team" } ] }, "docs": "Get a list of user schedule adherence records for the requested team" }, { "info": { "name": "Get a list of UserScheduleAdherence records for the requested users", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/adherence", "params": [ { "name": "userId", "value": "", "type": "query", "description": "User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request" } ] }, "docs": "Get a list of UserScheduleAdherence records for the requested users" }, { "info": { "name": "Get agent possible work shifts for requested time frame", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/agents/me/possibleworkshifts" }, "docs": "Get agent possible work shifts for requested time frame" }, { "info": { "name": "Query availability management units settings", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/unavailabletimes/settings/query", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Query availability management units settings" }, { "info": { "name": "Get agent schedule generation unavailable times", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/unavailabletimes/schedules/query", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Get agent schedule generation unavailable times" }, { "info": { "name": "Update management unit availability settings", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/unavailabletimes/settings", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit" } ] }, "docs": "Update management unit availability settings" }, { "info": { "name": "Get agent unavailable times", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/agents/:agentId/unavailabletimes/query", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The ID of the agent" } ] }, "docs": "Get agent unavailable times" }, { "info": { "name": "Get alternative shifts settings for a business unit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/alternativeshifts/settings", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Get alternative shifts settings for a business unit" }, { "info": { "name": "Update alternative shifts settings for a business unit", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/alternativeshifts/settings", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Update alternative shifts settings for a business unit" }, { "info": { "name": "List alternative shifts trades for a given management unit or agent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/alternativeshifts/trades/search", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" } ] }, "docs": "List alternative shifts trades for a given management unit or agent" }, { "info": { "name": "Query the status of an alternative shift search trade operation. Only the user who started the operation can query the status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/alternativeshifts/trades/search/jobs/:jobId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job" } ] }, "docs": "Job details are only retained if the initial request returned a 202 ACCEPTED response" }, { "info": { "name": "Get an alternative shifts trade in a business unit for a given trade ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/alternativeshifts/trades/:tradeId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "tradeId", "value": "", "type": "path", "description": "The ID of the alternative shift trade" } ] }, "docs": "Get an alternative shifts trade in a business unit for a given trade ID" }, { "info": { "name": "Request a list of alternative shift offers for a given schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/alternativeshifts/offers/jobs" }, "docs": "Request a list of alternative shift offers for a given schedule" }, { "info": { "name": "Query the status of an alternative shift offers operation. Only the user who started the operation can query the status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/alternativeshifts/offers/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job" } ] }, "docs": "Job details are only retained if the initial request returned a 202 ACCEPTED response" }, { "info": { "name": "Request a search of alternative shift offers for a given shift", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs" }, "docs": "Request a search of alternative shift offers for a given shift" }, { "info": { "name": "Query the status of an alternative shift search offers operation. Only the user who started the operation can query the status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job" } ] }, "docs": "Job details are only retained if the initial request returned a 202 ACCEPTED response" }, { "info": { "name": "Get a list of my alternative shifts trades", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/alternativeshifts/trades", "params": [ { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" } ] }, "docs": "Get a list of my alternative shifts trades" }, { "info": { "name": "Create my alternative shift trade using an existing offer's jobId", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/alternativeshifts/trades" }, "docs": "Create my alternative shift trade using an existing offer's jobId" }, { "info": { "name": "Query the status of an alternative shift trades operation. Only the user who started the operation can query the status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/alternativeshifts/trades/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job" } ] }, "docs": "Job details are only retained if the initial request returned a 202 ACCEPTED response" }, { "info": { "name": "Get my alternative shift trade by trade ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/alternativeshifts/trades/:tradeId", "params": [ { "name": "tradeId", "value": "", "type": "path", "description": "The ID of the alternative shift trade" } ] }, "docs": "Get my alternative shift trade by trade ID" }, { "info": { "name": "Update my alternative shifts trade by trade ID", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/alternativeshifts/trades/:tradeId", "params": [ { "name": "tradeId", "value": "", "type": "path", "description": "The ID of the alternative shift trade" } ] }, "docs": "Update my alternative shifts trade by trade ID" }, { "info": { "name": "Bulk update alternative shift trade states", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs" }, "docs": "Bulk update alternative shift trade states" }, { "info": { "name": "Query the status of an alternative shift trade state operation. Only the user who started the operation can query the status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job" } ] }, "docs": "Job details are only retained if the initial request returned a 202 ACCEPTED response" }, { "info": { "name": "Get existing calendar link for the current user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/calendar/url/ics" }, "docs": "Get existing calendar link for the current user" }, { "info": { "name": "Create a newly generated calendar link for the current user; if the current user has previously generated one, the generated link will be returned", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/calendar/url/ics", "params": [ { "name": "language", "value": "", "type": "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" } ] }, "docs": "Create a newly generated calendar link for the current user; if the current user has previously generated one, the generated link will be returned" }, { "info": { "name": "Disable generated calendar link for the current user", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/calendar/url/ics" }, "docs": "Disable generated calendar link for the current user" }, { "info": { "name": "Get a capacity plan", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/capacityplans/:capacityPlanId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "capacityPlanId", "value": "", "type": "path", "description": "The ID of the capacity plan" } ] }, "docs": "Get a capacity plan" }, { "info": { "name": "Update a capacity plan configuration", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/capacityplans/:capacityPlanId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "capacityPlanId", "value": "", "type": "path", "description": "The ID of the capacity plan" } ] }, "docs": "Update a capacity plan configuration" }, { "info": { "name": "Get list of capacity plans for a business unit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/capacityplans", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Get list of capacity plans for a business unit" }, { "info": { "name": "Create a new capacity plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/capacityplans", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Create a new capacity plan" }, { "info": { "name": "Delete capacity plans in a business unit", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/capacityplans/bulk/remove", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Delete capacity plans in a business unit" }, { "info": { "name": "Get a capacity plan's staffing group allocations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/capacityplans/:capacityPlanId/staffinggroupallocations", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "capacityPlanId", "value": "", "type": "path", "description": "The ID of the capacity plan" }, { "name": "granularity", "value": "", "type": "query", "description": "Granularity to access staffing group data, defaults to weekly" } ] }, "docs": "Get a capacity plan's staffing group allocations" }, { "info": { "name": "Create staffing group allocations for a capacity plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/capacityplans/:capacityPlanId/staffinggroupallocations", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "capacityPlanId", "value": "", "type": "path", "description": "The ID of the capacity plan" } ] }, "docs": "Create staffing group allocations for a capacity plan" }, { "info": { "name": "Get a capacity plan's staffing requirements", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/capacityplans/:capacityPlanId/staffingrequirements", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "capacityPlanId", "value": "", "type": "path", "description": "The ID of the capacity plan" } ] }, "docs": "Get a capacity plan's staffing requirements" }, { "info": { "name": "Copy a capacity plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/capacityplans/:capacityPlanId/copy", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "capacityPlanId", "value": "", "type": "path", "description": "The ID of the capacity plan" } ] }, "docs": "Copy a capacity plan" }, { "info": { "name": "Regenerate requirements for capacity plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/capacityplans/:capacityPlanId/requirement/generate", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "capacityPlanId", "value": "", "type": "path", "description": "The ID of the capacity plan" } ] }, "docs": "Regenerate requirements for capacity plan" }, { "info": { "name": "Query staffing groups allocations history for a capacity plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/capacityplans/:capacityPlanId/staffinggroupallocationshistory/query", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "capacityPlanId", "value": "", "type": "path", "description": "The ID of the capacity plan" } ] }, "docs": "Query staffing groups allocations history for a capacity plan" }, { "info": { "name": "Delete staffing group allocations history created for a capacity plan before the given date", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/capacityplans/:capacityPlanId/staffinggroupallocationshistory", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "capacityPlanId", "value": "", "type": "path", "description": "The ID of the capacity plan" }, { "name": "beforeDateId", "value": "", "type": "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" } ] }, "docs": "Delete staffing group allocations history created for a capacity plan before the given date" }, { "info": { "name": "Get a capacity plan's forecast inputs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/capacityplans/:capacityPlanId/forecast", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "capacityPlanId", "value": "", "type": "path", "description": "The ID of the capacity plan" }, { "name": "granularity", "value": "", "type": "query", "description": "Granularity to access capacity plan forecast data, defaults to weekly" } ] }, "docs": "Get a capacity plan's forecast inputs" }, { "info": { "name": "Get the latest long term staffing requirements for a business unit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/capacityplanning/longtermrequirements/automaticbestmethod/weeks/:weekDateId/forecasts/:forecastId", "params": [ { "name": "businessUnitId", "value": "", "type": "path" }, { "name": "weekDateId", "value": "", "type": "path", "description": "weekDateId of forecast, format yyyy-MM-dd. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "forecastId", "value": "", "type": "path", "description": "forecastId of forecast" }, { "name": "granularity", "value": "", "type": "query", "description": "Granularity to access staffing requirements data, defaults to weekly" } ] }, "docs": "Get the latest long term staffing requirements for a business unit" }, { "info": { "name": "Force regenerate the latest long term staffing requirements for a business unit", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/capacityplanning/longtermrequirements/automaticbestmethod/weeks/:weekDateId/forecasts/:forecastId/forceregenerate", "params": [ { "name": "businessUnitId", "value": "", "type": "path" }, { "name": "weekDateId", "value": "", "type": "path", "description": "weekDateId of forecast, format yyyy-MM-dd. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "forecastId", "value": "", "type": "path", "description": "forecastId of forecast" } ] }, "docs": "Force regenerate the latest long term staffing requirements for a business unit" }, { "info": { "name": "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", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/schedulebids" }, "docs": "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" }, { "info": { "name": "Gets an agent's schedule bidding preference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/schedulebids/:bidId/preference", "params": [ { "name": "bidId", "value": "", "type": "path", "description": "The ID of the schedule bid" } ] }, "docs": "Gets an agent's schedule bidding preference" }, { "info": { "name": "Update an agent's schedule set preference", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/workforcemanagement/schedulebids/:bidId/preference", "params": [ { "name": "bidId", "value": "", "type": "path", "description": "The ID of the schedule bid" } ] }, "docs": "Update an agent's schedule set preference" }, { "info": { "name": "Gets an agent's schedule sets for a bid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/schedulebids/:bidId/schedulesets", "params": [ { "name": "bidId", "value": "", "type": "path", "description": "The ID of the schedule bid" } ] }, "docs": "Gets an agent's schedule sets for a bid" }, { "info": { "name": "Queries available time off for the current user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/timeofflimits/available/query" }, "docs": "Queries available time off for the current user" }, { "info": { "name": "Get the daily waitlist positions of a time off request for the current user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/timeoffrequests/:timeOffRequestId/waitlistpositions", "params": [ { "name": "timeOffRequestId", "value": "", "type": "path", "description": "The ID of the time off request" } ] }, "docs": "Get the daily waitlist positions of a time off request for the current user" }, { "info": { "name": "Get a list of time off requests for the current user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/timeoffrequests" }, "docs": "Get a list of time off requests for the current user" }, { "info": { "name": "Create a time off request for the current user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/timeoffrequests" }, "docs": "Create a time off request for the current user" }, { "info": { "name": "Get a time off request for the current user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/timeoffrequests/:timeOffRequestId", "params": [ { "name": "timeOffRequestId", "value": "", "type": "path", "description": "The ID of the time off request" } ] }, "docs": "Get a time off request for the current user" }, { "info": { "name": "Update a time off request for the current user", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/timeoffrequests/:timeOffRequestId", "params": [ { "name": "timeOffRequestId", "value": "", "type": "path", "description": "The ID of the time off request" } ] }, "docs": "Update a time off request for the current user" }, { "info": { "name": "Update agent unavailable times", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/unavailabletimes" }, "docs": "Update agent unavailable times" }, { "info": { "name": "Validates proposed changes to an agent's unavailable time spans against scheduling rules and constraints for a specific week", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/unavailabletimes/validation/jobs" }, "docs": "Validates proposed changes to an agent's unavailable time spans against scheduling rules and constraints for a specific week" }, { "info": { "name": "Get agent unavailable times", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/unavailabletimes/query" }, "docs": "Get agent unavailable times" }, { "info": { "name": "Get availability management unit's settings for agent", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/unavailabletimes/settings" }, "docs": "Get availability management unit's settings for agent" }, { "info": { "name": "Query agent unavailable times validation job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/unavailabletimes/validation/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job" } ] }, "docs": "Query agent unavailable times validation job" }, { "info": { "name": "Gets an agent's work plan bidding preference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/workplanbids/:bidId/preferences", "params": [ { "name": "bidId", "value": "", "type": "path", "description": "The ID of the work plan bid" } ] }, "docs": "Gets an agent's work plan bidding preference" }, { "info": { "name": "Update an agent's work plan bidding preference", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/workplanbids/:bidId/preferences", "params": [ { "name": "bidId", "value": "", "type": "path", "description": "The ID of the work plan bid" } ] }, "docs": "Update an agent's work plan bidding preference" }, { "info": { "name": "Gets an agent's work plans for a bid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/workplanbids/:bidId/workplans", "params": [ { "name": "bidId", "value": "", "type": "path", "description": "The ID of the work plan bid" } ] }, "docs": "Gets an agent's work plans for a bid" }, { "info": { "name": "Gets the list of work plan bids that belong to an agent", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/workplanbids" }, "docs": "Gets the list of work plan bids that belong to an agent" }, { "info": { "name": "Get alternative shifts settings from the current logged in agent’s business unit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/alternativeshifts/settings" }, "docs": "Get alternative shifts settings from the current logged in agent’s business unit" }, { "info": { "name": "Get published schedule for the current user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/agentschedules/mine" }, "docs": "Get published schedule for the current user" }, { "info": { "name": "Fetch agent schedules for the logged in user's management unit", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/agentschedules/managementunits/mine", "params": [ { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Fetch agent schedules for the logged in user's management unit" }, { "info": { "name": "Get published schedule for the current user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/schedules" }, "docs": "Get published schedule for the current user" }, { "info": { "name": "Gets all of my shift trades", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/shifttrades" }, "docs": "Deprecated. Use new route instead (/shifttrading/trades/mine/query/jobs)" }, { "info": { "name": "Retrieves integration statuses for a list of current user time off requests", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/timeoffrequests/integrationstatus/query" }, "docs": "Retrieves integration statuses for a list of current user time off requests" }, { "info": { "name": "Get a list of notifications for the current user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/notifications" }, "docs": "Notifications are only initially sent if you have the relevant Notify and Edit permissions" }, { "info": { "name": "Mark a list of notifications as read or unread", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/notifications/update" }, "docs": "Mark a list of notifications as read or unread" }, { "info": { "name": "Retrieves delete job status for historical data imports associated with the job id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID of the historical data delete request" } ] }, "docs": "Retrieves delete job status for historical data imports associated with the job id" }, { "info": { "name": "Retrieves all delete job status for historical data", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs" }, "docs": "Retrieves all delete job status for historical data" }, { "info": { "name": "Delete the list of the historical data import entries", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs" }, "docs": "Delete the list of the historical data import entries" }, { "info": { "name": "Retrieves status of the historical data imports associated with job id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/historicaldata/importstatus/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job Id of the historical data import request" } ] }, "docs": "Retrieves status of the historical data imports associated with job id" }, { "info": { "name": "Retrieves status of the historical data imports of the organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/historicaldata/importstatus" }, "docs": "Retrieves status of the historical data imports of the organization" }, { "info": { "name": "Trigger validation process for historical import", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/historicaldata/validate" }, "docs": "Trigger validation process for historical import" }, { "info": { "name": "Query integrations for agents", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/agents/integrations/hris/query" }, "docs": "Query integrations for agents" }, { "info": { "name": "Update integrations for agent", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/workforcemanagement/agents/:agentId/integrations/hris", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The ID of the agent" } ] }, "docs": "Update integrations for agent" }, { "info": { "name": "Query the results of time off types job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/integrations/hris/timeofftypes/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job." } ] }, "docs": "Query the results of time off types job" }, { "info": { "name": "Get integrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/integrations/hris" }, "docs": "Get integrations" }, { "info": { "name": "Get list of time off types configured in integration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/integrations/hris/:hrisIntegrationId/timeofftypes/jobs", "params": [ { "name": "hrisIntegrationId", "value": "", "type": "path", "description": "The ID of the HRIS integration for which time off types are queried." } ] }, "docs": "Get list of time off types configured in integration" }, { "info": { "name": "Get minimum staffing settings for a business unit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/minimumstaffing/settings", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Get minimum staffing settings for a business unit" }, { "info": { "name": "Update minimum staffing settings for a business unit", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/minimumstaffing/settings", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Update minimum staffing settings for a business unit" }, { "info": { "name": "Bulk add enrollments to opportunities for the authenticated agent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/add" }, "docs": "Allows an agent to enroll in opportunities. This endpoint can return partial success." }, { "info": { "name": "Bulk update enrollment status for the authenticated agent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/statuses/update" }, "docs": "Allows an agent to update the status of their enrollments (e.g. withdraw). Returns partial success if some enrollments cannot be updated." }, { "info": { "name": "Query opportunities for the authenticated agent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/agents/opportunities/query", "params": [ { "name": "expand", "value": "", "type": "query", "description": "List of resources to expand" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Queries within the specified date range. Each opportunity includes the agent's enrollment details if they have enrolled." }, { "info": { "name": "Bulk update enrollment status", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/opportunities/enrollments/bulk/statuses/update", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Updates the status of enrollments (approve/deny). Returns partial success if some enrollments cannot be updated." }, { "info": { "name": "Query enrollments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/opportunities/enrollments/query", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "expand", "value": "", "type": "query", "description": "List of resources to expand" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "For more information about opportunities, use the expand parameter." }, { "info": { "name": "Query opportunities within the specified date range", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/opportunities/query", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Query opportunities within the specified date range" }, { "info": { "name": "Query opportunities by external activity IDs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/opportunities/externalactivities/query", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Query opportunities by external activity IDs" }, { "info": { "name": "Bulk add opportunities", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/opportunities/bulk/add", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Bulk add opportunities" }, { "info": { "name": "Bulk remove opportunities", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/opportunities/bulk/remove", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "This operation is permanent and cannot be undone. Returns partial success if some opportunities cannot be removed." }, { "info": { "name": "Bulk publish opportunities", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/opportunities/bulk/publish", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Published opportunities become available for agent enrollment when they open. Returns partial success if some opportunities cannot be published." }, { "info": { "name": "Bulk update opportunities status", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/opportunities/bulk/statuses/update", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "If status is Closed, pending enrollments are automatically denied; approved enrollments remain in schedules. Returns partial success if some opportunities cannot be updated." }, { "info": { "name": "Get opportunity details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/opportunities/:opportunityId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "opportunityId", "value": "", "type": "path", "description": "The ID of the opportunity" }, { "name": "expand", "value": "", "type": "query", "description": "List of resources to expand" } ] }, "docs": "Get opportunity details" }, { "info": { "name": "Update the opportunity", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/opportunities/:opportunityId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "opportunityId", "value": "", "type": "path", "description": "The ID of the opportunity" } ] }, "docs": "Only opportunities with Draft status can be updated." }, { "info": { "name": "Request a daily recalculation of the performance prediction for the associated schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekId/schedules/:scheduleId/performancepredictions/recalculations", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit to which the performance prediction belongs" }, { "name": "weekId", "value": "", "type": "path", "description": "First day of schedule week in yyyy-MM-dd format" }, { "name": "scheduleId", "value": "", "type": "path", "description": "The ID of the schedule the performance prediction belongs to" } ] }, "docs": "Request a daily recalculation of the performance prediction for the associated schedule" }, { "info": { "name": "Get recalculated performance prediction result", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekId/schedules/:scheduleId/performancepredictions/recalculations/:recalculationId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit to which the performance prediction belongs" }, { "name": "weekId", "value": "", "type": "path", "description": "First day of schedule week in yyyy-MM-dd format" }, { "name": "scheduleId", "value": "", "type": "path", "description": "The ID of the schedule the recalculation belongs to" }, { "name": "recalculationId", "value": "", "type": "path", "description": "The ID of the recalculation request" } ] }, "docs": "Get recalculated performance prediction result" }, { "info": { "name": "Get the performance prediction for the associated schedule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekId/schedules/:scheduleId/performancepredictions", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit to which the performance prediction belongs" }, { "name": "weekId", "value": "", "type": "path", "description": "First day of schedule week in yyyy-MM-dd format" }, { "name": "scheduleId", "value": "", "type": "path", "description": "The ID of the schedule the performance prediction belongs to" } ] }, "docs": "Get the performance prediction for the associated schedule" }, { "info": { "name": "Upload daily activity changes to be able to request a performance prediction recalculation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekId/schedules/:scheduleId/performancepredictions/recalculations/uploadurl", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit to which the performance prediction belongs" }, { "name": "weekId", "value": "", "type": "path", "description": "First day of schedule week in yyyy-MM-dd format" }, { "name": "scheduleId", "value": "", "type": "path", "description": "The ID of the schedule the performance prediction belongs to" } ] }, "docs": "Upload daily activity changes to be able to request a performance prediction recalculation" }, { "info": { "name": "Get summary of bid groups that belong to a schedule bid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/schedulebids/:bidId/groups/summary", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The ID of the schedule bid associated with the bid groups" } ] }, "docs": "Get summary of bid groups that belong to a schedule bid" }, { "info": { "name": "Get a schedule bid group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/schedulebids/:bidId/groups/:bidGroupId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The ID of the schedule bid associated with the bid groups" }, { "name": "bidGroupId", "value": "", "type": "path", "description": "Schedule Bid Group id" } ] }, "docs": "Get a schedule bid group" }, { "info": { "name": "Update a schedule bid group by bid group Id", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/schedulebids/:bidId/groups/:bidGroupId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The ID of the schedule bid associated with the bid groups" }, { "name": "bidGroupId", "value": "", "type": "path", "description": "Schedule Bid Group id" } ] }, "docs": "Update a schedule bid group by bid group Id" }, { "info": { "name": "Delete a schedule bid group by bid group Id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/schedulebids/:bidId/groups/:bidGroupId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The ID of the schedule bid associated with the bid groups" }, { "name": "bidGroupId", "value": "", "type": "path", "description": "Schedule Bid Group id" } ] }, "docs": "Delete a schedule bid group by bid group Id" }, { "info": { "name": "Add a bid group in a given schedule bid", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/schedulebids/:bidId/groups", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The ID of the schedule bid associated with the bid groups" } ] }, "docs": "Add a bid group in a given schedule bid" }, { "info": { "name": "Get agents schedule bid preferences for a bid group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/schedulebids/:bidId/groups/:bidGroupId/preferences", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The ID of the schedule bid associated with the bid groups" }, { "name": "bidGroupId", "value": "", "type": "path", "description": "The ID of the schedule bid group" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" }, { "name": "expand", "value": "", "type": "query", "description": "Include to fetch agents' preferences with priorities" } ] }, "docs": "Get agents schedule bid preferences for a bid group" }, { "info": { "name": "Overrides the assigned schedule bid for the specified agents", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/schedulebids/:bidId/groups/:bidGroupId/preferences", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The ID of the schedule bid associated with the bid groups" }, { "name": "bidGroupId", "value": "", "type": "path", "description": "The ID of the schedule bid group" } ] }, "docs": "Overrides the assigned schedule bid for the specified agents" }, { "info": { "name": "Get a schedule bid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/schedulebids/:bidId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The ID of the schedule bid" } ] }, "docs": "Get a schedule bid" }, { "info": { "name": "Update a schedule bid", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/schedulebids/:bidId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The ID of the schedule bid" } ] }, "docs": "Update a schedule bid" }, { "info": { "name": "Delete a schedule bid", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/schedulebids/:bidId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The ID of the schedule bid" } ] }, "docs": "Delete a schedule bid" }, { "info": { "name": "Get list of schedule bids", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/schedulebids", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Get list of schedule bids" }, { "info": { "name": "Create a new schedule bid", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/schedulebids", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Create a new schedule bid" }, { "info": { "name": "Copy a schedule bid", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/schedulebids/:bidId/copy", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The ID of the schedule bid to copy" } ] }, "docs": "Copy a schedule bid" }, { "info": { "name": "Fetch all the agents with effective schedule set for the given BU", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/schedulebids/effectiveschedulesets", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Fetch all the agents with effective schedule set for the given BU" }, { "info": { "name": "Get the list of scheduling runs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/scheduling/runs", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Get the list of scheduling runs" }, { "info": { "name": "Get a scheduling run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/scheduling/runs/:runId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "runId", "value": "", "type": "path", "description": "The ID of the schedule run" } ] }, "docs": "Get a scheduling run" }, { "info": { "name": "Mark a schedule run as applied", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/scheduling/runs/:runId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "runId", "value": "", "type": "path", "description": "The ID of the schedule run" } ] }, "docs": "Mark a schedule run as applied" }, { "info": { "name": "Cancel a scheduling run", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/scheduling/runs/:runId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "runId", "value": "", "type": "path", "description": "The ID of the schedule run" } ] }, "docs": "Cancel a scheduling run" }, { "info": { "name": "Get the result of a rescheduling operation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/scheduling/runs/:runId/result", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "runId", "value": "", "type": "path", "description": "The ID of the schedule run" }, { "name": "managementUnitIds", "value": "", "type": "query", "description": "The IDs of the management units for which to fetch the reschedule results" }, { "name": "expand", "value": "", "type": "query", "description": "The fields to expand. Omitting will return an empty response" } ] }, "docs": "Get the result of a rescheduling operation" }, { "info": { "name": "Search published schedules", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/agentschedules/search", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Search published schedules" }, { "info": { "name": "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", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekId/schedules/:scheduleId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "weekId", "value": "", "type": "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" }, { "name": "scheduleId", "value": "", "type": "path", "description": "The ID of the schedule" }, { "name": "expand", "value": "", "type": "query", "description": "expand" } ] }, "docs": "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" }, { "info": { "name": "Delete a schedule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekId/schedules/:scheduleId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "weekId", "value": "", "type": "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" }, { "name": "scheduleId", "value": "", "type": "path", "description": "The ID of the schedule" } ] }, "docs": "Delete a schedule" }, { "info": { "name": "Start a rescheduling run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekId/schedules/:scheduleId/reschedule", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "weekId", "value": "", "type": "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" }, { "name": "scheduleId", "value": "", "type": "path", "description": "The ID of the schedule" } ] }, "docs": "Start a rescheduling run" }, { "info": { "name": "Creates a signed upload URL for updating a schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekId/schedules/:scheduleId/update/uploadurl", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "weekId", "value": "", "type": "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" }, { "name": "scheduleId", "value": "", "type": "path", "description": "The ID of the schedule" } ] }, "docs": "Once the upload is complete, call the /{scheduleId}/update route to start the schedule update process" }, { "info": { "name": "Get the list of week schedules for the specified week", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekId/schedules", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "weekId", "value": "", "type": "path", "description": "First day of schedule week in yyyy-MM-dd format, or 'recent' (without quotes) to get recent schedules" }, { "name": "earliestWeekDate", "value": "", "type": "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" }, { "name": "latestWeekDate", "value": "", "type": "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" }, { "name": "includeOnlyPublished", "value": "", "type": "query", "description": "includeOnlyPublished" }, { "name": "expand", "value": "", "type": "query", "description": "expand" } ] }, "docs": "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" }, { "info": { "name": "Create a blank schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekId/schedules", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "weekId", "value": "", "type": "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" } ] }, "docs": "Create a blank schedule" }, { "info": { "name": "Creates a signed upload URL for importing a schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekId/schedules/import/uploadurl", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "weekId", "value": "", "type": "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" } ] }, "docs": "Once the upload is complete, call the /import route to start the schedule import process" }, { "info": { "name": "Starts processing a schedule import", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekId/schedules/import", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "weekId", "value": "", "type": "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" } ] }, "docs": "Call after uploading the schedule data to the url supplied by the /import/uploadurl route" }, { "info": { "name": "Generate a schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekId/schedules/generate", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "weekId", "value": "", "type": "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" } ] }, "docs": "Generate a schedule" }, { "info": { "name": "Copy a schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekId/schedules/:scheduleId/copy", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "weekId", "value": "", "type": "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" }, { "name": "scheduleId", "value": "", "type": "path", "description": "The ID of the schedule to copy" } ] }, "docs": "Copy a schedule" }, { "info": { "name": "Get the generation results for a generated schedule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekId/schedules/:scheduleId/generationresults", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "weekId", "value": "", "type": "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" }, { "name": "scheduleId", "value": "", "type": "path", "description": "The ID of the schedule" } ] }, "docs": "Get the generation results for a generated schedule" }, { "info": { "name": "Get the headcount forecast by planning group for the schedule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekId/schedules/:scheduleId/headcountforecast", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "weekId", "value": "", "type": "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" }, { "name": "scheduleId", "value": "", "type": "path", "description": "The ID of the schedule" }, { "name": "forceDownload", "value": "", "type": "query", "description": "Whether to force the result to come via download url. For testing purposes only" } ] }, "docs": "Get the headcount forecast by planning group for the schedule" }, { "info": { "name": "Loads agent schedule data from the schedule. Used in combination with the metadata route", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekId/schedules/:scheduleId/agentschedules/query", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "weekId", "value": "", "type": "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" }, { "name": "scheduleId", "value": "", "type": "path", "description": "The ID of the schedule" }, { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Loads agent schedule data from the schedule. Used in combination with the metadata route" }, { "info": { "name": "Loads agent's schedule history.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekId/schedules/:scheduleId/history/agents/:agentId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "weekId", "value": "", "type": "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" }, { "name": "scheduleId", "value": "", "type": "path", "description": "The ID of the schedule" }, { "name": "agentId", "value": "", "type": "path", "description": "THe ID of the agent" } ] }, "docs": "Loads agent's schedule history." }, { "info": { "name": "Starts processing a schedule update", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/weeks/:weekId/schedules/:scheduleId/update", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "weekId", "value": "", "type": "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" }, { "name": "scheduleId", "value": "", "type": "path", "description": "The ID of the schedule" } ] }, "docs": "Call after uploading the schedule data to the url supplied by the /update/uploadurl route" }, { "info": { "name": "Query published schedules for given given time range for set of users", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/schedules/search", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." } ] }, "docs": "Query published schedules for given given time range for set of users" }, { "info": { "name": "Query published schedules for given given time range for set of users", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/agentschedules/search", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Query published schedules for given given time range for set of users" }, { "info": { "name": "Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/weeks/:weekId/schedules", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "weekId", "value": "", "type": "path", "description": "First day of schedule week in yyyy-MM-dd format." }, { "name": "includeOnlyPublished", "value": "", "type": "query", "description": "Return only published schedules" }, { "name": "earliestWeekDate", "value": "", "type": "query", "description": "The start date of the earliest week to query in yyyy-MM-dd format" }, { "name": "latestWeekDate", "value": "", "type": "query", "description": "The start date of the latest week to query in yyyy-MM-dd format" } ] }, "docs": "Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit" }, { "info": { "name": "Deprecated. Use the equivalent business unit resource instead. Get a week schedule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/weeks/:weekId/schedules/:scheduleId", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "weekId", "value": "", "type": "path", "description": "First day of schedule week in yyyy-MM-dd format." }, { "name": "scheduleId", "value": "", "type": "path", "description": "The ID of the schedule to fetch" }, { "name": "expand", "value": "", "type": "query", "description": "Which fields, if any, to expand" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Deprecated. Use the equivalent business unit resource instead. Get a week schedule" }, { "info": { "name": "Get scheduler settings for a business unit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/scheduler/settings", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Get scheduler settings for a business unit" }, { "info": { "name": "Update scheduler settings for a business unit", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/scheduler/settings", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Update scheduler settings for a business unit" }, { "info": { "name": "Get status of the scheduling job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/schedulingjobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The id of the scheduling job" } ] }, "docs": "Get status of the scheduling job" }, { "info": { "name": "Queries shift trades in a management unit per user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/shifttrading/trades/query/jobs", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Queries shift trades in a management unit per user" }, { "info": { "name": "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", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/shifttrading/trades/query/jobs/:jobId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job" } ] }, "docs": "Job details are only retained if the initial request returned a 202 ACCEPTED response" }, { "info": { "name": "Queries and evaluates against shift trade configuration shift trades in a management unit per week", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/shifttrading/trades/evaluate/jobs", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Queries and evaluates against shift trade configuration shift trades in a management unit per week" }, { "info": { "name": "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", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/shifttrading/trades/evaluate/jobs/:jobId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job" } ] }, "docs": "Job details are only retained if the initial request returned a 202 ACCEPTED response" }, { "info": { "name": "Retrieves the summary of shift trades in a matched state per week", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/shifttrading/weeks/summary/jobs", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" } ] }, "docs": "Retrieves the summary of shift trades in a matched state per week" }, { "info": { "name": "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", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/shifttrading/weeks/summary/jobs/:jobId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job" } ] }, "docs": "Job details are only retained if the initial request returned a 202 ACCEPTED response" }, { "info": { "name": "Start an async job to find potential shift trade matches for the current receiving user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/shifttrading/unmatched/search/jobs", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Start an async job to find potential shift trade matches for the current receiving user" }, { "info": { "name": "View result of potential shift trade matches for the current user. Only the user who started the operation can query the status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/shifttrading/unmatched/search/jobs/:jobId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job" } ] }, "docs": "Job details are only retained if the initial request returned a 202 ACCEPTED response" }, { "info": { "name": "Bulk update multiple trade states. Permits a supervisor to approve or deny multiple trades.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/shifttrading/trades/state/bulk/jobs", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Bulk update multiple trade states. Permits a supervisor to approve or deny multiple trades." }, { "info": { "name": "View results of bulk update trades states operation. Only the user who started the operation can query the status.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/shifttrading/trades/state/bulk/jobs/:jobId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job" } ] }, "docs": "Job details are only retained if the initial request returned a 202 ACCEPTED response" }, { "info": { "name": "Add a shift trade job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/shifttrading/trades/jobs", "params": [ { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" } ] }, "docs": "Add a shift trade job" }, { "info": { "name": "View result of create trade operation. Only the user who started the operation can query the status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/shifttrading/trades/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job" } ] }, "docs": "Job details are only retained if the initial request returned a 202 ACCEPTED response" }, { "info": { "name": "Retrieve all my shift trades where I am either the initiating or receiving user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/shifttrading/trades/mine/query/jobs", "params": [ { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "Retrieve all my shift trades where I am either the initiating or receiving user" }, { "info": { "name": "View results of retrieve all my shift trade operation. Only the user who started the operation can query the status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/shifttrading/trades/mine/query/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job" } ] }, "docs": "Job details are only retained if the initial request returned a 202 ACCEPTED response" }, { "info": { "name": "Updates a shift trade. This route can only be called by the initiating user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/shifttrading/trades/:tradeId/jobs", "params": [ { "name": "tradeId", "value": "", "type": "path", "description": "The ID of the shift trade to update" }, { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" } ] }, "docs": "Updates a shift trade. This route can only be called by the initiating user" }, { "info": { "name": "View result of update trade operation. Only the user who started the operation can query the status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/shifttrading/trades/:tradeId/jobs/:jobId", "params": [ { "name": "tradeId", "value": "", "type": "path", "description": "The ID of the shift trade to update" }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job" } ] }, "docs": "Job details are only retained if the initial request returned a 202 ACCEPTED response" }, { "info": { "name": "Update trade state by a user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/shifttrading/trades/:tradeId/state/jobs", "params": [ { "name": "tradeId", "value": "", "type": "path", "description": "The ID of the shift trade to update state" }, { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" } ] }, "docs": "Update trade state by a user" }, { "info": { "name": "View result of update trade state operation. Only the user who started the operation can query the status.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/shifttrading/trades/:tradeId/state/jobs/:jobId", "params": [ { "name": "tradeId", "value": "", "type": "path", "description": "The ID of the shift trade to update" }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job" } ] }, "docs": "Job details are only retained if the initial request returned a 202 ACCEPTED response" }, { "info": { "name": "Matches a shift trade. This route can only be called by the receiving user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/shifttrading/trades/:tradeId/match/jobs", "params": [ { "name": "tradeId", "value": "", "type": "path", "description": "The ID of the shift trade to match" }, { "name": "forceAsync", "value": "", "type": "query", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" } ] }, "docs": "Matches a shift trade. This route can only be called by the receiving user" }, { "info": { "name": "View result of match shift trade operation. Only the receiving user who started the operation can query the status.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/shifttrading/trades/:tradeId/match/jobs/:jobId", "params": [ { "name": "tradeId", "value": "", "type": "path", "description": "The ID of the shift trade to update" }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job" } ] }, "docs": "Job details are only retained if the initial request returned a 202 ACCEPTED response" }, { "info": { "name": "Request to fetch the status of the historical shrinkage query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/shrinkage/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Request to fetch the status of the historical shrinkage query" }, { "info": { "name": "Request a historical shrinkage report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/shrinkage/jobs", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit" } ] }, "docs": "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. " }, { "info": { "name": "Request a historical shrinkage report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/teams/:teamId/shrinkage/jobs", "params": [ { "name": "teamId", "value": "", "type": "path", "description": "The ID of the team" } ] }, "docs": "The maximum supported range for historical shrinkage queries is up to 32 days" }, { "info": { "name": "Fetches time off requests matching the conditions specified in the request body", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/timeoffrequests/query", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } ] }, "docs": "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" }, { "info": { "name": "Get a list of time off requests for a given user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/users/:userId/timeoffrequests", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "userId", "value": "", "type": "path", "description": "The userId to whom the Time Off Request applies." } ] }, "docs": "Get a list of time off requests for a given user" }, { "info": { "name": "Get a time off request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/users/:userId/timeoffrequests/:timeOffRequestId", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "userId", "value": "", "type": "path", "description": "The userId to whom the Time Off Request applies." }, { "name": "timeOffRequestId", "value": "", "type": "path", "description": "Time Off Request Id" } ] }, "docs": "Get a time off request" }, { "info": { "name": "Update a time off request", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/users/:userId/timeoffrequests/:timeOffRequestId", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, { "name": "userId", "value": "", "type": "path", "description": "The id of the user the requested time off request belongs to" }, { "name": "timeOffRequestId", "value": "", "type": "path", "description": "The id of the time off request to update" } ] }, "docs": "Update a time off request" }, { "info": { "name": "Create a new time off request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/timeoffrequests", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." } ] }, "docs": "Create a new time off request" }, { "info": { "name": "Query time off balances for the current user for specified activity code and dates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/timeoffbalance/jobs" }, "docs": "Query time off balances for the current user for specified activity code and dates" }, { "info": { "name": "Query the results of time off types job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/timeoffbalance/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job." } ] }, "docs": "Query the results of time off types job" }, { "info": { "name": "Query time off balances for dates spanned by a given time off request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/users/:userId/timeoffrequests/:timeOffRequestId/timeoffbalance/jobs", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit." }, { "name": "userId", "value": "", "type": "path", "description": "The userId to whom the time off request applies." }, { "name": "timeOffRequestId", "value": "", "type": "path", "description": "The time off request id." } ] }, "docs": "Query time off balances for dates spanned by a given time off request" }, { "info": { "name": "Query time off balances for a given user for specified activity code and dates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/users/:userId/timeoffbalance/jobs", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit" }, { "name": "userId", "value": "", "type": "path", "description": "The ID of the user" } ] }, "docs": "Query time off balances for a given user for specified activity code and dates" }, { "info": { "name": "Estimates available time off for current user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/timeoffrequests/estimate", "params": [ { "name": "includeOnly", "value": "", "type": "query", "description": "Limit response to the specified field" } ] }, "docs": "Estimates available time off for current user" }, { "info": { "name": "Estimates available time off for an agent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/users/:userId/timeoffrequests/estimate", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit" }, { "name": "userId", "value": "", "type": "path", "description": "The id of the user for whom the time off request estimate is requested" }, { "name": "includeOnly", "value": "", "type": "query", "description": "Limit response to the specified field" } ] }, "docs": "Estimates available time off for an agent" }, { "info": { "name": "Retrieves integration statuses for a list of time off requests", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/timeoffrequests/integrationstatus/query", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit." } ] }, "docs": "Retrieves integration statuses for a list of time off requests" }, { "info": { "name": "Set integration status for a time off request.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/timeoffrequests/:timeOffRequestId/users/:userId/integrationstatus", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit." }, { "name": "timeOffRequestId", "value": "", "type": "path", "description": "The ID of the time off request." }, { "name": "userId", "value": "", "type": "path", "description": "The ID of user to whom the time off request belongs." } ] }, "docs": "Set integration status for a time off request." }, { "info": { "name": "Gets a list of time-off limit objects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/timeofflimits", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "managementUnitId", "value": "", "type": "query", "description": "The ID of the management unit to get management unit specific time-off limit objects" } ] }, "docs": "Gets a list of time-off limit objects" }, { "info": { "name": "Creates a new time-off limit object", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/timeofflimits", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Creates a new time-off limit object" }, { "info": { "name": "Gets a time-off limit object", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/timeofflimits/:timeOffLimitId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "timeOffLimitId", "value": "", "type": "path", "description": "The ID of the time-off limit to fetch" } ] }, "docs": "Returns properties of time-off limit object, but not daily values" }, { "info": { "name": "Deletes a time-off limit object", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/timeofflimits/:timeOffLimitId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "timeOffLimitId", "value": "", "type": "path", "description": "The ID of the time-off limit object to delete" } ] }, "docs": "Deletes a time-off limit object" }, { "info": { "name": "Sets daily values for a date range of time-off limit object", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/timeofflimits/:timeOffLimitId/values", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "timeOffLimitId", "value": "", "type": "path", "description": "The ID of the time-off limit object to set values for" } ] }, "docs": "Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API" }, { "info": { "name": "Retrieves time-off limit related values based on a given set of filters.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/timeofflimits/values/query", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Retrieves time-off limit related values based on a given set of filters." }, { "info": { "name": "Gets a list of time off limit objects under management unit.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/timeofflimits", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit." } ] }, "docs": "Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element." }, { "info": { "name": "Creates a new time off limit object under management unit.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/timeofflimits", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit." } ] }, "docs": "Only one limit object is allowed under management unit, so an attempt to create second object will fail." }, { "info": { "name": "Gets a time off limit object", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/timeofflimits/:timeOffLimitId", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit." }, { "name": "timeOffLimitId", "value": "", "type": "path", "description": "The ID of the time off limit to fetch" } ] }, "docs": "Returns properties of time off limit object, but not daily values." }, { "info": { "name": "Updates a time off limit object.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/timeofflimits/:timeOffLimitId", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit." }, { "name": "timeOffLimitId", "value": "", "type": "path", "description": "The id of time off limit object to update" } ] }, "docs": "Updates time off limit object properties, but not daily values." }, { "info": { "name": "Deletes a time off limit object", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/timeofflimits/:timeOffLimitId", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit." }, { "name": "timeOffLimitId", "value": "", "type": "path", "description": "The ID of the time off limit object to delete" } ] }, "docs": "Deletes a time off limit object" }, { "info": { "name": "Sets daily values for a date range of time off limit object", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/timeofflimits/:timeOffLimitId/values", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit." }, { "name": "timeOffLimitId", "value": "", "type": "path", "description": "The ID of the time off limit object to set values for" } ] }, "docs": "Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API" }, { "info": { "name": "Retrieves time off limit related values based on a given set of filters.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/timeofflimits/values/query", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit." } ] }, "docs": "Retrieves time off limit related values based on a given set of filters." }, { "info": { "name": "Retrieves time off limit, allocated and waitlisted values according to specific time off request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/users/:userId/timeoffrequests/:timeOffRequestId/timeofflimits", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit." }, { "name": "userId", "value": "", "type": "path", "description": "The userId to whom the time off request applies." }, { "name": "timeOffRequestId", "value": "", "type": "path", "description": "The ID of the time off request, which dates and activityCodeId determine limit values to retrieve" } ] }, "docs": "Retrieves time off limit, allocated and waitlisted values according to specific time off request" }, { "info": { "name": "Gets a list of time-off plans", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/timeoffplans", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "managementUnitId", "value": "", "type": "query", "description": "The ID of the management unit to get management unit specific staffing groups" }, { "name": "forceDownloadService", "value": "", "type": "query", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" }, { "name": "expand", "value": "", "type": "query", "description": "Include to access additional data for the time-off plans" } ] }, "docs": "Gets a list of time-off plans" }, { "info": { "name": "Creates a new time-off plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/timeoffplans", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Creates a new time-off plan" }, { "info": { "name": "Gets a time-off plan", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/timeoffplans/:timeOffPlanId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "timeOffPlanId", "value": "", "type": "path", "description": "The ID of the time-off plan to fetch" } ] }, "docs": "Gets a time-off plan" }, { "info": { "name": "Updates a time-off plan", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/timeoffplans/:timeOffPlanId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "timeOffPlanId", "value": "", "type": "path", "description": "The ID of the time-off plan to update" } ] }, "docs": "Updates a time-off plan" }, { "info": { "name": "Deletes a time-off plan", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/timeoffplans/:timeOffPlanId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "timeOffPlanId", "value": "", "type": "path", "description": "The ID of the time-off plan to delete" } ] }, "docs": "Deletes a time-off plan" }, { "info": { "name": "Gets a list of time off plans", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/timeoffplans", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit" } ] }, "docs": "Gets a list of time off plans" }, { "info": { "name": "Creates a new time off plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/timeoffplans", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit" } ] }, "docs": "Creates a new time off plan" }, { "info": { "name": "Gets a time off plan", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/timeoffplans/:timeOffPlanId", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit" }, { "name": "timeOffPlanId", "value": "", "type": "path", "description": "The ID of the time off plan to fetch" } ] }, "docs": "Gets a time off plan" }, { "info": { "name": "Updates a time off plan", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/timeoffplans/:timeOffPlanId", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit" }, { "name": "timeOffPlanId", "value": "", "type": "path", "description": "The ID of the time off plan to update" } ] }, "docs": "Updates a time off plan" }, { "info": { "name": "Deletes a time off plan", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/timeoffplans/:timeOffPlanId", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit" }, { "name": "timeOffPlanId", "value": "", "type": "path", "description": "The ID of the time off plan to delete" } ] }, "docs": "Deletes a time off plan" }, { "info": { "name": "Retrieves daily waitlist position for a list of time off requests", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/managementunits/:managementUnitId/timeoffrequests/waitlistpositions/query", "params": [ { "name": "managementUnitId", "value": "", "type": "path", "description": "The ID of the management unit." } ] }, "docs": "Retrieves daily waitlist position for a list of time off requests" }, { "info": { "name": "Get summary of bid groups that belong to a work plan bid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/workplanbids/:bidId/groups/summary", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The work plan bid id of the bid groups" } ] }, "docs": "Get summary of bid groups that belong to a work plan bid" }, { "info": { "name": "Add a bid group in a given work plan bid", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/workplanbids/:bidId/groups", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The work plan bid id of the bid groups" } ] }, "docs": "Add a bid group in a given work plan bid" }, { "info": { "name": "Get a bid group by bid group Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/workplanbids/:bidId/groups/:bidGroupId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The work plan bid id of the bid groups" }, { "name": "bidGroupId", "value": "", "type": "path", "description": "Work Plan Bid Group id" } ] }, "docs": "Get a bid group by bid group Id" }, { "info": { "name": "Update a bid group by bid group Id", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/workplanbids/:bidId/groups/:bidGroupId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The work plan bid id of the bid groups" }, { "name": "bidGroupId", "value": "", "type": "path", "description": "Work Plan Bid Group id" } ] }, "docs": "Update a bid group by bid group Id" }, { "info": { "name": "Delete a bid group by bid group Id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/workplanbids/:bidId/groups/:bidGroupId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The work plan bid id of the bid groups" }, { "name": "bidGroupId", "value": "", "type": "path", "description": "Work Plan Bid Group id" } ] }, "docs": "Delete a bid group by bid group Id" }, { "info": { "name": "Gets the work plan preferences of all the agents in the work plan bid group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/workplanbids/:bidId/groups/:bidGroupId/preferences", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The work plan bid id of the bid groups" }, { "name": "bidGroupId", "value": "", "type": "path", "description": "The ID of the work plan bid group" } ] }, "docs": "Gets the work plan preferences of all the agents in the work plan bid group" }, { "info": { "name": "Overrides the assigned work plan for the specified agents", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/workplanbids/:bidId/groups/:bidGroupId/preferences", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The work plan bid id of the bid groups" }, { "name": "bidGroupId", "value": "", "type": "path", "description": "The ID of the work plan bid group" } ] }, "docs": "Overrides the assigned work plan for the specified agents" }, { "info": { "name": "Update bulk work plan bid ranks on users. Max 50 users can be updated at a time.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/users/workplanbidranks/bulk" }, "docs": "Update bulk work plan bid ranks on users. Max 50 users can be updated at a time." }, { "info": { "name": "Get work plan bid ranks for a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/users/:userId/workplanbidranks", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The userId to whom the work plan bid ranks apply." } ] }, "docs": "Get work plan bid ranks for a user" }, { "info": { "name": "Update work plan bid ranks for a user", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/users/:userId/workplanbidranks", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The userId to whom the work plan bid ranks apply." } ] }, "docs": "Update work plan bid ranks for a user" }, { "info": { "name": "Get a work plan bid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/workplanbids/:bidId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The id of the workplanbid" } ] }, "docs": "Get a work plan bid" }, { "info": { "name": "Update work plan bid", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/workplanbids/:bidId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The id of the workplanbid" } ] }, "docs": "Update work plan bid" }, { "info": { "name": "Delete a work plan bid", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/workplanbids/:bidId", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The ID of the work plan bid" } ] }, "docs": "Delete a work plan bid" }, { "info": { "name": "Get list of work plan bids", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/workplanbids", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Get list of work plan bids" }, { "info": { "name": "Create a new work plan bid", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/workplanbids", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" } ] }, "docs": "Create a new work plan bid" }, { "info": { "name": "Copy a work plan bid", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/workforcemanagement/businessunits/:businessUnitId/workplanbids/:bidId/copy", "params": [ { "name": "businessUnitId", "value": "", "type": "path", "description": "The ID of the business unit" }, { "name": "bidId", "value": "", "type": "path", "description": "The ID of the work plan bid to copy" } ] }, "docs": "Copy a work plan bid" } ] } ], "bundled": true }