Uses of Class
com.mypurecloud.sdk.v2.model.WorkPlan

Packages that use WorkPlan

Package	Description
com.mypurecloud.sdk.v2.api
com.mypurecloud.sdk.v2.api.request
com.mypurecloud.sdk.v2.model

Uses of WorkPlan in com.mypurecloud.sdk.v2.api

Methods in com.mypurecloud.sdk.v2.api that return WorkPlan

Modifier and Type	Method	Description
WorkPlan	WorkforceManagementApi.getWorkforcemanagementManagementunitWorkplan(GetWorkforcemanagementManagementunitWorkplanRequest request)	Get a work plan
WorkPlan	WorkforceManagementApi.getWorkforcemanagementManagementunitWorkplan(String managementUnitId, String workPlanId, List<String> includeOnly)	Get a work plan
WorkPlan	WorkforceManagementApi.patchWorkforcemanagementManagementunitWorkplan(PatchWorkforcemanagementManagementunitWorkplanRequest request)	Update a work plan
WorkPlan	WorkforceManagementApi.patchWorkforcemanagementManagementunitWorkplan(String managementUnitId, String workPlanId, WorkPlan body, String validationMode)	Update a work plan
WorkPlan	WorkforceManagementApi.postWorkforcemanagementManagementunitWorkplanCopy(PostWorkforcemanagementManagementunitWorkplanCopyRequest request)	Create a copy of work plan
WorkPlan	WorkforceManagementApi.postWorkforcemanagementManagementunitWorkplanCopy(String managementUnitId, String workPlanId, CopyWorkPlan body)	Create a copy of work plan
WorkPlan	WorkforceManagementApi.postWorkforcemanagementManagementunitWorkplans(PostWorkforcemanagementManagementunitWorkplansRequest request)	Create a new work plan
WorkPlan	WorkforceManagementApi.postWorkforcemanagementManagementunitWorkplans(String managementUnitId, CreateWorkPlan body, String validationMode)	Create a new work plan

Methods in com.mypurecloud.sdk.v2.api that return types with arguments of type WorkPlan

Modifier and Type	Method	Description
ApiResponse<WorkPlan>	WorkforceManagementApi.getWorkforcemanagementManagementunitWorkplan(ApiRequest<Void> request)	Get a work plan
Future<WorkPlan>	WorkforceManagementApiAsync.getWorkforcemanagementManagementunitWorkplanAsync(GetWorkforcemanagementManagementunitWorkplanRequest request, AsyncApiCallback<WorkPlan> callback)	Get a work plan
Future<ApiResponse<WorkPlan>>	WorkforceManagementApiAsync.getWorkforcemanagementManagementunitWorkplanAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<WorkPlan>> callback)	Get a work plan
ApiResponse<WorkPlan>	WorkforceManagementApi.getWorkforcemanagementManagementunitWorkplanWithHttpInfo(String managementUnitId, String workPlanId, List<String> includeOnly)	Get a work plan
ApiResponse<WorkPlan>	WorkforceManagementApi.patchWorkforcemanagementManagementunitWorkplan(ApiRequest<WorkPlan> request)	Update a work plan
Future<WorkPlan>	WorkforceManagementApiAsync.patchWorkforcemanagementManagementunitWorkplanAsync(PatchWorkforcemanagementManagementunitWorkplanRequest request, AsyncApiCallback<WorkPlan> callback)	Update a work plan
Future<ApiResponse<WorkPlan>>	WorkforceManagementApiAsync.patchWorkforcemanagementManagementunitWorkplanAsync(ApiRequest<WorkPlan> request, AsyncApiCallback<ApiResponse<WorkPlan>> callback)	Update a work plan
ApiResponse<WorkPlan>	WorkforceManagementApi.patchWorkforcemanagementManagementunitWorkplanWithHttpInfo(String managementUnitId, String workPlanId, WorkPlan body, String validationMode)	Update a work plan
ApiResponse<WorkPlan>	WorkforceManagementApi.postWorkforcemanagementManagementunitWorkplanCopy(ApiRequest<CopyWorkPlan> request)	Create a copy of work plan
Future<WorkPlan>	WorkforceManagementApiAsync.postWorkforcemanagementManagementunitWorkplanCopyAsync(PostWorkforcemanagementManagementunitWorkplanCopyRequest request, AsyncApiCallback<WorkPlan> callback)	Create a copy of work plan
Future<ApiResponse<WorkPlan>>	WorkforceManagementApiAsync.postWorkforcemanagementManagementunitWorkplanCopyAsync(ApiRequest<CopyWorkPlan> request, AsyncApiCallback<ApiResponse<WorkPlan>> callback)	Create a copy of work plan
ApiResponse<WorkPlan>	WorkforceManagementApi.postWorkforcemanagementManagementunitWorkplanCopyWithHttpInfo(String managementUnitId, String workPlanId, CopyWorkPlan body)	Create a copy of work plan
ApiResponse<WorkPlan>	WorkforceManagementApi.postWorkforcemanagementManagementunitWorkplans(ApiRequest<CreateWorkPlan> request)	Create a new work plan
Future<WorkPlan>	WorkforceManagementApiAsync.postWorkforcemanagementManagementunitWorkplansAsync(PostWorkforcemanagementManagementunitWorkplansRequest request, AsyncApiCallback<WorkPlan> callback)	Create a new work plan
Future<ApiResponse<WorkPlan>>	WorkforceManagementApiAsync.postWorkforcemanagementManagementunitWorkplansAsync(ApiRequest<CreateWorkPlan> request, AsyncApiCallback<ApiResponse<WorkPlan>> callback)	Create a new work plan
ApiResponse<WorkPlan>	WorkforceManagementApi.postWorkforcemanagementManagementunitWorkplansWithHttpInfo(String managementUnitId, CreateWorkPlan body, String validationMode)	Create a new work plan

