docs/WorkforceManagementApi.md in purecloudplatformclientv2-96.0.0 vs docs/WorkforceManagementApi.md in purecloudplatformclientv2-98.0.0
- old
+ new
@@ -1,9 +1,16 @@
---
title: WorkforceManagementApi
---
+:::error
+**The Ruby SDK is deprecated as of 9/16/2020**
+
+The Genesys Cloud Ruby SDK (v96.0.0) will be frozen at its current version level. Any new enhancements to our API or bug fixes will not be backported. If you do need to take advantage of new features or bug fixes outside the Genesys Cloud Ruby SDK, you will need to use the Genesys Cloud REST endpoints directly. More information can be found in the [Official Announcement](https://developer.mypurecloud.com/forum/t/announcement-genesys-cloud-ruby-sdk-end-of-life/8850).
+:::
+
+
## PureCloud::WorkforceManagementApi
All URIs are relative to *https://api.mypurecloud.com*
Method | Description
@@ -1270,10 +1277,16 @@
* wfm:timeOffRequest:view
* wfm:workPlan:add
* wfm:workPlan:delete
* wfm:workPlan:edit
* wfm:workPlan:view
+* wfm:workPlanRotation:add
+* wfm:workPlanRotation:delete
+* wfm:workPlanRotation:edit
+* wfm:workPlanRotation:view
+* coaching:appointment:add
+* coaching:appointment:edit
### Example
```{"language":"ruby"}
# load the gem
@@ -1624,11 +1637,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**business_unit_id** | **String**| The ID of the business unit, or 'mine' for the business unit of the logged-in user. | |
- **feature** | **String**| | [optional] <br />**Values**: AgentSchedule, AgentTimeOffRequest, ActivityCodes, Agents, BuActivityCodes, BusinessUnits, HistoricalAdherence, IntradayMonitoring, BuIntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, BuSchedules, ServiceGoalGroups, ServiceGoalTemplates, PlanningGroups, ShiftTrading, ShortTermForecasts, BuShortTermForecasts, TimeOffRequests, WorkPlans |
+ **feature** | **String**| | [optional] <br />**Values**: AgentSchedule, AgentTimeOffRequest, Coaching, ActivityCodes, Agents, BuActivityCodes, BusinessUnits, HistoricalAdherence, IntradayMonitoring, BuIntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, BuSchedules, ServiceGoalGroups, ServiceGoalTemplates, PlanningGroups, ShiftTrading, ShortTermForecasts, BuShortTermForecasts, TimeOffRequests, WorkPlanRotations, WorkPlans |
**division_id** | **String**| | [optional] |
{: class="table table-striped"}
### Return type
@@ -2834,11 +2847,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **feature** | **String**| | [optional] <br />**Values**: AgentSchedule, AgentTimeOffRequest, ActivityCodes, Agents, BuActivityCodes, BusinessUnits, HistoricalAdherence, IntradayMonitoring, BuIntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, BuSchedules, ServiceGoalGroups, ServiceGoalTemplates, PlanningGroups, ShiftTrading, ShortTermForecasts, BuShortTermForecasts, TimeOffRequests, WorkPlans |
+ **feature** | **String**| | [optional] <br />**Values**: AgentSchedule, AgentTimeOffRequest, Coaching, ActivityCodes, Agents, BuActivityCodes, BusinessUnits, HistoricalAdherence, IntradayMonitoring, BuIntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, BuSchedules, ServiceGoalGroups, ServiceGoalTemplates, PlanningGroups, ShiftTrading, ShortTermForecasts, BuShortTermForecasts, TimeOffRequests, WorkPlanRotations, WorkPlans |
**division_id** | **String**| | [optional] |
{: class="table table-striped"}
### Return type
@@ -2981,10 +2994,14 @@
* wfm:timeOffRequest:view
* wfm:workPlan:add
* wfm:workPlan:delete
* wfm:workPlan:edit
* wfm:workPlan:view
+* wfm:workPlanRotation:add
+* wfm:workPlanRotation:delete
+* wfm:workPlanRotation:edit
+* wfm:workPlanRotation:view
### Example
```{"language":"ruby"}
# load the gem
@@ -3278,11 +3295,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, opts)
Get data for agent in the management unit
@@ -3314,14 +3331,17 @@
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
+opts = {
+ exclude_capabilities: true # BOOLEAN | Excludes all capabilities of the agent such as queues, languages, and skills
+}
begin
#Get data for agent in the management unit
- result = api_instance.get_workforcemanagement_managementunit_agent(management_unit_id, agent_id)
+ result = api_instance.get_workforcemanagement_managementunit_agent(management_unit_id, agent_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_agent: #{e}"
end
```
@@ -3330,10 +3350,11 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**management_unit_id** | **String**| The id of the management unit, or 'mine' for the management unit of the logged-in user. | |
**agent_id** | **String**| The agent id | |
+ **exclude_capabilities** | **BOOLEAN**| Excludes all capabilities of the agent such as queues, languages, and skills | [optional] |
{: class="table table-striped"}
### Return type
@@ -4157,10 +4178,11 @@
* wfm:historicalAdherence:view
* wfm:publishedSchedule:view
* wfm:realtimeAdherence:view
* wfm:schedule:view
* wfm:timeOffRequest:view
+* wfm:workPlanRotation:view
* wfm:workPlan:view
### Example
```{"language":"ruby"}
@@ -4654,10 +4676,11 @@
Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}
Requires ANY permissions:
+* wfm:workPlanRotation:view
* wfm:workPlan:view
* wfm:schedule:edit
### Example
@@ -4726,10 +4749,11 @@
Requires ANY permissions:
* wfm:agent:view
* wfm:publishedSchedule:view
* wfm:schedule:view
+* wfm:workPlanRotation:view
* wfm:workPlan:view
### Example
```{"language":"ruby"}
@@ -4838,10 +4862,10 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**page_size** | **Integer**| | [optional] |
**page_number** | **Integer**| | [optional] |
**expand** | **String**| | [optional] <br />**Values**: details |
- **feature** | **String**| | [optional] <br />**Values**: AgentSchedule, AgentTimeOffRequest, ActivityCodes, Agents, BuActivityCodes, BusinessUnits, HistoricalAdherence, IntradayMonitoring, BuIntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, BuSchedules, ServiceGoalGroups, ServiceGoalTemplates, PlanningGroups, ShiftTrading, ShortTermForecasts, BuShortTermForecasts, TimeOffRequests, WorkPlans |
+ **feature** | **String**| | [optional] <br />**Values**: AgentSchedule, AgentTimeOffRequest, Coaching, ActivityCodes, Agents, BuActivityCodes, BusinessUnits, HistoricalAdherence, IntradayMonitoring, BuIntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, BuSchedules, ServiceGoalGroups, ServiceGoalTemplates, PlanningGroups, ShiftTrading, ShortTermForecasts, BuShortTermForecasts, TimeOffRequests, WorkPlanRotations, WorkPlans |
**division_id** | **String**| | [optional] |
{: class="table table-striped"}
### Return type