docs/WorkforceManagementApi.md in purecloudplatformclientv2-49.0.0 vs docs/WorkforceManagementApi.md in purecloudplatformclientv2-49.0.1
- old
+ new
@@ -74,11 +74,11 @@
[**post_workforcemanagement_timeoffrequests**](WorkforceManagementApi.html#post_workforcemanagement_timeoffrequests) | Create a time off request for the current user
{: class="table table-striped"}
<a name="delete_workforcemanagement_managementunit"></a>
-## - delete_workforcemanagement_managementunit(mu_id)
+## delete_workforcemanagement_managementunit(mu_id)
Delete management unit
@@ -91,11 +91,11 @@
* wfm:managementUnit:administer
* wfm:managementUnit:delete
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -116,11 +116,11 @@
#Delete management unit
api_instance.delete_workforcemanagement_managementunit(mu_id)
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -139,11 +139,11 @@
<a name="delete_workforcemanagement_managementunit_activitycode"></a>
-## - delete_workforcemanagement_managementunit_activitycode(mu_id, ac_id)
+## delete_workforcemanagement_managementunit_activitycode(mu_id, ac_id)
Deletes an activity code
@@ -156,11 +156,11 @@
* wfm:activityCode:administer
* wfm:activityCode:delete
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -183,11 +183,11 @@
#Deletes an activity code
api_instance.delete_workforcemanagement_managementunit_activitycode(mu_id, ac_id)
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_activitycode: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -207,11 +207,11 @@
<a name="delete_workforcemanagement_managementunit_scheduling_run"></a>
-## - delete_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id)
+## delete_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id)
Cancel a schedule run
@@ -223,11 +223,11 @@
* wfm:schedule:generate
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -250,11 +250,11 @@
#Cancel a schedule run
api_instance.delete_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id)
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_scheduling_run: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -274,11 +274,11 @@
<a name="delete_workforcemanagement_managementunit_servicegoalgroup"></a>
-## - delete_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id)
+## delete_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id)
Delete a service goal group
@@ -291,11 +291,11 @@
* wfm:serviceGoalGroup:administer
* wfm:serviceGoalGroup:delete
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -318,11 +318,11 @@
#Delete a service goal group
api_instance.delete_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id)
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_servicegoalgroup: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -342,11 +342,11 @@
<a name="delete_workforcemanagement_managementunit_week_schedule"></a>
-## - delete_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id)
+## delete_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id)
Delete a schedule
@@ -359,11 +359,11 @@
* wfm:schedule:administer
* wfm:schedule:delete
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -388,11 +388,11 @@
#Delete a schedule
api_instance.delete_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id)
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_week_schedule: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -413,11 +413,11 @@
<a name="delete_workforcemanagement_managementunit_week_shorttermforecast"></a>
-## - delete_workforcemanagement_managementunit_week_shorttermforecast(management_unit_id, week_date_id, forecast_id)
+## delete_workforcemanagement_managementunit_week_shorttermforecast(management_unit_id, week_date_id, forecast_id)
Delete a short term forecast
@@ -430,11 +430,11 @@
* wfm:shortTermForecast:administer
* wfm:shortTermForecast:delete
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -459,11 +459,11 @@
#Delete a short term forecast
api_instance.delete_workforcemanagement_managementunit_week_shorttermforecast(management_unit_id, week_date_id, forecast_id)
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_week_shorttermforecast: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -484,11 +484,11 @@
<a name="delete_workforcemanagement_managementunit_workplan"></a>
-## - delete_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id)
+## delete_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id)
Delete a work plan
@@ -501,11 +501,11 @@
* wfm:workPlan:administer
* wfm:workPlan:delete
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -528,11 +528,11 @@
#Delete a work plan
api_instance.delete_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id)
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_workplan: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -552,11 +552,11 @@
<a name="get_workforcemanagement_adherence"></a>
-## -[**Array<UserScheduleAdherence>**](UserScheduleAdherence.html) get_workforcemanagement_adherence(user_id)
+## [**Array<UserScheduleAdherence>**](UserScheduleAdherence.html) get_workforcemanagement_adherence(user_id)
Get a list of UserScheduleAdherence records for the requested users
@@ -568,11 +568,11 @@
* wfm:realtimeAdherence:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -594,11 +594,11 @@
result = api_instance.get_workforcemanagement_adherence(user_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_adherence: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -617,11 +617,11 @@
<a name="get_workforcemanagement_managementunit"></a>
-## -[**ManagementUnit**](ManagementUnit.html) get_workforcemanagement_managementunit(mu_id, opts)
+## [**ManagementUnit**](ManagementUnit.html) get_workforcemanagement_managementunit(mu_id, opts)
Get management unit
@@ -676,11 +676,11 @@
* wfm:workPlan:edit
* wfm:workPlan:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -705,11 +705,11 @@
result = api_instance.get_workforcemanagement_managementunit(mu_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -729,11 +729,11 @@
<a name="get_workforcemanagement_managementunit_activitycode"></a>
-## -[**ActivityCode**](ActivityCode.html) get_workforcemanagement_managementunit_activitycode(mu_id, ac_id)
+## [**ActivityCode**](ActivityCode.html) get_workforcemanagement_managementunit_activitycode(mu_id, ac_id)
Get an activity code
@@ -746,11 +746,11 @@
* wfm:activityCode:administer
* wfm:activityCode:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -774,11 +774,11 @@
result = api_instance.get_workforcemanagement_managementunit_activitycode(mu_id, ac_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_activitycode: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -798,11 +798,11 @@
<a name="get_workforcemanagement_managementunit_activitycodes"></a>
-## -[**ActivityCodeContainer**](ActivityCodeContainer.html) get_workforcemanagement_managementunit_activitycodes(mu_id)
+## [**ActivityCodeContainer**](ActivityCodeContainer.html) get_workforcemanagement_managementunit_activitycodes(mu_id)
Get activity codes
@@ -857,11 +857,11 @@
* wfm:workPlan:edit
* wfm:workPlan:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -883,11 +883,11 @@
result = api_instance.get_workforcemanagement_managementunit_activitycodes(mu_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_activitycodes: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -906,11 +906,11 @@
<a name="get_workforcemanagement_managementunit_agent"></a>
-## -[**WfmAgent**](WfmAgent.html) get_workforcemanagement_managementunit_agent(management_unit_id, agent_id)
+## [**WfmAgent**](WfmAgent.html) get_workforcemanagement_managementunit_agent(management_unit_id, agent_id)
Get data for agent in the management unit
@@ -923,11 +923,11 @@
* wfm:agent:administer
* wfm:agent:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -951,11 +951,11 @@
result = api_instance.get_workforcemanagement_managementunit_agent(management_unit_id, agent_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_agent: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -975,11 +975,11 @@
<a name="get_workforcemanagement_managementunit_intraday_queues"></a>
-## -[**WfmIntradayQueueListing**](WfmIntradayQueueListing.html) get_workforcemanagement_managementunit_intraday_queues(mu_id, date)
+## [**WfmIntradayQueueListing**](WfmIntradayQueueListing.html) get_workforcemanagement_managementunit_intraday_queues(mu_id, date)
Get intraday queues for the given date
@@ -991,11 +991,11 @@
* wfm:intraday:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1019,11 +1019,11 @@
result = api_instance.get_workforcemanagement_managementunit_intraday_queues(mu_id, date)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_intraday_queues: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1043,11 +1043,11 @@
<a name="get_workforcemanagement_managementunit_scheduling_run"></a>
-## -[**SchedulingRunResponse**](SchedulingRunResponse.html) get_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id)
+## [**SchedulingRunResponse**](SchedulingRunResponse.html) get_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id)
Gets the status for a specific scheduling run
@@ -1059,11 +1059,11 @@
* wfm:schedule:generate
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1087,11 +1087,11 @@
result = api_instance.get_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_scheduling_run: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1111,11 +1111,11 @@
<a name="get_workforcemanagement_managementunit_scheduling_run_result"></a>
-## -[**RescheduleResult**](RescheduleResult.html) get_workforcemanagement_managementunit_scheduling_run_result(management_unit_id, run_id)
+## [**RescheduleResult**](RescheduleResult.html) get_workforcemanagement_managementunit_scheduling_run_result(management_unit_id, run_id)
Gets the result of a specific scheduling run
@@ -1127,11 +1127,11 @@
* wfm:schedule:generate
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1155,11 +1155,11 @@
result = api_instance.get_workforcemanagement_managementunit_scheduling_run_result(management_unit_id, run_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_scheduling_run_result: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1179,11 +1179,11 @@
<a name="get_workforcemanagement_managementunit_scheduling_runs"></a>
-## -[**SchedulingRunListResponse**](SchedulingRunListResponse.html) get_workforcemanagement_managementunit_scheduling_runs(management_unit_id)
+## [**SchedulingRunListResponse**](SchedulingRunListResponse.html) get_workforcemanagement_managementunit_scheduling_runs(management_unit_id)
Get the status of all the ongoing schedule runs
@@ -1195,11 +1195,11 @@
* wfm:schedule:generate
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1221,11 +1221,11 @@
result = api_instance.get_workforcemanagement_managementunit_scheduling_runs(management_unit_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_scheduling_runs: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1244,11 +1244,11 @@
<a name="get_workforcemanagement_managementunit_servicegoalgroup"></a>
-## -[**ServiceGoalGroup**](ServiceGoalGroup.html) get_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id)
+## [**ServiceGoalGroup**](ServiceGoalGroup.html) get_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id)
Get a service goal group
@@ -1261,11 +1261,11 @@
* wfm:serviceGoalGroup:administer
* wfm:serviceGoalGroup:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1289,11 +1289,11 @@
result = api_instance.get_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_servicegoalgroup: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1313,11 +1313,11 @@
<a name="get_workforcemanagement_managementunit_servicegoalgroups"></a>
-## -[**ServiceGoalGroupList**](ServiceGoalGroupList.html) get_workforcemanagement_managementunit_servicegoalgroups(management_unit_id)
+## [**ServiceGoalGroupList**](ServiceGoalGroupList.html) get_workforcemanagement_managementunit_servicegoalgroups(management_unit_id)
Get service goal groups
@@ -1332,11 +1332,11 @@
* wfm:shortTermForecast:administer
* wfm:shortTermForecast:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1358,11 +1358,11 @@
result = api_instance.get_workforcemanagement_managementunit_servicegoalgroups(management_unit_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_servicegoalgroups: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1381,11 +1381,11 @@
<a name="get_workforcemanagement_managementunit_settings"></a>
-## -[**ManagementUnitSettings**](ManagementUnitSettings.html) get_workforcemanagement_managementunit_settings(mu_id)
+## [**ManagementUnitSettings**](ManagementUnitSettings.html) get_workforcemanagement_managementunit_settings(mu_id)
Get the settings for the requested management unit
@@ -1398,11 +1398,11 @@
* wfm:managementUnit:administer
* wfm:managementUnit:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1424,11 +1424,11 @@
result = api_instance.get_workforcemanagement_managementunit_settings(mu_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_settings: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1447,11 +1447,11 @@
<a name="get_workforcemanagement_managementunit_user_timeoffrequest"></a>
-## -[**TimeOffRequestResponse**](TimeOffRequestResponse.html) get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id)
+## [**TimeOffRequestResponse**](TimeOffRequestResponse.html) get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id)
Get a time off request
@@ -1464,11 +1464,11 @@
* wfm:timeOffRequest:administer
* wfm:timeOffRequest:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1494,11 +1494,11 @@
result = api_instance.get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_user_timeoffrequest: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1519,11 +1519,11 @@
<a name="get_workforcemanagement_managementunit_user_timeoffrequests"></a>
-## -[**TimeOffRequestList**](TimeOffRequestList.html) get_workforcemanagement_managementunit_user_timeoffrequests(mu_id, user_id, opts)
+## [**TimeOffRequestList**](TimeOffRequestList.html) get_workforcemanagement_managementunit_user_timeoffrequests(mu_id, user_id, opts)
Get a list of time off requests for a given user
@@ -1536,11 +1536,11 @@
* wfm:timeOffRequest:administer
* wfm:timeOffRequest:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1567,11 +1567,11 @@
result = api_instance.get_workforcemanagement_managementunit_user_timeoffrequests(mu_id, user_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_user_timeoffrequests: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1592,11 +1592,11 @@
<a name="get_workforcemanagement_managementunit_users"></a>
-## -[**WfmUserEntityListing**](WfmUserEntityListing.html) get_workforcemanagement_managementunit_users(mu_id)
+## [**WfmUserEntityListing**](WfmUserEntityListing.html) get_workforcemanagement_managementunit_users(mu_id)
Get users in the management unit
@@ -1618,11 +1618,11 @@
* wfm:workPlan:administer
* wfm:workPlan:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1644,11 +1644,11 @@
result = api_instance.get_workforcemanagement_managementunit_users(mu_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_users: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1667,11 +1667,11 @@
<a name="get_workforcemanagement_managementunit_week_schedule"></a>
-## -[**WeekScheduleResponse**](WeekScheduleResponse.html) get_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts)
+## [**WeekScheduleResponse**](WeekScheduleResponse.html) get_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts)
Get a week schedule
@@ -1685,11 +1685,11 @@
* wfm:schedule:administer
* wfm:schedule:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1719,11 +1719,11 @@
result = api_instance.get_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_schedule: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1746,11 +1746,11 @@
<a name="get_workforcemanagement_managementunit_week_schedule_generationresults"></a>
-## -[**WeekScheduleGenerationResult**](WeekScheduleGenerationResult.html) get_workforcemanagement_managementunit_week_schedule_generationresults(management_unit_id, week_id, schedule_id)
+## [**WeekScheduleGenerationResult**](WeekScheduleGenerationResult.html) get_workforcemanagement_managementunit_week_schedule_generationresults(management_unit_id, week_id, schedule_id)
Get week schedule generation results
@@ -1764,11 +1764,11 @@
* wfm:schedule:administer
* wfm:schedule:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1794,11 +1794,11 @@
result = api_instance.get_workforcemanagement_managementunit_week_schedule_generationresults(management_unit_id, week_id, schedule_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_schedule_generationresults: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1819,11 +1819,11 @@
<a name="get_workforcemanagement_managementunit_week_schedules"></a>
-## -[**WeekScheduleListResponse**](WeekScheduleListResponse.html) get_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id)
+## [**WeekScheduleListResponse**](WeekScheduleListResponse.html) get_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id)
Get the list of schedules in a week in management unit
@@ -1837,11 +1837,11 @@
* wfm:schedule:administer
* wfm:schedule:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1865,11 +1865,11 @@
result = api_instance.get_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_schedules: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1889,11 +1889,11 @@
<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)
+## [**ForecastResultResponse**](ForecastResultResponse.html) get_workforcemanagement_managementunit_week_shorttermforecast_final(management_unit_id, week_date_id, forecast_id, opts)
Get the final result of a short term forecast calculation with modifications applied
@@ -1906,11 +1906,11 @@
* wfm:shortTermForecast:administer
* wfm:shortTermForecast:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1939,11 +1939,11 @@
result = api_instance.get_workforcemanagement_managementunit_week_shorttermforecast_final(management_unit_id, week_date_id, forecast_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_shorttermforecast_final: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1965,11 +1965,11 @@
<a name="get_workforcemanagement_managementunit_week_shorttermforecasts"></a>
-## -[**ShortTermForecastListResponse**](ShortTermForecastListResponse.html) get_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id)
+## [**ShortTermForecastListResponse**](ShortTermForecastListResponse.html) get_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id)
Get short term forecasts
@@ -1983,11 +1983,11 @@
* wfm:shortTermForecast:administer
* wfm:shortTermForecast:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2011,11 +2011,11 @@
result = api_instance.get_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_shorttermforecasts: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2035,11 +2035,11 @@
<a name="get_workforcemanagement_managementunit_workplan"></a>
-## -[**WorkPlan**](WorkPlan.html) get_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id)
+## [**WorkPlan**](WorkPlan.html) get_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id)
Get a work plan
@@ -2054,11 +2054,11 @@
* wfm:schedule:administer
* wfm:schedule:edit
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2082,11 +2082,11 @@
result = api_instance.get_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_workplan: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2106,11 +2106,11 @@
<a name="get_workforcemanagement_managementunit_workplans"></a>
-## -[**WorkPlanListResponse**](WorkPlanListResponse.html) get_workforcemanagement_managementunit_workplans(management_unit_id, opts)
+## [**WorkPlanListResponse**](WorkPlanListResponse.html) get_workforcemanagement_managementunit_workplans(management_unit_id, opts)
Get work plans
@@ -2128,11 +2128,11 @@
* wfm:schedule:view
* wfm:workPlan:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2157,11 +2157,11 @@
result = api_instance.get_workforcemanagement_managementunit_workplans(management_unit_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_workplans: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2181,11 +2181,11 @@
<a name="get_workforcemanagement_managementunits"></a>
-## -[**ManagementUnitListing**](ManagementUnitListing.html) get_workforcemanagement_managementunits(opts)
+## [**ManagementUnitListing**](ManagementUnitListing.html) get_workforcemanagement_managementunits(opts)
Get management units
@@ -2196,11 +2196,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2227,11 +2227,11 @@
result = api_instance.get_workforcemanagement_managementunits(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunits: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2254,11 +2254,11 @@
<a name="get_workforcemanagement_managementunits_divisionviews"></a>
-## -[**ManagementUnitListing**](ManagementUnitListing.html) get_workforcemanagement_managementunits_divisionviews(opts)
+## [**ManagementUnitListing**](ManagementUnitListing.html) get_workforcemanagement_managementunits_divisionviews(opts)
Get management units across divisions
@@ -2270,11 +2270,11 @@
* wfm:managementUnit:search
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2297,11 +2297,11 @@
result = api_instance.get_workforcemanagement_managementunits_divisionviews(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunits_divisionviews: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2320,11 +2320,11 @@
<a name="get_workforcemanagement_timeoffrequest"></a>
-## -[**TimeOffRequestResponse**](TimeOffRequestResponse.html) get_workforcemanagement_timeoffrequest(time_off_request_id)
+## [**TimeOffRequestResponse**](TimeOffRequestResponse.html) get_workforcemanagement_timeoffrequest(time_off_request_id)
Get a time off request for the current user
@@ -2337,11 +2337,11 @@
* wfm:agentSchedule:view
* wfm:agentTimeOffRequest:submit
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2363,11 +2363,11 @@
result = api_instance.get_workforcemanagement_timeoffrequest(time_off_request_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_timeoffrequest: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2386,11 +2386,11 @@
<a name="get_workforcemanagement_timeoffrequests"></a>
-## -[**TimeOffRequestList**](TimeOffRequestList.html) get_workforcemanagement_timeoffrequests(opts)
+## [**TimeOffRequestList**](TimeOffRequestList.html) get_workforcemanagement_timeoffrequests(opts)
Get a list of time off requests for the current user
@@ -2403,11 +2403,11 @@
* wfm:agentSchedule:view
* wfm:agentTimeOffRequest:submit
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2430,11 +2430,11 @@
result = api_instance.get_workforcemanagement_timeoffrequests(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_timeoffrequests: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2453,11 +2453,11 @@
<a name="patch_workforcemanagement_managementunit_activitycode"></a>
-## -[**ActivityCode**](ActivityCode.html) patch_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts)
+## [**ActivityCode**](ActivityCode.html) patch_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts)
Update an activity code
@@ -2470,11 +2470,11 @@
* wfm:activityCode:administer
* wfm:activityCode:edit
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2501,11 +2501,11 @@
result = api_instance.patch_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_activitycode: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2526,11 +2526,11 @@
<a name="patch_workforcemanagement_managementunit_scheduling_run"></a>
-## -[**RescheduleResult**](RescheduleResult.html) patch_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id, opts)
+## [**RescheduleResult**](RescheduleResult.html) patch_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id, opts)
Marks a specific scheduling run as applied, allowing a new rescheduling run to be started
@@ -2542,11 +2542,11 @@
* wfm:schedule:generate
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2573,11 +2573,11 @@
result = api_instance.patch_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_scheduling_run: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2598,11 +2598,11 @@
<a name="patch_workforcemanagement_managementunit_servicegoalgroup"></a>
-## -[**ServiceGoalGroup**](ServiceGoalGroup.html) patch_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts)
+## [**ServiceGoalGroup**](ServiceGoalGroup.html) patch_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts)
Update a service goal group
@@ -2615,11 +2615,11 @@
* wfm:serviceGoalGroup:administer
* wfm:serviceGoalGroup:edit
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2646,11 +2646,11 @@
result = api_instance.patch_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_servicegoalgroup: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2671,11 +2671,11 @@
<a name="patch_workforcemanagement_managementunit_settings"></a>
-## -[**ManagementUnitSettings**](ManagementUnitSettings.html) patch_workforcemanagement_managementunit_settings(mu_id, opts)
+## [**ManagementUnitSettings**](ManagementUnitSettings.html) patch_workforcemanagement_managementunit_settings(mu_id, opts)
Patch the settings for the requested management unit
@@ -2688,11 +2688,11 @@
* wfm:managementUnit:administer
* wfm:managementUnit:edit
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2717,11 +2717,11 @@
result = api_instance.patch_workforcemanagement_managementunit_settings(mu_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_settings: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2741,11 +2741,11 @@
<a name="patch_workforcemanagement_managementunit_user_timeoffrequest"></a>
-## -[**TimeOffRequestResponse**](TimeOffRequestResponse.html) patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts)
+## [**TimeOffRequestResponse**](TimeOffRequestResponse.html) patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts)
Update a time off request
@@ -2758,11 +2758,11 @@
* wfm:timeOffRequest:administer
* wfm:timeOffRequest:edit
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2791,11 +2791,11 @@
result = api_instance.patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_user_timeoffrequest: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2817,11 +2817,11 @@
<a name="patch_workforcemanagement_managementunit_week_schedule"></a>
-## -[**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) patch_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts)
+## [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) patch_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts)
Update a week schedule
@@ -2834,11 +2834,11 @@
* wfm:schedule:administer
* wfm:schedule:edit
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2869,11 +2869,11 @@
result = api_instance.patch_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_week_schedule: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2897,11 +2897,11 @@
<a name="patch_workforcemanagement_managementunit_workplan"></a>
-## -[**WorkPlan**](WorkPlan.html) patch_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts)
+## [**WorkPlan**](WorkPlan.html) patch_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts)
Update a work plan
@@ -2914,11 +2914,11 @@
* wfm:workPlan:administer
* wfm:workPlan:edit
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2945,11 +2945,11 @@
result = api_instance.patch_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_workplan: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2970,11 +2970,11 @@
<a name="patch_workforcemanagement_timeoffrequest"></a>
-## -[**TimeOffRequestResponse**](TimeOffRequestResponse.html) patch_workforcemanagement_timeoffrequest(time_off_request_id, opts)
+## [**TimeOffRequestResponse**](TimeOffRequestResponse.html) patch_workforcemanagement_timeoffrequest(time_off_request_id, opts)
Update a time off request for the current user
@@ -2986,11 +2986,11 @@
* wfm:agentTimeOffRequest:submit
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3015,11 +3015,11 @@
result = api_instance.patch_workforcemanagement_timeoffrequest(time_off_request_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_timeoffrequest: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3039,11 +3039,11 @@
<a name="post_workforcemanagement_adherence_historical"></a>
-## -[**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html) post_workforcemanagement_adherence_historical(opts)
+## [**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html) post_workforcemanagement_adherence_historical(opts)
Request a historical adherence report for users across management units
@@ -3055,11 +3055,11 @@
* wfm:historicalAdherence:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3082,11 +3082,11 @@
result = api_instance.post_workforcemanagement_adherence_historical(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_adherence_historical: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3105,11 +3105,11 @@
<a name="post_workforcemanagement_managementunit_activitycodes"></a>
-## -[**ActivityCode**](ActivityCode.html) post_workforcemanagement_managementunit_activitycodes(mu_id, opts)
+## [**ActivityCode**](ActivityCode.html) post_workforcemanagement_managementunit_activitycodes(mu_id, opts)
Create a new activity code
@@ -3122,11 +3122,11 @@
* wfm:activityCode:add
* wfm:activityCode:administer
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3151,11 +3151,11 @@
result = api_instance.post_workforcemanagement_managementunit_activitycodes(mu_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_activitycodes: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3175,11 +3175,11 @@
<a name="post_workforcemanagement_managementunit_historicaladherencequery"></a>
-## -[**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html) post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts)
+## [**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html) post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts)
Request a historical adherence report
@@ -3191,11 +3191,11 @@
* wfm:historicalAdherence:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3220,11 +3220,11 @@
result = api_instance.post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_historicaladherencequery: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3244,11 +3244,11 @@
<a name="post_workforcemanagement_managementunit_intraday"></a>
-## -[**IntradayResponse**](IntradayResponse.html) post_workforcemanagement_managementunit_intraday(mu_id, opts)
+## [**IntradayResponse**](IntradayResponse.html) post_workforcemanagement_managementunit_intraday(mu_id, opts)
Get intraday data for the given date for the requested queueIds
@@ -3260,11 +3260,11 @@
* wfm:intraday:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3289,11 +3289,11 @@
result = api_instance.post_workforcemanagement_managementunit_intraday(mu_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_intraday: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3313,11 +3313,11 @@
<a name="post_workforcemanagement_managementunit_schedules_search"></a>
-## -[**UserScheduleContainer**](UserScheduleContainer.html) post_workforcemanagement_managementunit_schedules_search(mu_id, opts)
+## [**UserScheduleContainer**](UserScheduleContainer.html) post_workforcemanagement_managementunit_schedules_search(mu_id, opts)
Query published schedules for given given time range for set of users
@@ -3331,11 +3331,11 @@
* wfm:schedule:administer
* wfm:schedule:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3360,11 +3360,11 @@
result = api_instance.post_workforcemanagement_managementunit_schedules_search(mu_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_schedules_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3384,11 +3384,11 @@
<a name="post_workforcemanagement_managementunit_servicegoalgroups"></a>
-## -[**ServiceGoalGroup**](ServiceGoalGroup.html) post_workforcemanagement_managementunit_servicegoalgroups(management_unit_id, opts)
+## [**ServiceGoalGroup**](ServiceGoalGroup.html) post_workforcemanagement_managementunit_servicegoalgroups(management_unit_id, opts)
Create a new service goal group
@@ -3401,11 +3401,11 @@
* wfm:serviceGoalGroup:add
* wfm:serviceGoalGroup:administer
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3430,11 +3430,11 @@
result = api_instance.post_workforcemanagement_managementunit_servicegoalgroups(management_unit_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_servicegoalgroups: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3454,11 +3454,11 @@
<a name="post_workforcemanagement_managementunit_timeoffrequests"></a>
-## -[**TimeOffRequestList**](TimeOffRequestList.html) post_workforcemanagement_managementunit_timeoffrequests(mu_id, opts)
+## [**TimeOffRequestList**](TimeOffRequestList.html) post_workforcemanagement_managementunit_timeoffrequests(mu_id, opts)
Create a new time off request
@@ -3471,11 +3471,11 @@
* wfm:timeOffRequest:administer
* wfm:timeOffRequest:add
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3500,11 +3500,11 @@
result = api_instance.post_workforcemanagement_managementunit_timeoffrequests(mu_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeoffrequests: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3524,11 +3524,11 @@
<a name="post_workforcemanagement_managementunit_timeoffrequests_fetchdetails"></a>
-## -[**TimeOffRequestEntityList**](TimeOffRequestEntityList.html) post_workforcemanagement_managementunit_timeoffrequests_fetchdetails(mu_id, opts)
+## [**TimeOffRequestEntityList**](TimeOffRequestEntityList.html) post_workforcemanagement_managementunit_timeoffrequests_fetchdetails(mu_id, opts)
Gets a list of time off requests from lookup ids
@@ -3541,11 +3541,11 @@
* wfm:timeOffRequest:administer
* wfm:timeOffRequest:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3570,11 +3570,11 @@
result = api_instance.post_workforcemanagement_managementunit_timeoffrequests_fetchdetails(mu_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeoffrequests_fetchdetails: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3594,11 +3594,11 @@
<a name="post_workforcemanagement_managementunit_timeoffrequests_query"></a>
-## -[**TimeOffRequestLookupList**](TimeOffRequestLookupList.html) post_workforcemanagement_managementunit_timeoffrequests_query(mu_id, opts)
+## [**TimeOffRequestLookupList**](TimeOffRequestLookupList.html) post_workforcemanagement_managementunit_timeoffrequests_query(mu_id, opts)
Gets the lookup ids to fetch the specified set of requests
@@ -3611,11 +3611,11 @@
* wfm:timeOffRequest:administer
* wfm:timeOffRequest:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3640,11 +3640,11 @@
result = api_instance.post_workforcemanagement_managementunit_timeoffrequests_query(mu_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeoffrequests_query: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3664,11 +3664,11 @@
<a name="post_workforcemanagement_managementunit_week_schedule_copy"></a>
-## -[**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedule_copy(management_unit_id, week_id, schedule_id, opts)
+## [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedule_copy(management_unit_id, week_id, schedule_id, opts)
Copy a week schedule
@@ -3681,11 +3681,11 @@
* wfm:schedule:add
* wfm:schedule:administer
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3716,11 +3716,11 @@
result = api_instance.post_workforcemanagement_managementunit_week_schedule_copy(management_unit_id, week_id, schedule_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedule_copy: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3744,11 +3744,11 @@
<a name="post_workforcemanagement_managementunit_week_schedule_reschedule"></a>
-## -[**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedule_reschedule(management_unit_id, week_id, schedule_id, opts)
+## [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedule_reschedule(management_unit_id, week_id, schedule_id, opts)
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
@@ -3761,11 +3761,11 @@
* wfm:schedule:administer
* wfm:schedule:edit
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3794,11 +3794,11 @@
result = api_instance.post_workforcemanagement_managementunit_week_schedule_reschedule(management_unit_id, week_id, schedule_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedule_reschedule: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3820,11 +3820,11 @@
<a name="post_workforcemanagement_managementunit_week_schedules"></a>
-## -[**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id, opts)
+## [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id, opts)
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
@@ -3837,11 +3837,11 @@
* wfm:schedule:add
* wfm:schedule:administer
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3870,11 +3870,11 @@
result = api_instance.post_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedules: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3897,11 +3897,11 @@
<a name="post_workforcemanagement_managementunit_week_schedules_generate"></a>
-## -[**GenerateWeekScheduleResponse**](GenerateWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedules_generate(management_unit_id, week_id, opts)
+## [**GenerateWeekScheduleResponse**](GenerateWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedules_generate(management_unit_id, week_id, opts)
Generate a week schedule
@@ -3913,11 +3913,11 @@
* wfm:schedule:generate
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3944,11 +3944,11 @@
result = api_instance.post_workforcemanagement_managementunit_week_schedules_generate(management_unit_id, week_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedules_generate: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3969,11 +3969,11 @@
<a name="post_workforcemanagement_managementunit_week_schedules_partialupload"></a>
-## -[**PartialUploadResponse**](PartialUploadResponse.html) post_workforcemanagement_managementunit_week_schedules_partialupload(management_unit_id, week_id, opts)
+## [**PartialUploadResponse**](PartialUploadResponse.html) post_workforcemanagement_managementunit_week_schedules_partialupload(management_unit_id, week_id, opts)
Partial upload of user schedules where activity count is greater than 17500
@@ -3987,11 +3987,11 @@
* wfm:schedule:administer
* wfm:schedule:edit
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -4018,11 +4018,11 @@
result = api_instance.post_workforcemanagement_managementunit_week_schedules_partialupload(management_unit_id, week_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedules_partialupload: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -4043,11 +4043,11 @@
<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)
+## [**ShortTermForecastResponse**](ShortTermForecastResponse.html) post_workforcemanagement_managementunit_week_shorttermforecast_copy(management_unit_id, week_date_id, forecast_id, body, opts)
Copy a short term forecast
@@ -4060,11 +4060,11 @@
* wfm:shortTermForecast:add
* wfm:shortTermForecast:administer
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -4095,11 +4095,11 @@
result = api_instance.post_workforcemanagement_managementunit_week_shorttermforecast_copy(management_unit_id, week_date_id, forecast_id, body, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shorttermforecast_copy: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -4122,11 +4122,11 @@
<a name="post_workforcemanagement_managementunit_week_shorttermforecasts"></a>
-## -[**ShortTermForecastResponse**](ShortTermForecastResponse.html) post_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id, body, opts)
+## [**ShortTermForecastResponse**](ShortTermForecastResponse.html) post_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id, body, opts)
Import a short term forecast
@@ -4139,11 +4139,11 @@
* wfm:shortTermForecast:add
* wfm:shortTermForecast:administer
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -4172,11 +4172,11 @@
result = api_instance.post_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id, body, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shorttermforecasts: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -4198,11 +4198,11 @@
<a name="post_workforcemanagement_managementunit_week_shorttermforecasts_generate"></a>
-## -[**GenerateShortTermForecastResponse**](GenerateShortTermForecastResponse.html) post_workforcemanagement_managementunit_week_shorttermforecasts_generate(management_unit_id, week_date_id, body, opts)
+## [**GenerateShortTermForecastResponse**](GenerateShortTermForecastResponse.html) post_workforcemanagement_managementunit_week_shorttermforecasts_generate(management_unit_id, week_date_id, body, opts)
Generate a short term forecast
@@ -4215,11 +4215,11 @@
* wfm:shortTermForecast:add
* wfm:shortTermForecast:administer
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -4248,11 +4248,11 @@
result = api_instance.post_workforcemanagement_managementunit_week_shorttermforecasts_generate(management_unit_id, week_date_id, body, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shorttermforecasts_generate: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -4274,11 +4274,11 @@
<a name="post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload"></a>
-## -[**PartialUploadResponse**](PartialUploadResponse.html) post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload(management_unit_id, week_date_id, body)
+## [**PartialUploadResponse**](PartialUploadResponse.html) post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload(management_unit_id, week_date_id, body)
Import a short term forecast
@@ -4291,11 +4291,11 @@
* wfm:shortTermForecast:add
* wfm:shortTermForecast:administer
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -4321,11 +4321,11 @@
result = api_instance.post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload(management_unit_id, week_date_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -4346,11 +4346,11 @@
<a name="post_workforcemanagement_managementunit_workplan_copy"></a>
-## -[**WorkPlan**](WorkPlan.html) post_workforcemanagement_managementunit_workplan_copy(management_unit_id, work_plan_id, opts)
+## [**WorkPlan**](WorkPlan.html) post_workforcemanagement_managementunit_workplan_copy(management_unit_id, work_plan_id, opts)
Create a copy of work plan
@@ -4363,11 +4363,11 @@
* wfm:workPlan:add
* wfm:workPlan:administer
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -4394,11 +4394,11 @@
result = api_instance.post_workforcemanagement_managementunit_workplan_copy(management_unit_id, work_plan_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_workplan_copy: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -4419,11 +4419,11 @@
<a name="post_workforcemanagement_managementunit_workplans"></a>
-## -[**WorkPlan**](WorkPlan.html) post_workforcemanagement_managementunit_workplans(management_unit_id, opts)
+## [**WorkPlan**](WorkPlan.html) post_workforcemanagement_managementunit_workplans(management_unit_id, opts)
Create a new work plan
@@ -4436,11 +4436,11 @@
* wfm:workPlan:add
* wfm:workPlan:administer
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -4465,11 +4465,11 @@
result = api_instance.post_workforcemanagement_managementunit_workplans(management_unit_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_workplans: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -4489,11 +4489,11 @@
<a name="post_workforcemanagement_managementunits"></a>
-## -[**ManagementUnit**](ManagementUnit.html) post_workforcemanagement_managementunits(opts)
+## [**ManagementUnit**](ManagementUnit.html) post_workforcemanagement_managementunits(opts)
Add a management unit
@@ -4506,11 +4506,11 @@
* wfm:managementUnit:administer
* wfm:managementUnit:add
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -4533,11 +4533,11 @@
result = api_instance.post_workforcemanagement_managementunits(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunits: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -4556,11 +4556,11 @@
<a name="post_workforcemanagement_schedules"></a>
-## -[**UserScheduleContainer**](UserScheduleContainer.html) post_workforcemanagement_schedules(opts)
+## [**UserScheduleContainer**](UserScheduleContainer.html) post_workforcemanagement_schedules(opts)
Get published schedule for the current user
@@ -4574,11 +4574,11 @@
* wfm:publishedSchedule:view
* wfm:schedule:administer
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -4601,11 +4601,11 @@
result = api_instance.post_workforcemanagement_schedules(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_schedules: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -4624,11 +4624,11 @@
<a name="post_workforcemanagement_timeoffrequests"></a>
-## -[**TimeOffRequestResponse**](TimeOffRequestResponse.html) post_workforcemanagement_timeoffrequests(opts)
+## [**TimeOffRequestResponse**](TimeOffRequestResponse.html) post_workforcemanagement_timeoffrequests(opts)
Create a time off request for the current user
@@ -4640,11 +4640,11 @@
* wfm:agentTimeOffRequest:submit
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -4667,10 +4667,10 @@
result = api_instance.post_workforcemanagement_timeoffrequests(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_timeoffrequests: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------