Methods in com.mypurecloud.sdk.v2.api with parameters of type WorkPlan

Modifier and Type	Method	Description
WorkPlan	WorkforceManagementApi.patchWorkforcemanagementManagementunitWorkplan(String managementUnitId, String workPlanId, WorkPlan body, String validationMode)	Update a work plan
ApiResponse<WorkPlan>	WorkforceManagementApi.patchWorkforcemanagementManagementunitWorkplanWithHttpInfo(String managementUnitId, String workPlanId, WorkPlan body, String validationMode)	Update a work plan

Method parameters in com.mypurecloud.sdk.v2.api with type arguments of type WorkPlan

Modifier and Type	Method	Description
Future<WorkPlan>	WorkforceManagementApiAsync.getWorkforcemanagementManagementunitWorkplanAsync(GetWorkforcemanagementManagementunitWorkplanRequest request, AsyncApiCallback<WorkPlan> callback)	Get a work plan
Future<ApiResponse<WorkPlan>>	WorkforceManagementApiAsync.getWorkforcemanagementManagementunitWorkplanAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<WorkPlan>> callback)	Get a work plan
ApiResponse<WorkPlan>	WorkforceManagementApi.patchWorkforcemanagementManagementunitWorkplan(ApiRequest<WorkPlan> request)	Update a work plan
Future<WorkPlan>	WorkforceManagementApiAsync.patchWorkforcemanagementManagementunitWorkplanAsync(PatchWorkforcemanagementManagementunitWorkplanRequest request, AsyncApiCallback<WorkPlan> callback)	Update a work plan
Future<ApiResponse<WorkPlan>>	WorkforceManagementApiAsync.patchWorkforcemanagementManagementunitWorkplanAsync(ApiRequest<WorkPlan> request, AsyncApiCallback<ApiResponse<WorkPlan>> callback)	Update a work plan
Future<ApiResponse<WorkPlan>>	WorkforceManagementApiAsync.patchWorkforcemanagementManagementunitWorkplanAsync(ApiRequest<WorkPlan> request, AsyncApiCallback<ApiResponse<WorkPlan>> callback)	Update a work plan
Future<WorkPlan>	WorkforceManagementApiAsync.postWorkforcemanagementManagementunitWorkplanCopyAsync(PostWorkforcemanagementManagementunitWorkplanCopyRequest request, AsyncApiCallback<WorkPlan> callback)	Create a copy of work plan
Future<ApiResponse<WorkPlan>>	WorkforceManagementApiAsync.postWorkforcemanagementManagementunitWorkplanCopyAsync(ApiRequest<CopyWorkPlan> request, AsyncApiCallback<ApiResponse<WorkPlan>> callback)	Create a copy of work plan
Future<WorkPlan>	WorkforceManagementApiAsync.postWorkforcemanagementManagementunitWorkplansAsync(PostWorkforcemanagementManagementunitWorkplansRequest request, AsyncApiCallback<WorkPlan> callback)	Create a new work plan
Future<ApiResponse<WorkPlan>>	WorkforceManagementApiAsync.postWorkforcemanagementManagementunitWorkplansAsync(ApiRequest<CreateWorkPlan> request, AsyncApiCallback<ApiResponse<WorkPlan>> callback)	Create a new work plan

