Class: PureCloud::WorkforceManagementApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/api/workforce_management_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WorkforceManagementApi

Returns a new instance of WorkforceManagementApi.



23
24
25
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 23

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_workforcemanagement_managementunit(mu_id, opts = {}) ⇒ nil

Delete management unit

Parameters:

  • mu_id —

    The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


32
33
34
35
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 32

def delete_workforcemanagement_managementunit(mu_id, opts = {})
  delete_workforcemanagement_managementunit_with_http_info(mu_id, opts)
  return nil
end

#delete_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts = {}) ⇒ nil

Deletes an activity code

Parameters:

  • mu_id —

    The ID of the management unit, or 'mine' for the management unit of the logged-in user.

  • ac_id —

    The ID of the activity code to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


97
98
99
100
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 97

def delete_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts = {})
  delete_workforcemanagement_managementunit_activitycode_with_http_info(mu_id, ac_id, opts)
  return nil
end

#delete_workforcemanagement_managementunit_activitycode_with_http_info(mu_id, ac_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Deletes an activity code

Parameters:

  • mu_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • ac_id —

    The ID of the activity code to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 108

def delete_workforcemanagement_managementunit_activitycode_with_http_info(mu_id, ac_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_managementunit_activitycode ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_activitycode" if mu_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'ac_id' is set
  fail ArgumentError, "Missing the required parameter 'ac_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_activitycode" if ac_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s).sub('{' + 'acId' + '}', ac_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_managementunit_activitycode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id, opts = {}) ⇒ nil

Cancel a schedule run

Parameters:

  • management_unit_id —

    The ID of the management unit.

  • run_id —

    The ID of the schedule run

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


171
172
173
174
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 171

def delete_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id, opts = {})
  delete_workforcemanagement_managementunit_scheduling_run_with_http_info(management_unit_id, run_id, opts)
  return nil
end

#delete_workforcemanagement_managementunit_scheduling_run_with_http_info(management_unit_id, run_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Cancel a schedule run

Parameters:

  • management_unit_id —

    The ID of the management unit.

  • run_id —

    The ID of the schedule run

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 182

def delete_workforcemanagement_managementunit_scheduling_run_with_http_info(management_unit_id, run_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_managementunit_scheduling_run ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_scheduling_run" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'run_id' is set
  fail ArgumentError, "Missing the required parameter 'run_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_scheduling_run" if run_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'runId' + '}', run_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_managementunit_scheduling_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts = {}) ⇒ nil

Delete a service goal group

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • service_goal_group_id —

    The ID of the service goal group to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


245
246
247
248
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 245

def delete_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts = {})
  delete_workforcemanagement_managementunit_servicegoalgroup_with_http_info(management_unit_id, service_goal_group_id, opts)
  return nil
end

#delete_workforcemanagement_managementunit_servicegoalgroup_with_http_info(management_unit_id, service_goal_group_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a service goal group

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • service_goal_group_id —

    The ID of the service goal group to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 256

def delete_workforcemanagement_managementunit_servicegoalgroup_with_http_info(management_unit_id, service_goal_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_managementunit_servicegoalgroup ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_servicegoalgroup" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'service_goal_group_id' is set
  fail ArgumentError, "Missing the required parameter 'service_goal_group_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_servicegoalgroup" if service_goal_group_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'serviceGoalGroupId' + '}', service_goal_group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_managementunit_servicegoalgroup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts = {}) ⇒ nil

Delete a schedule

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • week_id —

    First day of schedule week in yyyy-MM-dd format.

  • schedule_id —

    The ID of theschedule to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


320
321
322
323
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 320

def delete_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts = {})
  delete_workforcemanagement_managementunit_week_schedule_with_http_info(management_unit_id, week_id, schedule_id, opts)
  return nil
end

#delete_workforcemanagement_managementunit_week_schedule_with_http_info(management_unit_id, week_id, schedule_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a schedule

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • week_id —

    First day of schedule week in yyyy-MM-dd format.

  • schedule_id —

    The ID of theschedule to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 332

def delete_workforcemanagement_managementunit_week_schedule_with_http_info(management_unit_id, week_id, schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_managementunit_week_schedule ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_week_schedule" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_week_schedule" if week_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'schedule_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_week_schedule" if schedule_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_managementunit_week_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_workforcemanagement_managementunit_week_shorttermforecast(management_unit_id, week_date_id, forecast_id, opts = {}) ⇒ nil

Delete a short term forecast Must not be tied to any schedules

Parameters:

  • management_unit_id —

    The management unit ID of the management unit to which the forecast belongs

  • week_date_id —

    The week start date of the forecast in yyyy-MM-dd format

  • forecast_id —

    The ID of the forecast

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


404
405
406
407
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 404

def delete_workforcemanagement_managementunit_week_shorttermforecast(management_unit_id, week_date_id, forecast_id, opts = {})
  delete_workforcemanagement_managementunit_week_shorttermforecast_with_http_info(management_unit_id, week_date_id, forecast_id, opts)
  return nil
end

#delete_workforcemanagement_managementunit_week_shorttermforecast_with_http_info(management_unit_id, week_date_id, forecast_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a short term forecast Must not be tied to any schedules

Parameters:

  • management_unit_id —

    The management unit ID of the management unit to which the forecast belongs

  • week_date_id —

    The week start date of the forecast in yyyy-MM-dd format

  • forecast_id —

    The ID of the forecast

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 416

def delete_workforcemanagement_managementunit_week_shorttermforecast_with_http_info(management_unit_id, week_date_id, forecast_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_managementunit_week_shorttermforecast ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_week_shorttermforecast" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_week_shorttermforecast" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'forecast_id' is set
  fail ArgumentError, "Missing the required parameter 'forecast_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_week_shorttermforecast" if forecast_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s).sub('{' + 'forecastId' + '}', forecast_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_managementunit_week_shorttermforecast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_workforcemanagement_managementunit_with_http_info(mu_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete management unit

Parameters:

  • mu_id —

    The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 42

def delete_workforcemanagement_managementunit_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_managementunit ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit" if mu_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_managementunit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts = {}) ⇒ nil

Delete a work plan

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • work_plan_id —

    The ID of the work plan to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


487
488
489
490
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 487

def delete_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts = {})
  delete_workforcemanagement_managementunit_workplan_with_http_info(management_unit_id, work_plan_id, opts)
  return nil
end

#delete_workforcemanagement_managementunit_workplan_with_http_info(management_unit_id, work_plan_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a work plan

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • work_plan_id —

    The ID of the work plan to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 498

def delete_workforcemanagement_managementunit_workplan_with_http_info(management_unit_id, work_plan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.delete_workforcemanagement_managementunit_workplan ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_workplan" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'work_plan_id' is set
  fail ArgumentError, "Missing the required parameter 'work_plan_id' when calling WorkforceManagementApi.delete_workforcemanagement_managementunit_workplan" if work_plan_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'workPlanId' + '}', work_plan_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#delete_workforcemanagement_managementunit_workplan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_adherence(user_id, opts = {}) ⇒ Array<UserScheduleAdherence>

Get a list of UserScheduleAdherence records for the requested users

Parameters:

  • user_id —

    User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



560
561
562
563
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 560

def get_workforcemanagement_adherence(user_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_adherence_with_http_info(user_id, opts)
  return data
end

#get_workforcemanagement_adherence_with_http_info(user_id, opts = {}) ⇒ Array<(Array<UserScheduleAdherence>, Fixnum, Hash)>

Get a list of UserScheduleAdherence records for the requested users

Parameters:

  • user_id —

    User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<UserScheduleAdherence>, Fixnum, Hash)>) —

    Array<UserScheduleAdherence> data, response status code and response headers



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 570

def get_workforcemanagement_adherence_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_adherence ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling WorkforceManagementApi.get_workforcemanagement_adherence" if user_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/adherence".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'userId'] = @api_client.build_collection_param(user_id, :multi)

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<UserScheduleAdherence>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_adherence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_managementunit(mu_id, opts = {}) ⇒ ManagementUnit

Get management unit

Parameters:

  • mu_id —

    The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



627
628
629
630
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 627

def get_workforcemanagement_managementunit(mu_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_with_http_info(mu_id, opts)
  return data
end

#get_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts = {}) ⇒ ActivityCode

Get an activity code

Parameters:

  • mu_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • ac_id —

    The ID of the activity code to fetch

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



705
706
707
708
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 705

def get_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_activitycode_with_http_info(mu_id, ac_id, opts)
  return data
end

#get_workforcemanagement_managementunit_activitycode_with_http_info(mu_id, ac_id, opts = {}) ⇒ Array<(ActivityCode, Fixnum, Hash)>

Get an activity code

Parameters:

  • mu_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • ac_id —

    The ID of the activity code to fetch

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ActivityCode, Fixnum, Hash)>) —

    ActivityCode data, response status code and response headers



