docs/WorkforceManagementApi.md in purecloudplatformclientv2-53.0.0 vs docs/WorkforceManagementApi.md in purecloudplatformclientv2-54.0.0

- old
+ new

@@ -19,11 +19,10 @@ [**get_workforcemanagement_adhocmodelingjob**](WorkforceManagementApi.html#get_workforcemanagement_adhocmodelingjob) | Get status of the modeling job [**get_workforcemanagement_managementunit**](WorkforceManagementApi.html#get_workforcemanagement_managementunit) | Get management unit [**get_workforcemanagement_managementunit_activitycode**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_activitycode) | Get an activity code [**get_workforcemanagement_managementunit_activitycodes**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_activitycodes) | Get activity codes [**get_workforcemanagement_managementunit_agent**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_agent) | Get data for agent in the management unit -[**get_workforcemanagement_managementunit_agent_shifttrades**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_agent_shifttrades) | Gets all the shift trades for a given agent [**get_workforcemanagement_managementunit_intraday_queues**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_intraday_queues) | Get intraday queues for the given date [**get_workforcemanagement_managementunit_scheduling_run**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_scheduling_run) | Gets the status for a specific scheduling run [**get_workforcemanagement_managementunit_scheduling_run_result**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_scheduling_run_result) | Gets the result of a specific scheduling run [**get_workforcemanagement_managementunit_scheduling_runs**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_scheduling_runs) | Get the status of all the ongoing schedule runs [**get_workforcemanagement_managementunit_servicegoalgroup**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_servicegoalgroup) | Get a service goal group @@ -35,11 +34,10 @@ [**get_workforcemanagement_managementunit_user_timeoffrequests**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_user_timeoffrequests) | Get a list of time off requests for a given user [**get_workforcemanagement_managementunit_users**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_users) | Get users in the management unit [**get_workforcemanagement_managementunit_week_schedule**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_schedule) | Get a week schedule [**get_workforcemanagement_managementunit_week_schedule_generationresults**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_schedule_generationresults) | Get week schedule generation results [**get_workforcemanagement_managementunit_week_schedules**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_schedules) | Get the list of schedules in a week in management unit -[**get_workforcemanagement_managementunit_week_shifttrades**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_shifttrades) | Gets all the shift trades for a given week [**get_workforcemanagement_managementunit_week_shorttermforecast_final**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_shorttermforecast_final) | Get the final result of a short term forecast calculation with modifications applied [**get_workforcemanagement_managementunit_week_shorttermforecasts**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_shorttermforecasts) | Get short term forecasts [**get_workforcemanagement_managementunit_workplan**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_workplan) | Get a work plan [**get_workforcemanagement_managementunit_workplans**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_workplans) | Get work plans [**get_workforcemanagement_managementunits**](WorkforceManagementApi.html#get_workforcemanagement_managementunits) | Get management units @@ -48,11 +46,10 @@ [**get_workforcemanagement_schedulingjob**](WorkforceManagementApi.html#get_workforcemanagement_schedulingjob) | Get status of the scheduling job [**get_workforcemanagement_shifttrades**](WorkforceManagementApi.html#get_workforcemanagement_shifttrades) | Gets all of my shift trades [**get_workforcemanagement_timeoffrequest**](WorkforceManagementApi.html#get_workforcemanagement_timeoffrequest) | Get a time off request for the current user [**get_workforcemanagement_timeoffrequests**](WorkforceManagementApi.html#get_workforcemanagement_timeoffrequests) | Get a list of time off requests for the current user [**patch_workforcemanagement_managementunit_activitycode**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_activitycode) | Update an activity code -[**patch_workforcemanagement_managementunit_agent**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_agent) | Update agent details [**patch_workforcemanagement_managementunit_scheduling_run**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_scheduling_run) | Marks a specific scheduling run as applied, allowing a new rescheduling run to be started [**patch_workforcemanagement_managementunit_servicegoalgroup**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_servicegoalgroup) | Update a service goal group [**patch_workforcemanagement_managementunit_settings**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_settings) | Patch the settings for the requested management unit [**patch_workforcemanagement_managementunit_user_timeoffrequest**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_user_timeoffrequest) | Update a time off request [**patch_workforcemanagement_managementunit_week_schedule**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_week_schedule) | Update a week schedule @@ -70,25 +67,20 @@ [**post_workforcemanagement_managementunit_week_schedule_copy**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_schedule_copy) | Copy a week schedule [**post_workforcemanagement_managementunit_week_schedule_reschedule**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_schedule_reschedule) | Start a scheduling run to compute the reschedule. When the scheduling run finishes, a client can get the reschedule changes and then the client can apply them to the schedule, save the schedule, and mark the scheduling run as applied [**post_workforcemanagement_managementunit_week_schedules**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_schedules) | Add a schedule for a week in management unit using imported data. Use partial uploads of user schedules if activity count in schedule is greater than 17500 [**post_workforcemanagement_managementunit_week_schedules_generate**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_schedules_generate) | Generate a week schedule [**post_workforcemanagement_managementunit_week_schedules_partialupload**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_schedules_partialupload) | Partial upload of user schedules where activity count is greater than 17500 -[**post_workforcemanagement_managementunit_week_shifttrade_match**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shifttrade_match) | Matches a shift trade. This route can only be called by the receiving agent -[**post_workforcemanagement_managementunit_week_shifttrade_update**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shifttrade_update) | Updates a shift trade. This route can only be called by the initiating agent -[**post_workforcemanagement_managementunit_week_shifttrades**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shifttrades) | Adds a shift trade -[**post_workforcemanagement_managementunit_week_shifttrades_search**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shifttrades_search) | Searches for potential shift trade matches for the current agent [**post_workforcemanagement_managementunit_week_shorttermforecast_copy**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shorttermforecast_copy) | Copy a short term forecast [**post_workforcemanagement_managementunit_week_shorttermforecasts**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shorttermforecasts) | Import a short term forecast [**post_workforcemanagement_managementunit_week_shorttermforecasts_generate**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shorttermforecasts_generate) | Generate a short term forecast [**post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload) | Import a short term forecast [**post_workforcemanagement_managementunit_workplan_copy**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_workplan_copy) | Create a copy of work plan [**post_workforcemanagement_managementunit_workplans**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_workplans) | Create a new work plan [**post_workforcemanagement_managementunits**](WorkforceManagementApi.html#post_workforcemanagement_managementunits) | Add a management unit [**post_workforcemanagement_notifications_update**](WorkforceManagementApi.html#post_workforcemanagement_notifications_update) | Mark a list of notifications as read or unread [**post_workforcemanagement_schedules**](WorkforceManagementApi.html#post_workforcemanagement_schedules) | Get published schedule for the current user [**post_workforcemanagement_timeoffrequests**](WorkforceManagementApi.html#post_workforcemanagement_timeoffrequests) | Create a time off request for the current user -[**put_workforcemanagement_managementunit_week_shifttrade_state**](WorkforceManagementApi.html#put_workforcemanagement_managementunit_week_shifttrade_state) | Updates a shift trade state {: class="table table-striped"} <a name="delete_workforcemanagement_managementunit"></a> ## delete_workforcemanagement_managementunit(mu_id) @@ -101,11 +93,10 @@ Wraps DELETE /api/v2/workforcemanagement/managementunits/{muId} Requires ANY permissions: -* wfm:managementUnit:administer * wfm:managementUnit:delete ### Example ```{"language":"ruby"} @@ -166,11 +157,10 @@ Wraps DELETE /api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId} Requires ANY permissions: -* wfm:activityCode:administer * wfm:activityCode:delete ### Example ```{"language":"ruby"} @@ -301,11 +291,10 @@ Wraps DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId} Requires ANY permissions: -* wfm:serviceGoalGroup:administer * wfm:serviceGoalGroup:delete ### Example ```{"language":"ruby"} @@ -369,11 +358,10 @@ Wraps DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId} Requires ANY permissions: -* wfm:schedule:administer * wfm:schedule:delete ### Example ```{"language":"ruby"} @@ -440,11 +428,10 @@ Wraps DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId} Requires ANY permissions: -* wfm:shortTermForecast:administer * wfm:shortTermForecast:delete ### Example ```{"language":"ruby"} @@ -511,11 +498,10 @@ Wraps DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId} Requires ANY permissions: -* wfm:workPlan:administer * wfm:workPlan:delete ### Example ```{"language":"ruby"} @@ -710,50 +696,42 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{muId} Requires ANY permissions: * wfm:activityCode:add -* wfm:activityCode:administer * wfm:activityCode:delete * wfm:activityCode:edit * wfm:activityCode:view -* wfm:agent:administer * wfm:agent:edit * wfm:agentSchedule:view * wfm:agentTimeOffRequest:submit * wfm:agent:view * wfm:historicalAdherence:view * wfm:intraday:view * wfm:managementUnit:add -* wfm:managementUnit:administer * wfm:managementUnit:delete * wfm:managementUnit:edit * wfm:managementUnit:view * wfm:publishedSchedule:view * wfm:realtimeAdherence:view * wfm:schedule:add -* wfm:schedule:administer * wfm:schedule:delete * wfm:schedule:edit * wfm:schedule:generate * wfm:schedule:view * wfm:serviceGoalGroup:add -* wfm:serviceGoalGroup:administer * wfm:serviceGoalGroup:delete * wfm:serviceGoalGroup:edit * wfm:serviceGoalGroup:view * wfm:shortTermForecast:add -* wfm:shortTermForecast:administer * wfm:shortTermForecast:delete * wfm:shortTermForecast:edit * wfm:shortTermForecast:view * wfm:timeOffRequest:add -* wfm:timeOffRequest:administer * wfm:timeOffRequest:edit * wfm:timeOffRequest:view * wfm:workPlan:add -* wfm:workPlan:administer * wfm:workPlan:delete * wfm:workPlan:edit * wfm:workPlan:view @@ -821,11 +799,10 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId} Requires ANY permissions: -* wfm:activityCode:administer * wfm:activityCode:view ### Example ```{"language":"ruby"} @@ -891,50 +868,42 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/activitycodes Requires ANY permissions: * wfm:activityCode:add -* wfm:activityCode:administer * wfm:activityCode:delete * wfm:activityCode:edit * wfm:activityCode:view -* wfm:agent:administer * wfm:agent:edit * wfm:agentSchedule:view * wfm:agentTimeOffRequest:submit * wfm:agent:view * wfm:historicalAdherence:view * wfm:intraday:view * wfm:managementUnit:add -* wfm:managementUnit:administer * wfm:managementUnit:delete * wfm:managementUnit:edit * wfm:managementUnit:view * wfm:publishedSchedule:view * wfm:realtimeAdherence:view * wfm:schedule:add -* wfm:schedule:administer * wfm:schedule:delete * wfm:schedule:edit * wfm:schedule:generate * wfm:schedule:view * wfm:serviceGoalGroup:add -* wfm:serviceGoalGroup:administer * wfm:serviceGoalGroup:delete * wfm:serviceGoalGroup:edit * wfm:serviceGoalGroup:view * wfm:shortTermForecast:add -* wfm:shortTermForecast:administer * wfm:shortTermForecast:delete * wfm:shortTermForecast:edit * wfm:shortTermForecast:view * wfm:timeOffRequest:add -* wfm:timeOffRequest:administer * wfm:timeOffRequest:edit * wfm:timeOffRequest:view * wfm:workPlan:add -* wfm:workPlan:administer * wfm:workPlan:delete * wfm:workPlan:edit * wfm:workPlan:view @@ -998,11 +967,10 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId} Requires ANY permissions: -* wfm:agent:administer * wfm:agent:view ### Example ```{"language":"ruby"} @@ -1053,79 +1021,10 @@ - **Content-Type**: application/json - **Accept**: application/json -<a name="get_workforcemanagement_managementunit_agent_shifttrades"></a> - -## [**ShiftTradeListResponse**](ShiftTradeListResponse.html) get_workforcemanagement_managementunit_agent_shifttrades(management_unit_id, agent_id) - - - -Gets all the shift trades for a given agent - - - -Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}/shifttrades - -Requires ANY permissions: - -* wfm:shiftTradeRequest:edit -* wfm:shiftTradeRequest:view - - -### Example -```{"language":"ruby"} -# load the gem -require 'purecloudplatformclientv2' -# setup authorization -@secret = ENV['PURECLOUD_SECRET'] -@id = ENV['PURECLOUD_CLIENT_ID'] -environment = "mypurecloud.com" - -@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment - -PureCloud.configure do |config| - config.access_token = @authToken -end - -api_instance = PureCloud::WorkforceManagementApi.new - -management_unit_id = "management_unit_id_example" # String | The id of the management unit, or 'mine' for the management unit of the logged-in user. - -agent_id = "agent_id_example" # String | The agent id - - -begin - #Gets all the shift trades for a given agent - result = api_instance.get_workforcemanagement_managementunit_agent_shifttrades(management_unit_id, agent_id) - p result -rescue PureCloud::ApiError => e - puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_agent_shifttrades: #{e}" -end -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **management_unit_id** | **String**| The id of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | | - **agent_id** | **String**| The agent id | | -{: class="table table-striped"} - - -### Return type - -[**ShiftTradeListResponse**](ShiftTradeListResponse.html) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - - <a name="get_workforcemanagement_managementunit_intraday_queues"></a> ## [**WfmIntradayQueueListing**](WfmIntradayQueueListing.html) get_workforcemanagement_managementunit_intraday_queues(mu_id, date) @@ -1405,11 +1304,10 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId} Requires ANY permissions: -* wfm:serviceGoalGroup:administer * wfm:serviceGoalGroup:view ### Example ```{"language":"ruby"} @@ -1474,13 +1372,11 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups Requires ANY permissions: -* wfm:serviceGoalGroup:administer * wfm:serviceGoalGroup:view -* wfm:shortTermForecast:administer * wfm:shortTermForecast:view ### Example ```{"language":"ruby"} @@ -1542,11 +1438,10 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/settings Requires ANY permissions: -* wfm:managementUnit:administer * wfm:managementUnit:view ### Example ```{"language":"ruby"} @@ -1739,11 +1634,10 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId} Requires ANY permissions: -* wfm:timeOffRequest:administer * wfm:timeOffRequest:view ### Example ```{"language":"ruby"} @@ -1811,11 +1705,10 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests Requires ANY permissions: -* wfm:timeOffRequest:administer * wfm:timeOffRequest:view ### Example ```{"language":"ruby"} @@ -1884,20 +1777,16 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users Requires ANY permissions: -* wfm:agent:administer * wfm:agent:view * wfm:historicalAdherence:view * wfm:publishedSchedule:view * wfm:realtimeAdherence:view -* wfm:schedule:administer * wfm:schedule:view -* wfm:timeOffRequest:administer * wfm:timeOffRequest:view -* wfm:workPlan:administer * wfm:workPlan:view ### Example ```{"language":"ruby"} @@ -1960,11 +1849,10 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId} Requires ANY permissions: * wfm:publishedSchedule:view -* wfm:schedule:administer * wfm:schedule:view ### Example ```{"language":"ruby"} @@ -2039,11 +1927,10 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults Requires ANY permissions: * wfm:publishedSchedule:view -* wfm:schedule:administer * wfm:schedule:view ### Example ```{"language":"ruby"} @@ -2112,11 +1999,10 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules Requires ANY permissions: * wfm:publishedSchedule:view -* wfm:schedule:administer * wfm:schedule:view ### Example ```{"language":"ruby"} @@ -2167,83 +2053,10 @@ - **Content-Type**: application/json - **Accept**: application/json -<a name="get_workforcemanagement_managementunit_week_shifttrades"></a> - -## [**WeekShiftTradeListResponse**](WeekShiftTradeListResponse.html) get_workforcemanagement_managementunit_week_shifttrades(management_unit_id, week_date_id, opts) - - - -Gets all the shift trades for a given week - - - -Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades - -Requires ANY permissions: - -* wfm:shiftTradeRequest:view -* wfm:shiftTradeRequest:edit - - -### Example -```{"language":"ruby"} -# load the gem -require 'purecloudplatformclientv2' -# setup authorization -@secret = ENV['PURECLOUD_SECRET'] -@id = ENV['PURECLOUD_CLIENT_ID'] -environment = "mypurecloud.com" - -@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment - -PureCloud.configure do |config| - config.access_token = @authToken -end - -api_instance = PureCloud::WorkforceManagementApi.new - -management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user. - -week_date_id = Date.parse("2013-10-20") # Date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - -opts = { - evaluate_matches: true # BOOLEAN | Whether to evaluate the matches for violations -} - -begin - #Gets all the shift trades for a given week - result = api_instance.get_workforcemanagement_managementunit_week_shifttrades(management_unit_id, week_date_id, opts) - p result -rescue PureCloud::ApiError => e - puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_shifttrades: #{e}" -end -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **management_unit_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | | - **week_date_id** | **Date**| The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | | - **evaluate_matches** | **BOOLEAN**| Whether to evaluate the matches for violations | [optional] [default to true] | -{: class="table table-striped"} - - -### Return type - -[**WeekShiftTradeListResponse**](WeekShiftTradeListResponse.html) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - - <a name="get_workforcemanagement_managementunit_week_shorttermforecast_final"></a> ## [**ForecastResultResponse**](ForecastResultResponse.html) get_workforcemanagement_managementunit_week_shorttermforecast_final(management_unit_id, week_date_id, forecast_id, opts) @@ -2254,11 +2067,10 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/final Requires ANY permissions: -* wfm:shortTermForecast:administer * wfm:shortTermForecast:view ### Example ```{"language":"ruby"} @@ -2331,11 +2143,10 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts Requires ANY permissions: * wfm:schedule:generate -* wfm:shortTermForecast:administer * wfm:shortTermForecast:view ### Example ```{"language":"ruby"} @@ -2400,13 +2211,11 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId} Requires ANY permissions: -* wfm:workPlan:administer * wfm:workPlan:view -* wfm:schedule:administer * wfm:schedule:edit ### Example ```{"language":"ruby"} @@ -2471,15 +2280,12 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans Requires ANY permissions: -* wfm:workPlan:administer -* wfm:agent:administer * wfm:agent:view * wfm:publishedSchedule:view -* wfm:schedule:administer * wfm:schedule:view * wfm:workPlan:view ### Example @@ -3002,11 +2808,10 @@ Wraps PATCH /api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId} Requires ANY permissions: -* wfm:activityCode:administer * wfm:activityCode:edit ### Example ```{"language":"ruby"} @@ -3061,79 +2866,10 @@ - **Content-Type**: application/json - **Accept**: application/json -<a name="patch_workforcemanagement_managementunit_agent"></a> - -## patch_workforcemanagement_managementunit_agent(management_unit_id, agent_id, body) - - - -Update agent details - - - -Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId} - -Requires NO permissions: - - - -### Example -```{"language":"ruby"} -# load the gem -require 'purecloudplatformclientv2' -# setup authorization -@secret = ENV['PURECLOUD_SECRET'] -@id = ENV['PURECLOUD_CLIENT_ID'] -environment = "mypurecloud.com" - -@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment - -PureCloud.configure do |config| - config.access_token = @authToken -end - -api_instance = PureCloud::WorkforceManagementApi.new - -management_unit_id = "management_unit_id_example" # String | The id of the management unit, or 'mine' for the management unit of the logged-in user. - -agent_id = "agent_id_example" # String | The agent id - -body = PureCloud::UpdateAgentRequest.new # UpdateAgentRequest | The request body - - -begin - #Update agent details - api_instance.patch_workforcemanagement_managementunit_agent(management_unit_id, agent_id, body) -rescue PureCloud::ApiError => e - puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_agent: #{e}" -end -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **management_unit_id** | **String**| The id of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | | - **agent_id** | **String**| The agent id | | - **body** | [**UpdateAgentRequest**](UpdateAgentRequest.html)| The request body | | -{: class="table table-striped"} - - -### Return type - -nil (empty response body) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - - <a name="patch_workforcemanagement_managementunit_scheduling_run"></a> ## [**RescheduleResult**](RescheduleResult.html) patch_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id, opts) @@ -3216,11 +2952,10 @@ Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId} Requires ANY permissions: -* wfm:serviceGoalGroup:administer * wfm:serviceGoalGroup:edit ### Example ```{"language":"ruby"} @@ -3289,11 +3024,10 @@ Wraps PATCH /api/v2/workforcemanagement/managementunits/{muId}/settings Requires ANY permissions: -* wfm:managementUnit:administer * wfm:managementUnit:edit ### Example ```{"language":"ruby"} @@ -3359,11 +3093,10 @@ Wraps PATCH /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId} Requires ANY permissions: -* wfm:timeOffRequest:administer * wfm:timeOffRequest:edit ### Example ```{"language":"ruby"} @@ -3435,11 +3168,10 @@ Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId} Requires ANY permissions: -* wfm:schedule:administer * wfm:schedule:edit ### Example ```{"language":"ruby"} @@ -3515,11 +3247,10 @@ Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId} Requires ANY permissions: -* wfm:workPlan:administer * wfm:workPlan:edit ### Example ```{"language":"ruby"} @@ -3724,11 +3455,10 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/activitycodes Requires ANY permissions: * wfm:activityCode:add -* wfm:activityCode:administer ### Example ```{"language":"ruby"} # load the gem @@ -3932,11 +3662,10 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/schedules/search Requires ANY permissions: * wfm:publishedSchedule:view -* wfm:schedule:administer * wfm:schedule:view ### Example ```{"language":"ruby"} @@ -4003,11 +3732,10 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups Requires ANY permissions: * wfm:serviceGoalGroup:add -* wfm:serviceGoalGroup:administer ### Example ```{"language":"ruby"} # load the gem @@ -4072,11 +3800,10 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests Requires ANY permissions: -* wfm:timeOffRequest:administer * wfm:timeOffRequest:add ### Example ```{"language":"ruby"} @@ -4142,11 +3869,10 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/fetchdetails Requires ANY permissions: -* wfm:timeOffRequest:administer * wfm:timeOffRequest:view ### Example ```{"language":"ruby"} @@ -4212,11 +3938,10 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/query Requires ANY permissions: -* wfm:timeOffRequest:administer * wfm:timeOffRequest:view ### Example ```{"language":"ruby"} @@ -4283,11 +4008,10 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy Requires ANY permissions: * wfm:schedule:add -* wfm:schedule:administer ### Example ```{"language":"ruby"} # load the gem @@ -4362,11 +4086,10 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule Requires ANY permissions: -* wfm:schedule:administer * wfm:schedule:edit ### Example ```{"language":"ruby"} @@ -4439,11 +4162,10 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules Requires ANY permissions: * wfm:schedule:add -* wfm:schedule:administer ### Example ```{"language":"ruby"} # load the gem @@ -4588,11 +4310,10 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/partialupload Requires ANY permissions: * wfm:schedule:add -* wfm:schedule:administer * wfm:schedule:edit ### Example ```{"language":"ruby"} @@ -4647,300 +4368,10 @@ - **Content-Type**: application/json - **Accept**: application/json -<a name="post_workforcemanagement_managementunit_week_shifttrade_match"></a> - -## [**MatchShiftTradeResponse**](MatchShiftTradeResponse.html) post_workforcemanagement_managementunit_week_shifttrade_match(management_unit_id, week_date_id, body, trade_id) - - - -Matches a shift trade. This route can only be called by the receiving agent - - - -Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match - -Requires ANY permissions: - -* wfm:agentShiftTradeRequest:participate - - -### Example -```{"language":"ruby"} -# load the gem -require 'purecloudplatformclientv2' -# setup authorization -@secret = ENV['PURECLOUD_SECRET'] -@id = ENV['PURECLOUD_CLIENT_ID'] -environment = "mypurecloud.com" - -@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment - -PureCloud.configure do |config| - config.access_token = @authToken -end - -api_instance = PureCloud::WorkforceManagementApi.new - -management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user. - -week_date_id = Date.parse("2013-10-20") # Date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - -body = PureCloud::MatchShiftTradeRequest.new # MatchShiftTradeRequest | body - -trade_id = "trade_id_example" # String | The ID of the shift trade to update - - -begin - #Matches a shift trade. This route can only be called by the receiving agent - result = api_instance.post_workforcemanagement_managementunit_week_shifttrade_match(management_unit_id, week_date_id, body, trade_id) - p result -rescue PureCloud::ApiError => e - puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shifttrade_match: #{e}" -end -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **management_unit_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | | - **week_date_id** | **Date**| The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | | - **body** | [**MatchShiftTradeRequest**](MatchShiftTradeRequest.html)| body | | - **trade_id** | **String**| The ID of the shift trade to update | | -{: class="table table-striped"} - - -### Return type - -[**MatchShiftTradeResponse**](MatchShiftTradeResponse.html) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - - -<a name="post_workforcemanagement_managementunit_week_shifttrade_update"></a> - -## [**ShiftTradeResponse**](ShiftTradeResponse.html) post_workforcemanagement_managementunit_week_shifttrade_update(management_unit_id, week_date_id, body, trade_id) - - - -Updates a shift trade. This route can only be called by the initiating agent - - - -Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/update - -Requires ANY permissions: - -* wfm:agentShiftTradeRequest:participate - - -### Example -```{"language":"ruby"} -# load the gem -require 'purecloudplatformclientv2' -# setup authorization -@secret = ENV['PURECLOUD_SECRET'] -@id = ENV['PURECLOUD_CLIENT_ID'] -environment = "mypurecloud.com" - -@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment - -PureCloud.configure do |config| - config.access_token = @authToken -end - -api_instance = PureCloud::WorkforceManagementApi.new - -management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user. - -week_date_id = Date.parse("2013-10-20") # Date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - -body = PureCloud::UpdateShiftTradeRequest.new # UpdateShiftTradeRequest | body - -trade_id = "trade_id_example" # String | The ID of the shift trade to update - - -begin - #Updates a shift trade. This route can only be called by the initiating agent - result = api_instance.post_workforcemanagement_managementunit_week_shifttrade_update(management_unit_id, week_date_id, body, trade_id) - p result -rescue PureCloud::ApiError => e - puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shifttrade_update: #{e}" -end -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **management_unit_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | | - **week_date_id** | **Date**| The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | | - **body** | [**UpdateShiftTradeRequest**](UpdateShiftTradeRequest.html)| body | | - **trade_id** | **String**| The ID of the shift trade to update | | -{: class="table table-striped"} - - -### Return type - -[**ShiftTradeResponse**](ShiftTradeResponse.html) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - - -<a name="post_workforcemanagement_managementunit_week_shifttrades"></a> - -## [**ShiftTradeResponse**](ShiftTradeResponse.html) post_workforcemanagement_managementunit_week_shifttrades(management_unit_id, week_date_id, body) - - - -Adds a shift trade - - - -Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades - -Requires ANY permissions: - -* wfm:agentShiftTradeRequest:participate - - -### Example -```{"language":"ruby"} -# load the gem -require 'purecloudplatformclientv2' -# setup authorization -@secret = ENV['PURECLOUD_SECRET'] -@id = ENV['PURECLOUD_CLIENT_ID'] -environment = "mypurecloud.com" - -@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment - -PureCloud.configure do |config| - config.access_token = @authToken -end - -api_instance = PureCloud::WorkforceManagementApi.new - -management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user. - -week_date_id = Date.parse("2013-10-20") # Date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - -body = PureCloud::AddShiftTradeRequest.new # AddShiftTradeRequest | body - - -begin - #Adds a shift trade - result = api_instance.post_workforcemanagement_managementunit_week_shifttrades(management_unit_id, week_date_id, body) - p result -rescue PureCloud::ApiError => e - puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shifttrades: #{e}" -end -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **management_unit_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | | - **week_date_id** | **Date**| The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | | - **body** | [**AddShiftTradeRequest**](AddShiftTradeRequest.html)| body | | -{: class="table table-striped"} - - -### Return type - -[**ShiftTradeResponse**](ShiftTradeResponse.html) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - - -<a name="post_workforcemanagement_managementunit_week_shifttrades_search"></a> - -## [**SearchShiftTradesResponse**](SearchShiftTradesResponse.html) post_workforcemanagement_managementunit_week_shifttrades_search(management_unit_id, week_date_id, body) - - - -Searches for potential shift trade matches for the current agent - - - -Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search - -Requires ANY permissions: - -* wfm:agentShiftTradeRequest:participate - - -### Example -```{"language":"ruby"} -# load the gem -require 'purecloudplatformclientv2' -# setup authorization -@secret = ENV['PURECLOUD_SECRET'] -@id = ENV['PURECLOUD_CLIENT_ID'] -environment = "mypurecloud.com" - -@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment - -PureCloud.configure do |config| - config.access_token = @authToken -end - -api_instance = PureCloud::WorkforceManagementApi.new - -management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user. - -week_date_id = Date.parse("2013-10-20") # Date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - -body = PureCloud::SearchShiftTradesRequest.new # SearchShiftTradesRequest | body - - -begin - #Searches for potential shift trade matches for the current agent - result = api_instance.post_workforcemanagement_managementunit_week_shifttrades_search(management_unit_id, week_date_id, body) - p result -rescue PureCloud::ApiError => e - puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shifttrades_search: #{e}" -end -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **management_unit_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | | - **week_date_id** | **Date**| The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | | - **body** | [**SearchShiftTradesRequest**](SearchShiftTradesRequest.html)| body | | -{: class="table table-striped"} - - -### Return type - -[**SearchShiftTradesResponse**](SearchShiftTradesResponse.html) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - - <a name="post_workforcemanagement_managementunit_week_shorttermforecast_copy"></a> ## [**ShortTermForecastResponse**](ShortTermForecastResponse.html) post_workforcemanagement_managementunit_week_shorttermforecast_copy(management_unit_id, week_date_id, forecast_id, body, opts) @@ -4952,11 +4383,10 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy Requires ANY permissions: * wfm:shortTermForecast:add -* wfm:shortTermForecast:administer ### Example ```{"language":"ruby"} # load the gem @@ -5031,11 +4461,10 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts Requires ANY permissions: * wfm:shortTermForecast:add -* wfm:shortTermForecast:administer ### Example ```{"language":"ruby"} # load the gem @@ -5107,11 +4536,10 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/generate Requires ANY permissions: * wfm:shortTermForecast:add -* wfm:shortTermForecast:administer ### Example ```{"language":"ruby"} # load the gem @@ -5183,11 +4611,10 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/partialupload Requires ANY permissions: * wfm:shortTermForecast:add -* wfm:shortTermForecast:administer ### Example ```{"language":"ruby"} # load the gem @@ -5255,11 +4682,10 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy Requires ANY permissions: * wfm:workPlan:add -* wfm:workPlan:administer ### Example ```{"language":"ruby"} # load the gem @@ -5328,11 +4754,10 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans Requires ANY permissions: * wfm:workPlan:add -* wfm:workPlan:administer ### Example ```{"language":"ruby"} # load the gem @@ -5397,11 +4822,10 @@ Wraps POST /api/v2/workforcemanagement/managementunits Requires ANY permissions: -* wfm:managementUnit:administer * wfm:managementUnit:add ### Example ```{"language":"ruby"} @@ -5531,11 +4955,10 @@ Requires ANY permissions: * wfm:agentSchedule:view * wfm:publishedSchedule:view -* wfm:schedule:administer ### Example ```{"language":"ruby"} # load the gem @@ -5641,84 +5064,9 @@ ### Return type [**TimeOffRequestResponse**](TimeOffRequestResponse.html) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - - -<a name="put_workforcemanagement_managementunit_week_shifttrade_state"></a> - -## [**ShiftTradeResponse**](ShiftTradeResponse.html) put_workforcemanagement_managementunit_week_shifttrade_state(management_unit_id, week_date_id, trade_id, body) - - - -Updates a shift trade state - - - -Wraps PUT /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/state - -Requires ANY permissions: - -* wfm:agentShiftTradeRequest:participate -* wfm:shiftTradeRequest:edit - - -### Example -```{"language":"ruby"} -# load the gem -require 'purecloudplatformclientv2' -# setup authorization -@secret = ENV['PURECLOUD_SECRET'] -@id = ENV['PURECLOUD_CLIENT_ID'] -environment = "mypurecloud.com" - -@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment - -PureCloud.configure do |config| - config.access_token = @authToken -end - -api_instance = PureCloud::WorkforceManagementApi.new - -management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user. - -week_date_id = Date.parse("2013-10-20") # Date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - -trade_id = "trade_id_example" # String | The ID of the shift trade to update - -body = PureCloud::UpdateShiftTradeStateRequest.new # UpdateShiftTradeStateRequest | body - - -begin - #Updates a shift trade state - result = api_instance.put_workforcemanagement_managementunit_week_shifttrade_state(management_unit_id, week_date_id, trade_id, body) - p result -rescue PureCloud::ApiError => e - puts "Exception when calling WorkforceManagementApi->put_workforcemanagement_managementunit_week_shifttrade_state: #{e}" -end -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **management_unit_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | | - **week_date_id** | **Date**| The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | | - **trade_id** | **String**| The ID of the shift trade to update | | - **body** | [**UpdateShiftTradeStateRequest**](UpdateShiftTradeStateRequest.html)| body | | -{: class="table table-striped"} - - -### Return type - -[**ShiftTradeResponse**](ShiftTradeResponse.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json