Uses of WorkPlan in com.mypurecloud.sdk.v2.api.request

Methods in com.mypurecloud.sdk.v2.api.request that return WorkPlan

Modifier and Type	Method	Description
WorkPlan	PatchWorkforcemanagementManagementunitWorkplanRequest.getBody()

Methods in com.mypurecloud.sdk.v2.api.request that return types with arguments of type WorkPlan

Modifier and Type	Method	Description
ApiRequest<WorkPlan>	PatchWorkforcemanagementManagementunitWorkplanRequest.withHttpInfo()

Methods in com.mypurecloud.sdk.v2.api.request with parameters of type WorkPlan

Modifier and Type	Method	Description
static PatchWorkforcemanagementManagementunitWorkplanRequest.Builder	PatchWorkforcemanagementManagementunitWorkplanRequest.builder(String managementUnitId, String workPlanId, WorkPlan body)
void	PatchWorkforcemanagementManagementunitWorkplanRequest.setBody(WorkPlan body)
PatchWorkforcemanagementManagementunitWorkplanRequest.Builder	PatchWorkforcemanagementManagementunitWorkplanRequest.Builder.withBody(WorkPlan body)
PatchWorkforcemanagementManagementunitWorkplanRequest	PatchWorkforcemanagementManagementunitWorkplanRequest.withBody(WorkPlan body)
PatchWorkforcemanagementManagementunitWorkplanRequest.Builder	PatchWorkforcemanagementManagementunitWorkplanRequest.Builder.withRequiredParams(String managementUnitId, String workPlanId, WorkPlan body)

Uses of WorkPlan in com.mypurecloud.sdk.v2.model

Methods in com.mypurecloud.sdk.v2.model that return WorkPlan