716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 716

def get_workforcemanagement_managementunit_activitycode_with_http_info(mu_id, ac_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_activitycode ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_activitycode" if mu_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'ac_id' is set
  fail ArgumentError, "Missing the required parameter 'ac_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_activitycode" if ac_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s).sub('{' + 'acId' + '}', ac_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ActivityCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_activitycode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_managementunit_activitycodes(mu_id, opts = {}) ⇒ ActivityCodeContainer

Get activity codes

Parameters:

  • mu_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



779
780
781
782
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 779

def get_workforcemanagement_managementunit_activitycodes(mu_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_activitycodes_with_http_info(mu_id, opts)
  return data
end

#get_workforcemanagement_managementunit_activitycodes_with_http_info(mu_id, opts = {}) ⇒ Array<(ActivityCodeContainer, Fixnum, Hash)>

Get activity codes

Parameters:

  • mu_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ActivityCodeContainer, Fixnum, Hash)>) —

    ActivityCodeContainer data, response status code and response headers



789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 789

def get_workforcemanagement_managementunit_activitycodes_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_activitycodes ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_activitycodes" if mu_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/activitycodes".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ActivityCodeContainer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_activitycodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_managementunit_agent(management_unit_id, agent_id, opts = {}) ⇒ WfmAgent

Get data for agent in the management unit

Parameters:

  • management_unit_id —

    The id of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • agent_id —

    The agent id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



845
846
847
848
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 845

def get_workforcemanagement_managementunit_agent(management_unit_id, agent_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_agent_with_http_info(management_unit_id, agent_id, opts)
  return data
end

#get_workforcemanagement_managementunit_agent_with_http_info(management_unit_id, agent_id, opts = {}) ⇒ Array<(WfmAgent, Fixnum, Hash)>

Get data for agent in the management unit

Parameters:

  • management_unit_id —

    The id of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • agent_id —

    The agent id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(WfmAgent, Fixnum, Hash)>) —

    WfmAgent data, response status code and response headers



856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 856

def get_workforcemanagement_managementunit_agent_with_http_info(management_unit_id, agent_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_agent ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_agent" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'agent_id' is set
  fail ArgumentError, "Missing the required parameter 'agent_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_agent" if agent_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'agentId' + '}', agent_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WfmAgent')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_agent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_managementunit_intraday_queues(mu_id, date, opts = {}) ⇒ WfmIntradayQueueListing

Get intraday queues for the given date

Parameters:

  • mu_id —

    The management unit ID of the management unit

  • date —

    yyyy-MM-dd date string interpreted in the configured management unit time zone

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



920
921
922
923
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 920

def get_workforcemanagement_managementunit_intraday_queues(mu_id, date, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_intraday_queues_with_http_info(mu_id, date, opts)
  return data
end

#get_workforcemanagement_managementunit_intraday_queues_with_http_info(mu_id, date, opts = {}) ⇒ Array<(WfmIntradayQueueListing, Fixnum, Hash)>

Get intraday queues for the given date

Parameters:

  • mu_id —

    The management unit ID of the management unit

  • date —

    yyyy-MM-dd date string interpreted in the configured management unit time zone

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(WfmIntradayQueueListing, Fixnum, Hash)>) —

    WfmIntradayQueueListing data, response status code and response headers



931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 931

def get_workforcemanagement_managementunit_intraday_queues_with_http_info(mu_id, date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_intraday_queues ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_intraday_queues" if mu_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'date' is set
  fail ArgumentError, "Missing the required parameter 'date' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_intraday_queues" if date.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/intraday/queues".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'date'] = date

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WfmIntradayQueueListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_intraday_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_managementunit_scheduling_runs(management_unit_id, opts = {}) ⇒ SchedulingRunListResponse

Get the status of all the ongoing schedule runs

Parameters:

  • management_unit_id —

    The ID of the management unit.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



995
996
997
998
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 995

def get_workforcemanagement_managementunit_scheduling_runs(management_unit_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_scheduling_runs_with_http_info(management_unit_id, opts)
  return data
end

#get_workforcemanagement_managementunit_scheduling_runs_with_http_info(management_unit_id, opts = {}) ⇒ Array<(SchedulingRunListResponse, Fixnum, Hash)>

Get the status of all the ongoing schedule runs

Parameters:

  • management_unit_id —

    The ID of the management unit.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SchedulingRunListResponse, Fixnum, Hash)>) —

    SchedulingRunListResponse data, response status code and response headers



1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1005

def get_workforcemanagement_managementunit_scheduling_runs_with_http_info(management_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_scheduling_runs ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_scheduling_runs" if management_unit_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SchedulingRunListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_scheduling_runs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts = {}) ⇒ ServiceGoalGroup

Get a service goal group

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • service_goal_group_id —

    The ID of the service goal group to fetch

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1061
1062
1063
1064
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1061

def get_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_servicegoalgroup_with_http_info(management_unit_id, service_goal_group_id, opts)
  return data
end

#get_workforcemanagement_managementunit_servicegoalgroup_with_http_info(management_unit_id, service_goal_group_id, opts = {}) ⇒ Array<(ServiceGoalGroup, Fixnum, Hash)>

Get a service goal group

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • service_goal_group_id —

    The ID of the service goal group to fetch

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ServiceGoalGroup, Fixnum, Hash)>) —

    ServiceGoalGroup data, response status code and response headers



1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1072

def get_workforcemanagement_managementunit_servicegoalgroup_with_http_info(management_unit_id, service_goal_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_servicegoalgroup ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_servicegoalgroup" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'service_goal_group_id' is set
  fail ArgumentError, "Missing the required parameter 'service_goal_group_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_servicegoalgroup" if service_goal_group_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'serviceGoalGroupId' + '}', service_goal_group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ServiceGoalGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_servicegoalgroup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_managementunit_servicegoalgroups(management_unit_id, opts = {}) ⇒ ServiceGoalGroupList

Get service goal groups

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1135
1136
1137
1138
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1135

def get_workforcemanagement_managementunit_servicegoalgroups(management_unit_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_servicegoalgroups_with_http_info(management_unit_id, opts)
  return data
end

#get_workforcemanagement_managementunit_servicegoalgroups_with_http_info(management_unit_id, opts = {}) ⇒ Array<(ServiceGoalGroupList, Fixnum, Hash)>

Get service goal groups

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ServiceGoalGroupList, Fixnum, Hash)>) —

    ServiceGoalGroupList data, response status code and response headers



1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1145

def get_workforcemanagement_managementunit_servicegoalgroups_with_http_info(management_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_servicegoalgroups ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_servicegoalgroups" if management_unit_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ServiceGoalGroupList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_servicegoalgroups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_managementunit_settings(mu_id, opts = {}) ⇒ ManagementUnitSettings

Get the settings for the requested management unit

Parameters:

  • mu_id —

    The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1200
1201
1202
1203
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1200

def get_workforcemanagement_managementunit_settings(mu_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_settings_with_http_info(mu_id, opts)
  return data
end

#get_workforcemanagement_managementunit_settings_with_http_info(mu_id, opts = {}) ⇒ Array<(ManagementUnitSettings, Fixnum, Hash)>

Get the settings for the requested management unit

Parameters:

  • mu_id —

    The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ManagementUnitSettings, Fixnum, Hash)>) —

    ManagementUnitSettings data, response status code and response headers



1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1210

def get_workforcemanagement_managementunit_settings_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_settings ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_settings" if mu_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/settings".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ManagementUnitSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts = {}) ⇒ TimeOffRequestResponse

Get a time off request

Parameters:

  • mu_id —

    The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • user_id —

    The userId to whom the Time Off Request applies.

  • time_off_request_id —

    Time Off Request Id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1267
1268
1269
1270
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1267

def get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_user_timeoffrequest_with_http_info(mu_id, user_id, time_off_request_id, opts)
  return data
end

#get_workforcemanagement_managementunit_user_timeoffrequest_with_http_info(mu_id, user_id, time_off_request_id, opts = {}) ⇒ Array<(TimeOffRequestResponse, Fixnum, Hash)>

Get a time off request