Modifier and Type	Method	Description
WorkPlan	WorkPlan.agentCount(Integer agentCount)	Number of agents in this work plan
WorkPlan	WorkPlan.agents(List<DeletableUserReference> agents)	Agents in this work plan
WorkPlan	WorkPlan.constrainMaximumConsecutiveWorkingDays(Boolean constrainMaximumConsecutiveWorkingDays)	Whether to constrain the maximum consecutive working days
WorkPlan	WorkPlan.constrainMaximumConsecutiveWorkingWeekends(Boolean constrainMaximumConsecutiveWorkingWeekends)	Whether to constrain the maximum consecutive working weekends
WorkPlan	WorkPlan.constrainMaximumWorkingWeekendsPerPlanningPeriod(Boolean constrainMaximumWorkingWeekendsPerPlanningPeriod)	Whether to constrain the maximum working weekends in the planning period
WorkPlan	WorkPlan.constrainMinimumTimeBetweenShifts(Boolean constrainMinimumTimeBetweenShifts)	Whether the minimum time between shifts constraint is enabled for this work plan
WorkPlan	WorkPlan.constrainPaidTimeGranularity(Boolean constrainPaidTimeGranularity)	Whether paid time granularity is constrained for this work plan
WorkPlan	WorkPlan.constrainWeeklyPaidTime(Boolean constrainWeeklyPaidTime)	Whether the weekly paid time constraint is enabled for this work plan
WorkPlan	WorkPlan.enabled(Boolean enabled)	Whether the work plan is enabled for scheduling
WorkPlan	WorkPlan.flexibleWeeklyPaidTime(Boolean flexibleWeeklyPaidTime)	Whether the weekly paid time constraint is flexible for this work plan
WorkPlan	WorkPlan.id(String id)	The globally unique identifier for the object.
WorkPlan	WorkPlan.maximumConsecutiveWorkingDays(Integer maximumConsecutiveWorkingDays)	The maximum number of consecutive days that agents assigned to this work plan are allowed to work.
WorkPlan	WorkPlan.maximumConsecutiveWorkingWeekends(Integer maximumConsecutiveWorkingWeekends)	The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work
WorkPlan	WorkPlan.maximumDays(Integer maximumDays)	Maximum number days in a week allowed to be scheduled for this work plan
WorkPlan	WorkPlan.maximumDaysOffPerPlanningPeriod(Integer maximumDaysOffPerPlanningPeriod)	Maximum days off in the planning period
WorkPlan	WorkPlan.maximumPaidMinutesPerPlanningPeriod(Integer maximumPaidMinutesPerPlanningPeriod)	Maximum paid minutes in the planning period
WorkPlan	WorkPlan.maximumWorkingWeekendsPerPlanningPeriod(Integer maximumWorkingWeekendsPerPlanningPeriod)	Maximum working weekends in the planning period
WorkPlan	WorkPlan.metadata(WfmVersionedEntityMetadata metadata)	Version metadata for this work plan
WorkPlan	WorkPlan.minimumConsecutiveNonWorkingMinutesPerWeek(Integer minimumConsecutiveNonWorkingMinutesPerWeek)	Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off
WorkPlan	WorkPlan.minimumDaysOffPerPlanningPeriod(Integer minimumDaysOffPerPlanningPeriod)	Minimum days off in the planning period
WorkPlan	WorkPlan.minimumPaidMinutesPerPlanningPeriod(Integer minimumPaidMinutesPerPlanningPeriod)	Minimum paid minutes in the planning period
WorkPlan	WorkPlan.minimumShiftStartDistanceMinutes(Integer minimumShiftStartDistanceMinutes)	The time period in minutes for the duration between the start times of two consecutive working days
WorkPlan	WorkPlan.minimumTimeBetweenShiftsMinutes(Integer minimumTimeBetweenShiftsMinutes)	Minimum time between shifts in minutes defined in this work plan.
WorkPlan	WorkPlan.minimumWorkingDaysPerWeek(Integer minimumWorkingDaysPerWeek)	The minimum number of days that agents assigned to a work plan must work per week
WorkPlan	WorkPlan.name(String name)
WorkPlan	WorkPlan.optionalDays(SetWrapperDayOfWeek optionalDays)	Optional days to schedule for this work plan
WorkPlan	WorkPlan.paidTimeGranularityMinutes(Integer paidTimeGranularityMinutes)	Granularity in minutes allowed for shift paid time in this work plan.
WorkPlan	WorkPlan.shifts(List<WorkPlanShift> shifts)	Shifts in this work plan
WorkPlan	WorkPlan.shiftStartVariancePeriod(WorkPlan.ShiftStartVariancePeriodEnum shiftStartVariancePeriod)	The length of the period over which the maximum shift start time variance is applied
WorkPlan	WorkPlan.shiftStartVariances(ListWrapperShiftStartVariance shiftStartVariances)	Variance in minutes among start times of shifts in this work plan
WorkPlan	WorkPlan.shiftStartVarianceType(WorkPlan.ShiftStartVarianceTypeEnum shiftStartVarianceType)	This constraint ensures that an agent starts each workday within a user-defined time threshold
WorkPlan	WorkPlan.weeklyExactPaidMinutes(Integer weeklyExactPaidMinutes)	Exact weekly paid time in minutes for this work plan.
WorkPlan	WorkPlan.weeklyMaximumPaidMinutes(Integer weeklyMaximumPaidMinutes)	Maximum weekly paid time in minutes for this work plan.
WorkPlan	WorkPlan.weeklyMinimumPaidMinutes(Integer weeklyMinimumPaidMinutes)	Minimum weekly paid time in minutes for this work plan.