Parameters:

  • mu_id —

    The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • user_id —

    The userId to whom the Time Off Request applies.

  • time_off_request_id —

    Time Off Request Id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TimeOffRequestResponse, Fixnum, Hash)>) —

    TimeOffRequestResponse data, response status code and response headers



1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1279

def get_workforcemanagement_managementunit_user_timeoffrequest_with_http_info(mu_id, user_id, time_off_request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_user_timeoffrequest ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_user_timeoffrequest" if mu_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_user_timeoffrequest" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'time_off_request_id' is set
  fail ArgumentError, "Missing the required parameter 'time_off_request_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_user_timeoffrequest" if time_off_request_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s).sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'timeOffRequestId' + '}', time_off_request_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeOffRequestResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_user_timeoffrequest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_managementunit_user_timeoffrequests(mu_id, user_id, opts = {}) ⇒ TimeOffRequestList

Get a list of time off requests for a given user

Parameters:

  • mu_id —

    The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • user_id —

    The userId to whom the Time Off Request applies.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :recently_reviewed (BOOLEAN) —

    Limit results to requests that have been reviewed within the preceding 30 days (default to false)

Returns:



1352
1353
1354
1355
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1352

def get_workforcemanagement_managementunit_user_timeoffrequests(mu_id, user_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_user_timeoffrequests_with_http_info(mu_id, user_id, opts)
  return data
end

#get_workforcemanagement_managementunit_user_timeoffrequests_with_http_info(mu_id, user_id, opts = {}) ⇒ Array<(TimeOffRequestList, Fixnum, Hash)>

Get a list of time off requests for a given user

Parameters:

  • mu_id —

    The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • user_id —

    The userId to whom the Time Off Request applies.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :recently_reviewed (BOOLEAN) —

    Limit results to requests that have been reviewed within the preceding 30 days

Returns:

  • (Array<(TimeOffRequestList, Fixnum, Hash)>) —

    TimeOffRequestList data, response status code and response headers



1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1364

def get_workforcemanagement_managementunit_user_timeoffrequests_with_http_info(mu_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_user_timeoffrequests ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_user_timeoffrequests" if mu_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_user_timeoffrequests" if user_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'recentlyReviewed'] = opts[:'recently_reviewed'] if opts[:'recently_reviewed']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeOffRequestList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_user_timeoffrequests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_managementunit_users(mu_id, opts = {}) ⇒ WfmUserEntityListing

Get users in the management unit

Parameters:

  • mu_id —

    The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1434
1435
1436
1437
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1434

def get_workforcemanagement_managementunit_users(mu_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_users_with_http_info(mu_id, opts)
  return data
end

#get_workforcemanagement_managementunit_users_with_http_info(mu_id, opts = {}) ⇒ Array<(WfmUserEntityListing, Fixnum, Hash)>

Get users in the management unit

Parameters:

  • mu_id —

    The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(WfmUserEntityListing, Fixnum, Hash)>) —

    WfmUserEntityListing data, response status code and response headers



1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1444

def get_workforcemanagement_managementunit_users_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_users ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_users" if mu_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/users".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WfmUserEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts = {}) ⇒ WeekScheduleResponse

Get a week schedule

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • week_id —

    First day of schedule week in yyyy-MM-dd format.

  • schedule_id —

    The ID of the schedule to fetch

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Which fields, if any, to expand

  • :force_download_service (BOOLEAN) —

    Force the result of this operation to be sent via download service. For testing/app development purposes

Returns:



1503
1504
1505
1506
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1503

def get_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_week_schedule_with_http_info(management_unit_id, week_id, schedule_id, opts)
  return data
end

#get_workforcemanagement_managementunit_week_schedule_generationresults(management_unit_id, week_id, schedule_id, opts = {}) ⇒ WeekScheduleGenerationResult

Get week schedule generation results

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • week_id —

    First day of schedule week in yyyy-MM-dd format.

  • schedule_id —

    The ID of the schedule to fetch generation results

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1608
1609
1610
1611
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1608

def get_workforcemanagement_managementunit_week_schedule_generationresults(management_unit_id, week_id, schedule_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_week_schedule_generationresults_with_http_info(management_unit_id, week_id, schedule_id, opts)
  return data
end

#get_workforcemanagement_managementunit_week_schedule_generationresults_with_http_info(management_unit_id, week_id, schedule_id, opts = {}) ⇒ Array<(WeekScheduleGenerationResult, Fixnum, Hash)>

Get week schedule generation results

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • week_id —

    First day of schedule week in yyyy-MM-dd format.

  • schedule_id —

    The ID of the schedule to fetch generation results

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1620

def get_workforcemanagement_managementunit_week_schedule_generationresults_with_http_info(management_unit_id, week_id, schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedule_generationresults ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedule_generationresults" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedule_generationresults" if week_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'schedule_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedule_generationresults" if schedule_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WeekScheduleGenerationResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_week_schedule_generationresults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_managementunit_week_schedule_with_http_info(management_unit_id, week_id, schedule_id, opts = {}) ⇒ Array<(WeekScheduleResponse, Fixnum, Hash)>

Get a week schedule

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • week_id —

    First day of schedule week in yyyy-MM-dd format.

  • schedule_id —

    The ID of the schedule to fetch

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Which fields, if any, to expand

  • :force_download_service (BOOLEAN) —

    Force the result of this operation to be sent via download service. For testing/app development purposes

Returns:

  • (Array<(WeekScheduleResponse, Fixnum, Hash)>) —

    WeekScheduleResponse data, response status code and response headers



1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1517

def get_workforcemanagement_managementunit_week_schedule_with_http_info(management_unit_id, week_id, schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedule ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedule" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedule" if week_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'schedule_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedule" if schedule_id.nil?
  
  
  
  
  
  
  
  
  if opts[:'expand'] && !['generationResults', 'headcountForecast'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of generationResults, headcountForecast'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
  query_params[:'forceDownloadService'] = opts[:'force_download_service'] if opts[:'force_download_service']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WeekScheduleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_week_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id, opts = {}) ⇒ WeekScheduleListResponse

Get the list of schedules in a week in management unit

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • week_id —

    First day of schedule week in yyyy-MM-dd format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1692
1693
1694
1695
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1692

def get_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_week_schedules_with_http_info(management_unit_id, week_id, opts)
  return data
end

#get_workforcemanagement_managementunit_week_schedules_with_http_info(management_unit_id, week_id, opts = {}) ⇒ Array<(WeekScheduleListResponse, Fixnum, Hash)>

Get the list of schedules in a week in management unit

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • week_id —

    First day of schedule week in yyyy-MM-dd format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(WeekScheduleListResponse, Fixnum, Hash)>) —

    WeekScheduleListResponse data, response status code and response headers



1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1703

def get_workforcemanagement_managementunit_week_schedules_with_http_info(management_unit_id, week_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedules ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedules" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_schedules" if week_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WeekScheduleListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_week_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_managementunit_week_shorttermforecast_final(management_unit_id, week_date_id, forecast_id, opts = {}) ⇒ ForecastResultResponse

Get the final result of a short term forecast calculation with modifications applied

Parameters:

  • management_unit_id —

    The management unit ID of the management unit to which the forecast belongs

  • week_date_id —

    The week start date of the forecast in yyyy-MM-dd format

  • forecast_id —

    The ID of the forecast

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :force_download_service (BOOLEAN) —

    Force the result of this operation to be sent via download service. For testing/app development purposes

Returns:



1769
1770
1771
1772
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1769

def get_workforcemanagement_managementunit_week_shorttermforecast_final(management_unit_id, week_date_id, forecast_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_week_shorttermforecast_final_with_http_info(management_unit_id, week_date_id, forecast_id, opts)
  return data
end

#get_workforcemanagement_managementunit_week_shorttermforecast_final_with_http_info(management_unit_id, week_date_id, forecast_id, opts = {}) ⇒ Array<(ForecastResultResponse, Fixnum, Hash)>

Get the final result of a short term forecast calculation with modifications applied

Parameters:

  • management_unit_id —

    The management unit ID of the management unit to which the forecast belongs

  • week_date_id —

    The week start date of the forecast in yyyy-MM-dd format

  • forecast_id —

    The ID of the forecast

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :force_download_service (BOOLEAN) —

    Force the result of this operation to be sent via download service. For testing/app development purposes

Returns:

  • (Array<(ForecastResultResponse, Fixnum, Hash)>) —

    ForecastResultResponse data, response status code and response headers



1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1782

def get_workforcemanagement_managementunit_week_shorttermforecast_final_with_http_info(management_unit_id, week_date_id, forecast_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_week_shorttermforecast_final ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_shorttermforecast_final" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_shorttermforecast_final" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'forecast_id' is set
  fail ArgumentError, "Missing the required parameter 'forecast_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_shorttermforecast_final" if forecast_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/final".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s).sub('{' + 'forecastId' + '}', forecast_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'forceDownloadService'] = opts[:'force_download_service'] if opts[:'force_download_service']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ForecastResultResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_week_shorttermforecast_final\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id, opts = {}) ⇒ ShortTermForecastListResponse

Get short term forecasts Use "recent" for the ‘weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date

Parameters:

  • management_unit_id —

    The management unit ID of the management unit to which the forecast belongs

  • week_date_id —

    The week start date of the forecast in yyyy-MM-dd format

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1861
1862
1863
1864
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1861

def get_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_week_shorttermforecasts_with_http_info(management_unit_id, week_date_id, opts)
  return data
end

#get_workforcemanagement_managementunit_week_shorttermforecasts_with_http_info(management_unit_id, week_date_id, opts = {}) ⇒ Array<(ShortTermForecastListResponse, Fixnum, Hash)>

Get short term forecasts Use &quot;recent&quot; for the ‘weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date

Parameters:

  • management_unit_id —

    The management unit ID of the management unit to which the forecast belongs

  • week_date_id —

    The week start date of the forecast in yyyy-MM-dd format

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1872

def get_workforcemanagement_managementunit_week_shorttermforecasts_with_http_info(management_unit_id, week_date_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_week_shorttermforecasts ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_shorttermforecasts" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_week_shorttermforecasts" if week_date_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ShortTermForecastListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_week_shorttermforecasts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_managementunit_with_http_info(mu_id, opts = {}) ⇒ Array<(ManagementUnit, Fixnum, Hash)>

Get management unit

Parameters:

  • mu_id —

    The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

  • (Array<(ManagementUnit, Fixnum, Hash)>) —

    ManagementUnit data, response status code and response headers



638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 638

def get_workforcemanagement_managementunit_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit" if mu_id.nil?
  
  
  
  
  
  
  
  
  if opts[:'expand'] && !['settings'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of settings'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ManagementUnit')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts = {}) ⇒ WorkPlan

Get a work plan

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • work_plan_id —

    The ID of the work plan to fetch

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1936
1937
1938
1939
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1936

def get_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_workplan_with_http_info(management_unit_id, work_plan_id, opts)
  return data
end

#get_workforcemanagement_managementunit_workplan_with_http_info(management_unit_id, work_plan_id, opts = {}) ⇒ Array<(WorkPlan, Fixnum, Hash)>

Get a work plan

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • work_plan_id —

    The ID of the work plan to fetch

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(WorkPlan, Fixnum, Hash)>) —

    WorkPlan data, response status code and response headers



1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 1947

def get_workforcemanagement_managementunit_workplan_with_http_info(management_unit_id, work_plan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_workplan ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_workplan" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'work_plan_id' is set
  fail ArgumentError, "Missing the required parameter 'work_plan_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_workplan" if work_plan_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'workPlanId' + '}', work_plan_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkPlan')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_workplan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_managementunit_workplans(management_unit_id, opts = {}) ⇒ WorkPlanListResponse

Get work plans

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2011
2012
2013
2014
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2011

def get_workforcemanagement_managementunit_workplans(management_unit_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunit_workplans_with_http_info(management_unit_id, opts)
  return data
end

#get_workforcemanagement_managementunit_workplans_with_http_info(management_unit_id, opts = {}) ⇒ Array<(WorkPlanListResponse, Fixnum, Hash)>

Get work plans

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

  • (Array<(WorkPlanListResponse, Fixnum, Hash)>) —

    WorkPlanListResponse data, response status code and response headers



2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2022

def get_workforcemanagement_managementunit_workplans_with_http_info(management_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_workplans ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.get_workforcemanagement_managementunit_workplans" if management_unit_id.nil?
  
  
  
  
  
  
  
  
  if opts[:'expand'] && !['agentCount'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of agentCount'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkPlanListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_workplans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_managementunits(opts = {}) ⇒ ManagementUnitListing

Get management units

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer)
  • :page_number (Integer)
  • :expand (String)
  • :feature (String)
  • :division_id (String)

Returns:



2092
2093
2094
2095
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2092

def get_workforcemanagement_managementunits(opts = {})
  data, _status_code, _headers = get_workforcemanagement_managementunits_with_http_info(opts)
  return data
end

#get_workforcemanagement_managementunits_with_http_info(opts = {}) ⇒ Array<(ManagementUnitListing, Fixnum, Hash)>

Get management units

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer)
  • :page_number (Integer)
  • :expand (String)
  • :feature (String)
  • :division_id (String)

Returns:

  • (Array<(ManagementUnitListing, Fixnum, Hash)>) —

    ManagementUnitListing data, response status code and response headers



2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2106

def get_workforcemanagement_managementunits_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunits ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'expand'] && !['details'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of details'
  end
  
  
  
  
  
  
  
  if opts[:'feature'] && !['AgentSchedule', 'AgentTimeOffRequest', 'ActivityCodes', 'Agents', 'HistoricalAdherence', 'IntradayMonitoring', 'ManagementUnits', 'RealTimeAdherence', 'Schedules', 'ServiceGoalGroups', 'ShortTermForecasts', 'TimeOffRequests', 'WorkPlans'].include?(opts[:'feature'])
    fail ArgumentError, 'invalid value for "feature", must be one of AgentSchedule, AgentTimeOffRequest, ActivityCodes, Agents, HistoricalAdherence, IntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, ServiceGoalGroups, ShortTermForecasts, TimeOffRequests, WorkPlans'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
  query_params[:'feature'] = opts[:'feature'] if opts[:'feature']
  query_params[:'divisionId'] = opts[:'division_id'] if opts[:'division_id']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ManagementUnitListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_timeoffrequest(time_off_request_id, opts = {}) ⇒ TimeOffRequestResponse

Get a time off request for the current user

Parameters:

  • time_off_request_id —

    Time Off Request Id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2196
2197
2198
2199
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2196

def get_workforcemanagement_timeoffrequest(time_off_request_id, opts = {})
  data, _status_code, _headers = get_workforcemanagement_timeoffrequest_with_http_info(time_off_request_id, opts)
  return data
end

#get_workforcemanagement_timeoffrequest_with_http_info(time_off_request_id, opts = {}) ⇒ Array<(TimeOffRequestResponse, Fixnum, Hash)>

Get a time off request for the current user

Parameters:

  • time_off_request_id —

    Time Off Request Id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TimeOffRequestResponse, Fixnum, Hash)>) —

    TimeOffRequestResponse data, response status code and response headers



2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2206

def get_workforcemanagement_timeoffrequest_with_http_info(time_off_request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_timeoffrequest ..."
  end
  
  
  # verify the required parameter 'time_off_request_id' is set
  fail ArgumentError, "Missing the required parameter 'time_off_request_id' when calling WorkforceManagementApi.get_workforcemanagement_timeoffrequest" if time_off_request_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}".sub('{format}','json').sub('{' + 'timeOffRequestId' + '}', time_off_request_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeOffRequestResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_timeoffrequest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workforcemanagement_timeoffrequests(opts = {}) ⇒ TimeOffRequestList

Get a list of time off requests for the current user

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :recently_reviewed (BOOLEAN) —

    Limit results to requests that have been reviewed within the preceding 30 days (default to false)

Returns:



2261
2262
2263
2264
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2261

def get_workforcemanagement_timeoffrequests(opts = {})
  data, _status_code, _headers = get_workforcemanagement_timeoffrequests_with_http_info(opts)
  return data
end

#get_workforcemanagement_timeoffrequests_with_http_info(opts = {}) ⇒ Array<(TimeOffRequestList, Fixnum, Hash)>

Get a list of time off requests for the current user

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :recently_reviewed (BOOLEAN) —

    Limit results to requests that have been reviewed within the preceding 30 days

Returns:

  • (Array<(TimeOffRequestList, Fixnum, Hash)>) —

    TimeOffRequestList data, response status code and response headers



2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2271

def get_workforcemanagement_timeoffrequests_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_timeoffrequests ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/timeoffrequests".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'recentlyReviewed'] = opts[:'recently_reviewed'] if opts[:'recently_reviewed']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeOffRequestList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_timeoffrequests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts = {}) ⇒ ActivityCode

Update an activity code

Parameters:

  • mu_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • ac_id —

    The ID of the activity code to update

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



2327
2328
2329
2330
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2327

def patch_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts = {})
  data, _status_code, _headers = patch_workforcemanagement_managementunit_activitycode_with_http_info(mu_id, ac_id, opts)
  return data
end

#patch_workforcemanagement_managementunit_activitycode_with_http_info(mu_id, ac_id, opts = {}) ⇒ Array<(ActivityCode, Fixnum, Hash)>

Update an activity code

Parameters:

  • mu_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • ac_id —

    The ID of the activity code to update

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(ActivityCode, Fixnum, Hash)>) —

    ActivityCode data, response status code and response headers



2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2339

def patch_workforcemanagement_managementunit_activitycode_with_http_info(mu_id, ac_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_managementunit_activitycode ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_activitycode" if mu_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'ac_id' is set
  fail ArgumentError, "Missing the required parameter 'ac_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_activitycode" if ac_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s).sub('{' + 'acId' + '}', ac_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ActivityCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_managementunit_activitycode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts = {}) ⇒ ServiceGoalGroup

Update a service goal group

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • service_goal_group_id —

    The ID of the service goal group to update

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



2410
2411
2412
2413
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2410

def patch_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts = {})
  data, _status_code, _headers = patch_workforcemanagement_managementunit_servicegoalgroup_with_http_info(management_unit_id, service_goal_group_id, opts)
  return data
end

#patch_workforcemanagement_managementunit_servicegoalgroup_with_http_info(management_unit_id, service_goal_group_id, opts = {}) ⇒ Array<(ServiceGoalGroup, Fixnum, Hash)>

Update a service goal group

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • service_goal_group_id —

    The ID of the service goal group to update

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(ServiceGoalGroup, Fixnum, Hash)>) —

    ServiceGoalGroup data, response status code and response headers



2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2422

def patch_workforcemanagement_managementunit_servicegoalgroup_with_http_info(management_unit_id, service_goal_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_managementunit_servicegoalgroup ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_servicegoalgroup" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'service_goal_group_id' is set
  fail ArgumentError, "Missing the required parameter 'service_goal_group_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_servicegoalgroup" if service_goal_group_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'serviceGoalGroupId' + '}', service_goal_group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ServiceGoalGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_managementunit_servicegoalgroup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_workforcemanagement_managementunit_settings(mu_id, opts = {}) ⇒ ManagementUnitSettings

Patch the settings for the requested management unit

Parameters:

  • mu_id —

    The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



2492
2493
2494
2495
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2492

def patch_workforcemanagement_managementunit_settings(mu_id, opts = {})
  data, _status_code, _headers = patch_workforcemanagement_managementunit_settings_with_http_info(mu_id, opts)
  return data
end

#patch_workforcemanagement_managementunit_settings_with_http_info(mu_id, opts = {}) ⇒ Array<(ManagementUnitSettings, Fixnum, Hash)>

Patch the settings for the requested management unit

Parameters:

  • mu_id —

    The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(ManagementUnitSettings, Fixnum, Hash)>) —

    ManagementUnitSettings data, response status code and response headers



2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2503

def patch_workforcemanagement_managementunit_settings_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_managementunit_settings ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_settings" if mu_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/settings".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ManagementUnitSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_managementunit_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts = {}) ⇒ TimeOffRequestResponse

Update a time off request

Parameters:

  • mu_id —

    The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • user_id —

    The id of the user the requested time off request belongs to

  • time_off_request_id —

    The id of the time off request to update

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



2567
2568
2569
2570
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2567

def patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts = {})
  data, _status_code, _headers = patch_workforcemanagement_managementunit_user_timeoffrequest_with_http_info(mu_id, user_id, time_off_request_id, opts)
  return data
end

#patch_workforcemanagement_managementunit_user_timeoffrequest_with_http_info(mu_id, user_id, time_off_request_id, opts = {}) ⇒ Array<(TimeOffRequestResponse, Fixnum, Hash)>

Update a time off request

Parameters:

  • mu_id —

    The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • user_id —

    The id of the user the requested time off request belongs to

  • time_off_request_id —

    The id of the time off request to update

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(TimeOffRequestResponse, Fixnum, Hash)>) —

    TimeOffRequestResponse data, response status code and response headers



2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2580

def patch_workforcemanagement_managementunit_user_timeoffrequest_with_http_info(mu_id, user_id, time_off_request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_managementunit_user_timeoffrequest ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_user_timeoffrequest" if mu_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_user_timeoffrequest" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'time_off_request_id' is set
  fail ArgumentError, "Missing the required parameter 'time_off_request_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_user_timeoffrequest" if time_off_request_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s).sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'timeOffRequestId' + '}', time_off_request_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeOffRequestResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_managementunit_user_timeoffrequest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts = {}) ⇒ AsyncWeekScheduleResponse

Update a week schedule

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • week_id —

    First day of schedule week in yyyy-MM-dd format.

  • schedule_id —

    The ID of the schedule to update. Use partial uploads of user schedules if activity count in schedule is greater than 17500

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :force_async (BOOLEAN) —

    Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes

  • :force_download_service (BOOLEAN) —

    Force the result of this operation to be sent via download service. For testing/app development purposes

  • :body (UpdateWeekScheduleRequest) —

    body

Returns:



2662
2663
2664
2665
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2662

def patch_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts = {})
  data, _status_code, _headers = patch_workforcemanagement_managementunit_week_schedule_with_http_info(management_unit_id, week_id, schedule_id, opts)
  return data
end

#patch_workforcemanagement_managementunit_week_schedule_with_http_info(management_unit_id, week_id, schedule_id, opts = {}) ⇒ Array<(AsyncWeekScheduleResponse, Fixnum, Hash)>

Update a week schedule

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • week_id —

    First day of schedule week in yyyy-MM-dd format.

  • schedule_id —

    The ID of the schedule to update. Use partial uploads of user schedules if activity count in schedule is greater than 17500

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :force_async (BOOLEAN) —

    Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes

  • :force_download_service (BOOLEAN) —

    Force the result of this operation to be sent via download service. For testing/app development purposes

  • :body (UpdateWeekScheduleRequest) —

    body

Returns:

  • (Array<(AsyncWeekScheduleResponse, Fixnum, Hash)>) —

    AsyncWeekScheduleResponse data, response status code and response headers



2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2677

def patch_workforcemanagement_managementunit_week_schedule_with_http_info(management_unit_id, week_id, schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_managementunit_week_schedule ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_week_schedule" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_week_schedule" if week_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'schedule_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_week_schedule" if schedule_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'forceAsync'] = opts[:'force_async'] if opts[:'force_async']
  query_params[:'forceDownloadService'] = opts[:'force_download_service'] if opts[:'force_download_service']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsyncWeekScheduleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_managementunit_week_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts = {}) ⇒ WorkPlan

Update a work plan

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • work_plan_id —

    The ID of the work plan to update

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



2770
2771
2772
2773
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2770

def patch_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts = {})
  data, _status_code, _headers = patch_workforcemanagement_managementunit_workplan_with_http_info(management_unit_id, work_plan_id, opts)
  return data
end

#patch_workforcemanagement_managementunit_workplan_with_http_info(management_unit_id, work_plan_id, opts = {}) ⇒ Array<(WorkPlan, Fixnum, Hash)>

Update a work plan

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • work_plan_id —

    The ID of the work plan to update

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(WorkPlan, Fixnum, Hash)>) —

    WorkPlan data, response status code and response headers



2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2782

def patch_workforcemanagement_managementunit_workplan_with_http_info(management_unit_id, work_plan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_managementunit_workplan ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_workplan" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'work_plan_id' is set
  fail ArgumentError, "Missing the required parameter 'work_plan_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_workplan" if work_plan_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'workPlanId' + '}', work_plan_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkPlan')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_managementunit_workplan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_workforcemanagement_timeoffrequest(time_off_request_id, opts = {}) ⇒ TimeOffRequestResponse

Update a time off request for the current user

Parameters:

  • time_off_request_id —

    Time Off Request Id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



2852
2853
2854
2855
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2852

def patch_workforcemanagement_timeoffrequest(time_off_request_id, opts = {})
  data, _status_code, _headers = patch_workforcemanagement_timeoffrequest_with_http_info(time_off_request_id, opts)
  return data
end

#patch_workforcemanagement_timeoffrequest_with_http_info(time_off_request_id, opts = {}) ⇒ Array<(TimeOffRequestResponse, Fixnum, Hash)>

Update a time off request for the current user

Parameters:

  • time_off_request_id —

    Time Off Request Id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(TimeOffRequestResponse, Fixnum, Hash)>) —

    TimeOffRequestResponse data, response status code and response headers



2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2863

def patch_workforcemanagement_timeoffrequest_with_http_info(time_off_request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_timeoffrequest ..."
  end
  
  
  # verify the required parameter 'time_off_request_id' is set
  fail ArgumentError, "Missing the required parameter 'time_off_request_id' when calling WorkforceManagementApi.patch_workforcemanagement_timeoffrequest" if time_off_request_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}".sub('{format}','json').sub('{' + 'timeOffRequestId' + '}', time_off_request_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeOffRequestResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_timeoffrequest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_adherence_historical(opts = {}) ⇒ WfmHistoricalAdherenceResponse

Request a historical adherence report for users across management units

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



2924
2925
2926
2927
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2924

def post_workforcemanagement_adherence_historical(opts = {})
  data, _status_code, _headers = post_workforcemanagement_adherence_historical_with_http_info(opts)
  return data
end

#post_workforcemanagement_adherence_historical_with_http_info(opts = {}) ⇒ Array<(WfmHistoricalAdherenceResponse, Fixnum, Hash)>

Request a historical adherence report for users across management units

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2934

def post_workforcemanagement_adherence_historical_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_adherence_historical ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/adherence/historical".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WfmHistoricalAdherenceResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_adherence_historical\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_managementunit_activitycodes(mu_id, opts = {}) ⇒ ActivityCode

Create a new activity code

Parameters:

  • mu_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



2988
2989
2990
2991
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2988

def post_workforcemanagement_managementunit_activitycodes(mu_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_activitycodes_with_http_info(mu_id, opts)
  return data
end

#post_workforcemanagement_managementunit_activitycodes_with_http_info(mu_id, opts = {}) ⇒ Array<(ActivityCode, Fixnum, Hash)>

Create a new activity code

Parameters:

  • mu_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(ActivityCode, Fixnum, Hash)>) —

    ActivityCode data, response status code and response headers



2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 2999

def post_workforcemanagement_managementunit_activitycodes_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_activitycodes ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_activitycodes" if mu_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/activitycodes".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ActivityCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_activitycodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts = {}) ⇒ WfmHistoricalAdherenceResponse

Request a historical adherence report The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true

Parameters:

  • mu_id —

    The management unit ID of the management unit

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



3061
3062
3063
3064
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3061

def post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_historicaladherencequery_with_http_info(mu_id, opts)
  return data
end

#post_workforcemanagement_managementunit_historicaladherencequery_with_http_info(mu_id, opts = {}) ⇒ Array<(WfmHistoricalAdherenceResponse, Fixnum, Hash)>

Request a historical adherence report The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true

Parameters:

  • mu_id —

    The management unit ID of the management unit

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3072

def post_workforcemanagement_managementunit_historicaladherencequery_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_historicaladherencequery ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_historicaladherencequery" if mu_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/historicaladherencequery".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WfmHistoricalAdherenceResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_historicaladherencequery\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_managementunit_intraday(mu_id, opts = {}) ⇒ IntradayResponse

Get intraday data for the given date for the requested queueIds

Parameters:

  • mu_id —

    The management unit ID of the management unit

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



3134
3135
3136
3137
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3134

def post_workforcemanagement_managementunit_intraday(mu_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_intraday_with_http_info(mu_id, opts)
  return data
end

#post_workforcemanagement_managementunit_intraday_with_http_info(mu_id, opts = {}) ⇒ Array<(IntradayResponse, Fixnum, Hash)>

Get intraday data for the given date for the requested queueIds

Parameters:

  • mu_id —

    The management unit ID of the management unit

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(IntradayResponse, Fixnum, Hash)>) —

    IntradayResponse data, response status code and response headers



3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3145

def post_workforcemanagement_managementunit_intraday_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_intraday ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_intraday" if mu_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/intraday".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IntradayResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_intraday\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_managementunit_schedules_search(mu_id, opts = {}) ⇒ UserScheduleContainer

Query published schedules for given given time range for set of users

Parameters:

  • mu_id —

    The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



3207
3208
3209
3210
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3207

def post_workforcemanagement_managementunit_schedules_search(mu_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_schedules_search_with_http_info(mu_id, opts)
  return data
end

#post_workforcemanagement_managementunit_schedules_search_with_http_info(mu_id, opts = {}) ⇒ Array<(UserScheduleContainer, Fixnum, Hash)>

Query published schedules for given given time range for set of users

Parameters:

  • mu_id —

    The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(UserScheduleContainer, Fixnum, Hash)>) —

    UserScheduleContainer data, response status code and response headers



3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3218

def post_workforcemanagement_managementunit_schedules_search_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_schedules_search ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_schedules_search" if mu_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/schedules/search".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserScheduleContainer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_schedules_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_managementunit_servicegoalgroups(management_unit_id, opts = {}) ⇒ ServiceGoalGroup

Create a new service goal group

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



3280
3281
3282
3283
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3280

def post_workforcemanagement_managementunit_servicegoalgroups(management_unit_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_servicegoalgroups_with_http_info(management_unit_id, opts)
  return data
end

#post_workforcemanagement_managementunit_servicegoalgroups_with_http_info(management_unit_id, opts = {}) ⇒ Array<(ServiceGoalGroup, Fixnum, Hash)>

Create a new service goal group

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(ServiceGoalGroup, Fixnum, Hash)>) —

    ServiceGoalGroup data, response status code and response headers



3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3291

def post_workforcemanagement_managementunit_servicegoalgroups_with_http_info(management_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_servicegoalgroups ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_servicegoalgroups" if management_unit_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ServiceGoalGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_servicegoalgroups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_managementunit_timeoffrequests(mu_id, opts = {}) ⇒ TimeOffRequestList

Create a new time off request

Parameters:

  • mu_id —

    The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



3353
3354
3355
3356
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3353

def post_workforcemanagement_managementunit_timeoffrequests(mu_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_timeoffrequests_with_http_info(mu_id, opts)
  return data
end

#post_workforcemanagement_managementunit_timeoffrequests_fetchdetails(mu_id, opts = {}) ⇒ TimeOffRequestEntityList

Gets a list of time off requests from lookup ids

Parameters:

  • mu_id —

    The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



3426
3427
3428
3429
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3426

def post_workforcemanagement_managementunit_timeoffrequests_fetchdetails(mu_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_timeoffrequests_fetchdetails_with_http_info(mu_id, opts)
  return data
end

#post_workforcemanagement_managementunit_timeoffrequests_fetchdetails_with_http_info(mu_id, opts = {}) ⇒ Array<(TimeOffRequestEntityList, Fixnum, Hash)>

Gets a list of time off requests from lookup ids

Parameters:

  • mu_id —

    The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(TimeOffRequestEntityList, Fixnum, Hash)>) —

    TimeOffRequestEntityList data, response status code and response headers



3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3437

def post_workforcemanagement_managementunit_timeoffrequests_fetchdetails_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_timeoffrequests_fetchdetails ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_timeoffrequests_fetchdetails" if mu_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/fetchdetails".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeOffRequestEntityList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_timeoffrequests_fetchdetails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_managementunit_timeoffrequests_query(mu_id, opts = {}) ⇒ TimeOffRequestLookupList

Gets the lookup ids to fetch the specified set of requests

Parameters:

  • mu_id —

    The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



3499
3500
3501
3502
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3499

def post_workforcemanagement_managementunit_timeoffrequests_query(mu_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_timeoffrequests_query_with_http_info(mu_id, opts)
  return data
end

#post_workforcemanagement_managementunit_timeoffrequests_query_with_http_info(mu_id, opts = {}) ⇒ Array<(TimeOffRequestLookupList, Fixnum, Hash)>

Gets the lookup ids to fetch the specified set of requests

Parameters:

  • mu_id —

    The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(TimeOffRequestLookupList, Fixnum, Hash)>) —

    TimeOffRequestLookupList data, response status code and response headers



3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3510

def post_workforcemanagement_managementunit_timeoffrequests_query_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_timeoffrequests_query ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_timeoffrequests_query" if mu_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/query".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeOffRequestLookupList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_timeoffrequests_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_managementunit_timeoffrequests_with_http_info(mu_id, opts = {}) ⇒ Array<(TimeOffRequestList, Fixnum, Hash)>

Create a new time off request

Parameters:

  • mu_id —

    The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(TimeOffRequestList, Fixnum, Hash)>) —

    TimeOffRequestList data, response status code and response headers



3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3364

def post_workforcemanagement_managementunit_timeoffrequests_with_http_info(mu_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_timeoffrequests ..."
  end
  
  
  # verify the required parameter 'mu_id' is set
  fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_timeoffrequests" if mu_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeOffRequestList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_timeoffrequests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_managementunit_week_schedule_copy(management_unit_id, week_id, schedule_id, opts = {}) ⇒ AsyncWeekScheduleResponse

Copy a week schedule

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • week_id —

    First day of schedule week in yyyy-MM-dd format.

  • schedule_id —

    The ID of the schedule to copy from

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :force_async (BOOLEAN) —

    Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes

  • :force_download_service (BOOLEAN) —

    Force the result of this operation to be sent via download service. For testing/app development purposes

  • :body (CopyWeekScheduleRequest) —

    body

Returns:



3576
3577
3578
3579
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3576

def post_workforcemanagement_managementunit_week_schedule_copy(management_unit_id, week_id, schedule_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_week_schedule_copy_with_http_info(management_unit_id, week_id, schedule_id, opts)
  return data
end

#post_workforcemanagement_managementunit_week_schedule_copy_with_http_info(management_unit_id, week_id, schedule_id, opts = {}) ⇒ Array<(AsyncWeekScheduleResponse, Fixnum, Hash)>

Copy a week schedule

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • week_id —

    First day of schedule week in yyyy-MM-dd format.

  • schedule_id —

    The ID of the schedule to copy from

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :force_async (BOOLEAN) —

    Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes

  • :force_download_service (BOOLEAN) —

    Force the result of this operation to be sent via download service. For testing/app development purposes

  • :body (CopyWeekScheduleRequest) —

    body

Returns:

  • (Array<(AsyncWeekScheduleResponse, Fixnum, Hash)>) —

    AsyncWeekScheduleResponse data, response status code and response headers



3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3591

def post_workforcemanagement_managementunit_week_schedule_copy_with_http_info(management_unit_id, week_id, schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedule_copy ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedule_copy" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedule_copy" if week_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'schedule_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedule_copy" if schedule_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'forceAsync'] = opts[:'force_async'] if opts[:'force_async']
  query_params[:'forceDownloadService'] = opts[:'force_download_service'] if opts[:'force_download_service']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsyncWeekScheduleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_schedule_copy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id, opts = {}) ⇒ AsyncWeekScheduleResponse

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

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • week_id —

    First day of schedule week in yyyy-MM-dd format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :force_async (BOOLEAN) —

    Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes

  • :force_download_service (BOOLEAN) —

    Force the result of this operation to be sent via download service. For testing/app development purposes

  • :body (ImportWeekScheduleRequest) —

    body

Returns:



3686
3687
3688
3689
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3686

def post_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_week_schedules_with_http_info(management_unit_id, week_id, opts)
  return data
end

#post_workforcemanagement_managementunit_week_schedules_generate(management_unit_id, week_id, opts = {}) ⇒ GenerateWeekScheduleResponse

Generate a week schedule

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • week_id —

    First day of schedule week in yyyy-MM-dd format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



3785
3786
3787
3788
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3785

def post_workforcemanagement_managementunit_week_schedules_generate(management_unit_id, week_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_week_schedules_generate_with_http_info(management_unit_id, week_id, opts)
  return data
end

#post_workforcemanagement_managementunit_week_schedules_generate_with_http_info(management_unit_id, week_id, opts = {}) ⇒ Array<(GenerateWeekScheduleResponse, Fixnum, Hash)>

Generate a week schedule

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • week_id —

    First day of schedule week in yyyy-MM-dd format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3797

def post_workforcemanagement_managementunit_week_schedules_generate_with_http_info(management_unit_id, week_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedules_generate ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedules_generate" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedules_generate" if week_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/generate".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GenerateWeekScheduleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_schedules_generate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_managementunit_week_schedules_partialupload(management_unit_id, week_id, opts = {}) ⇒ PartialUploadResponse

Partial upload of user schedules where activity count is greater than 17500

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • week_id —

    First day of schedule week in yyyy-MM-dd format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



3868
3869
3870
3871
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3868

def post_workforcemanagement_managementunit_week_schedules_partialupload(management_unit_id, week_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_week_schedules_partialupload_with_http_info(management_unit_id, week_id, opts)
  return data
end

#post_workforcemanagement_managementunit_week_schedules_partialupload_with_http_info(management_unit_id, week_id, opts = {}) ⇒ Array<(PartialUploadResponse, Fixnum, Hash)>

Partial upload of user schedules where activity count is greater than 17500

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • week_id —

    First day of schedule week in yyyy-MM-dd format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(PartialUploadResponse, Fixnum, Hash)>) —

    PartialUploadResponse data, response status code and response headers



3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3880

def post_workforcemanagement_managementunit_week_schedules_partialupload_with_http_info(management_unit_id, week_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedules_partialupload ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedules_partialupload" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedules_partialupload" if week_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/partialupload".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PartialUploadResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_schedules_partialupload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_managementunit_week_schedules_with_http_info(management_unit_id, week_id, opts = {}) ⇒ Array<(AsyncWeekScheduleResponse, Fixnum, Hash)>

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

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • week_id —

    First day of schedule week in yyyy-MM-dd format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :force_async (BOOLEAN) —

    Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes

  • :force_download_service (BOOLEAN) —

    Force the result of this operation to be sent via download service. For testing/app development purposes

  • :body (ImportWeekScheduleRequest) —

    body

Returns:

  • (Array<(AsyncWeekScheduleResponse, Fixnum, Hash)>) —

    AsyncWeekScheduleResponse data, response status code and response headers



3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3700

def post_workforcemanagement_managementunit_week_schedules_with_http_info(management_unit_id, week_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedules ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedules" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_id' is set
  fail ArgumentError, "Missing the required parameter 'week_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_schedules" if week_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekId' + '}', week_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'forceAsync'] = opts[:'force_async'] if opts[:'force_async']
  query_params[:'forceDownloadService'] = opts[:'force_download_service'] if opts[:'force_download_service']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsyncWeekScheduleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_managementunit_week_shorttermforecast_copy(management_unit_id, week_date_id, forecast_id, body, opts = {}) ⇒ ShortTermForecastResponse

Copy a short term forecast

Parameters:

  • management_unit_id —

    The management unit ID of the management unit to which the forecast belongs

  • week_date_id —

    The week start date of the forecast in yyyy-MM-dd format

  • forecast_id —

    The ID of the forecast to copy

  • body —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :force_async (BOOLEAN) —

    Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes

Returns:



3953
3954
3955
3956
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3953

def post_workforcemanagement_managementunit_week_shorttermforecast_copy(management_unit_id, week_date_id, forecast_id, body, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_week_shorttermforecast_copy_with_http_info(management_unit_id, week_date_id, forecast_id, body, opts)
  return data
end

#post_workforcemanagement_managementunit_week_shorttermforecast_copy_with_http_info(management_unit_id, week_date_id, forecast_id, body, opts = {}) ⇒ Array<(ShortTermForecastResponse, Fixnum, Hash)>

Copy a short term forecast

Parameters:

  • management_unit_id —

    The management unit ID of the management unit to which the forecast belongs

  • week_date_id —

    The week start date of the forecast in yyyy-MM-dd format

  • forecast_id —

    The ID of the forecast to copy

  • body —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :force_async (BOOLEAN) —

    Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes

Returns:

  • (Array<(ShortTermForecastResponse, Fixnum, Hash)>) —

    ShortTermForecastResponse data, response status code and response headers



3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 3967

def post_workforcemanagement_managementunit_week_shorttermforecast_copy_with_http_info(management_unit_id, week_date_id, forecast_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecast_copy ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecast_copy" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecast_copy" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'forecast_id' is set
  fail ArgumentError, "Missing the required parameter 'forecast_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecast_copy" if forecast_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecast_copy" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s).sub('{' + 'forecastId' + '}', forecast_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'forceAsync'] = opts[:'force_async'] if opts[:'force_async']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ShortTermForecastResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_shorttermforecast_copy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id, body, opts = {}) ⇒ ShortTermForecastResponse

Import a short term forecast

Parameters:

  • management_unit_id —

    The management unit ID of the management unit to which the forecast belongs

  • week_date_id —

    The week start date of the forecast in yyyy-MM-dd format

  • body —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :force_async (BOOLEAN) —

    Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes

Returns:



4056
4057
4058
4059
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 4056

def post_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id, body, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_week_shorttermforecasts_with_http_info(management_unit_id, week_date_id, body, opts)
  return data
end

#post_workforcemanagement_managementunit_week_shorttermforecasts_generate(management_unit_id, week_date_id, body, opts = {}) ⇒ GenerateShortTermForecastResponse

Generate a short term forecast

Parameters:

  • management_unit_id —

    The management unit ID of the management unit to which the forecast belongs

  • week_date_id —

    The week start date of the forecast in yyyy-MM-dd format

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :force_async (BOOLEAN) —

    Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes

Returns:



4150
4151
4152
4153
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 4150

def post_workforcemanagement_managementunit_week_shorttermforecasts_generate(management_unit_id, week_date_id, body, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_week_shorttermforecasts_generate_with_http_info(management_unit_id, week_date_id, body, opts)
  return data
end

#post_workforcemanagement_managementunit_week_shorttermforecasts_generate_with_http_info(management_unit_id, week_date_id, body, opts = {}) ⇒ Array<(GenerateShortTermForecastResponse, Fixnum, Hash)>

Generate a short term forecast

Parameters:

  • management_unit_id —

    The management unit ID of the management unit to which the forecast belongs

  • week_date_id —

    The week start date of the forecast in yyyy-MM-dd format

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :force_async (BOOLEAN) —

    Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes

Returns:



4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 4163

def post_workforcemanagement_managementunit_week_shorttermforecasts_generate_with_http_info(management_unit_id, week_date_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts_generate ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts_generate" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts_generate" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts_generate" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/generate".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'forceAsync'] = opts[:'force_async'] if opts[:'force_async']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GenerateShortTermForecastResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_shorttermforecasts_generate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload(management_unit_id, week_date_id, body, opts = {}) ⇒ PartialUploadResponse

Import a short term forecast

Parameters:

  • management_unit_id —

    The management unit ID of the management unit to which the forecast belongs

  • week_date_id —

    The week start date of the forecast in yyyy-MM-dd format

  • body —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4243
4244
4245
4246
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 4243

def post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload(management_unit_id, week_date_id, body, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload_with_http_info(management_unit_id, week_date_id, body, opts)
  return data
end

#post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload_with_http_info(management_unit_id, week_date_id, body, opts = {}) ⇒ Array<(PartialUploadResponse, Fixnum, Hash)>

Import a short term forecast

Parameters:

  • management_unit_id —

    The management unit ID of the management unit to which the forecast belongs

  • week_date_id —

    The week start date of the forecast in yyyy-MM-dd format

  • body —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PartialUploadResponse, Fixnum, Hash)>) —

    PartialUploadResponse data, response status code and response headers



4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 4255

def post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload_with_http_info(management_unit_id, week_date_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/partialupload".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PartialUploadResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_managementunit_week_shorttermforecasts_with_http_info(management_unit_id, week_date_id, body, opts = {}) ⇒ Array<(ShortTermForecastResponse, Fixnum, Hash)>

Import a short term forecast

Parameters:

  • management_unit_id —

    The management unit ID of the management unit to which the forecast belongs

  • week_date_id —

    The week start date of the forecast in yyyy-MM-dd format

  • body —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :force_async (BOOLEAN) —

    Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes

Returns:

  • (Array<(ShortTermForecastResponse, Fixnum, Hash)>) —

    ShortTermForecastResponse data, response status code and response headers



4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 4069

def post_workforcemanagement_managementunit_week_shorttermforecasts_with_http_info(management_unit_id, week_date_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'week_date_id' is set
  fail ArgumentError, "Missing the required parameter 'week_date_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts" if week_date_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_week_shorttermforecasts" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'weekDateId' + '}', week_date_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'forceAsync'] = opts[:'force_async'] if opts[:'force_async']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ShortTermForecastResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_week_shorttermforecasts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_managementunit_workplan_copy(management_unit_id, work_plan_id, opts = {}) ⇒ WorkPlan

Create a copy of work plan

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • work_plan_id —

    The ID of the work plan to create a copy

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



4328
4329
4330
4331
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 4328

def post_workforcemanagement_managementunit_workplan_copy(management_unit_id, work_plan_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_workplan_copy_with_http_info(management_unit_id, work_plan_id, opts)
  return data
end

#post_workforcemanagement_managementunit_workplan_copy_with_http_info(management_unit_id, work_plan_id, opts = {}) ⇒ Array<(WorkPlan, Fixnum, Hash)>

Create a copy of work plan

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • work_plan_id —

    The ID of the work plan to create a copy

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(WorkPlan, Fixnum, Hash)>) —

    WorkPlan data, response status code and response headers



4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 4340

def post_workforcemanagement_managementunit_workplan_copy_with_http_info(management_unit_id, work_plan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_workplan_copy ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_workplan_copy" if management_unit_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'work_plan_id' is set
  fail ArgumentError, "Missing the required parameter 'work_plan_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_workplan_copy" if work_plan_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s).sub('{' + 'workPlanId' + '}', work_plan_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkPlan')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_workplan_copy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_managementunit_workplans(management_unit_id, opts = {}) ⇒ WorkPlan

Create a new work plan

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



4410
4411
4412
4413
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 4410

def post_workforcemanagement_managementunit_workplans(management_unit_id, opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunit_workplans_with_http_info(management_unit_id, opts)
  return data
end

#post_workforcemanagement_managementunit_workplans_with_http_info(management_unit_id, opts = {}) ⇒ Array<(WorkPlan, Fixnum, Hash)>

Create a new work plan

Parameters:

  • management_unit_id —

    The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(WorkPlan, Fixnum, Hash)>) —

    WorkPlan data, response status code and response headers



4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 4421

def post_workforcemanagement_managementunit_workplans_with_http_info(management_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_workplans ..."
  end
  
  
  # verify the required parameter 'management_unit_id' is set
  fail ArgumentError, "Missing the required parameter 'management_unit_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_workplans" if management_unit_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans".sub('{format}','json').sub('{' + 'managementUnitId' + '}', management_unit_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkPlan')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_workplans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_managementunits(opts = {}) ⇒ ManagementUnit

Add a management unit

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



4482
4483
4484
4485
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 4482

def post_workforcemanagement_managementunits(opts = {})
  data, _status_code, _headers = post_workforcemanagement_managementunits_with_http_info(opts)
  return data
end

#post_workforcemanagement_managementunits_with_http_info(opts = {}) ⇒ Array<(ManagementUnit, Fixnum, Hash)>

Add a management unit

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(ManagementUnit, Fixnum, Hash)>) —

    ManagementUnit data, response status code and response headers



4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 4492

def post_workforcemanagement_managementunits_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunits ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/managementunits".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ManagementUnit')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_schedules(opts = {}) ⇒ UserScheduleContainer

Get published schedule for the current user

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



4545
4546
4547
4548
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 4545

def post_workforcemanagement_schedules(opts = {})
  data, _status_code, _headers = post_workforcemanagement_schedules_with_http_info(opts)
  return data
end

#post_workforcemanagement_schedules_with_http_info(opts = {}) ⇒ Array<(UserScheduleContainer, Fixnum, Hash)>

Get published schedule for the current user

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(UserScheduleContainer, Fixnum, Hash)>) —

    UserScheduleContainer data, response status code and response headers



4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 4555

def post_workforcemanagement_schedules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_schedules ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/schedules".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserScheduleContainer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workforcemanagement_timeoffrequests(opts = {}) ⇒ TimeOffRequestResponse

Create a time off request for the current user

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



4608
4609
4610
4611
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 4608

def post_workforcemanagement_timeoffrequests(opts = {})
  data, _status_code, _headers = post_workforcemanagement_timeoffrequests_with_http_info(opts)
  return data
end

#post_workforcemanagement_timeoffrequests_with_http_info(opts = {}) ⇒ Array<(TimeOffRequestResponse, Fixnum, Hash)>

Create a time off request for the current user

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(TimeOffRequestResponse, Fixnum, Hash)>) —

    TimeOffRequestResponse data, response status code and response headers



4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
 
# File 'lib/purecloudplatformclientv2/api/workforce_management_api.rb', line 4618

def post_workforcemanagement_timeoffrequests_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_timeoffrequests ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/workforcemanagement/timeoffrequests".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeOffRequestResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_timeoffrequests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end