UpdateDraftSchedule

Updates the @name, @description, and @datetime_range of the given @draft_schedule_sid for the org sending the request.
The @name, @description, and @datetime_range fields must all be set with their desired values.
If @delete_shifts_not_in_range if true, then any instances outside of the @datetime_range will be permenantly deleted with no recovery option.
If @delete_shifts_not_in_range is false, instances outside of the new @datetime_range will be retained, for use if the datetime range is expanded to cover the instances in the future.
If @copy_shifts_into_new_range time is true, then new the portion of an expanded @datetime_range which has no instances will copy the instances from the published schedule. If false, no instances will be created for an expanded @scheduling_range.
Returns the updated schedule without any shift instances.
Errors:

grpc.Invalid: the @name, @description or @datetime_range are invalid.

grpc.Internal: error occurs when updating the schedule or its instances.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Request message for the UpdateDraftSchedule RPC.

datetime_range

object (DatetimeRange)

datetime_range

optional

Range to retrieve shift instances and segments from the published schedule to use for this draft schedule.

start_datetime

string <date-time>

start_datetime

optional

begining datetime

Examples:

1s1.000340012s

end_datetime

string <date-time>

end_datetime

optional

ending datetime

Examples:

1s1.000340012s

name

string

name

optional

Name of the draft schedule.

description

string

description

optional

Description of the draft schedule.

delete_shifts_not_in_range

boolean

delete_shifts_not_in_range

optional

Set to true to delete any shift instances belonging to the draft schedule, which are outside of the new @datetime_range.
If false, instances outside of the new @datetime_range will be retained, for use if the datetime range is expanded to cover the instances in the future.

copy_shifts_into_new_range

boolean

copy_shifts_into_new_range

optional

Set to true to copy shift instances from the published schedule into regions of the schedule with no shift instances.

get_updated_shifts

boolean

get_updated_shifts

deprecated

Set to true to get the draft schedule with the updated schedule range, shift instances, and shift segments

draft_schedule_sid

integer <int64> | string

draft_schedule_sid

optional

ID of the draft schedule to be updated.

Example

{
  "datetime_range": {
    "start_datetime": "1s",
    "end_datetime": "1s"
  },
  "name": "string",
  "description": "string",
  "delete_shifts_not_in_range": true,
  "copy_shifts_into_new_range": true,
  "get_updated_shifts": true,
  "draft_schedule_sid": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Response message for the UpdateDraftSchedule RPC.

draft_schedule

object (DraftSchedule)

draft_schedule

optional

The newly updated draft schedule.

created_at

string <date-time>

created_at

optional

Time that this the schedule was created.

Examples:

1s1.000340012s

last_updated_at

string <date-time>

last_updated_at

optional

Time that this schedule was last updated.

Examples:

1s1.000340012s

datetime_range

object (DatetimeRange)

datetime_range

optional

Datetime range over which this draft schedule spans.
Is the range used when copying shifts from published schedule.
Also used when publishing shifts from the draft to the published schedule.

name

string

name

optional

Name of the draft schedule.

description

string

description

optional

A description of the draft schedule.

created_by_user_id

string

created_by_user_id

optional

ID of the user who originally drafted the schedule.

shift_instances

array[object (ShiftInstance) {12}]

shift_instances

optional

The following field is only return of List requests of the entity.
Shifts that this schedule has.

performance_metrics

array[object (PerformanceMetric) {13}]

performance_metrics

deprecated

Deprecated. Performance metrics that this schedule has.

performance_metrics_v2

array[object (PerformanceMetricV2) {19}]

performance_metrics_v2

optional

Performance metrics that this schedule has.

draft_schedule_sid

integer <int64> | string

draft_schedule_sid

optional

ID of the draft schedule.

schedule_scenario_sid

integer <int64> | string

schedule_scenario_sid

optional

Schedule Scenario of the draft schedule.

Example

{
  "draft_schedule": {
    "created_at": "1s",
    "last_updated_at": "1s",
    "datetime_range": {
      "start_datetime": "1s",
      "end_datetime": "1s"
    },
    "name": "string",
    "description": "string",
    "created_by_user_id": "string",
    "shift_instances": [
      {
        "start_datetime": "1s",
        "schedule_type": "DRAFT",
        "shift_template": {
          "datetime_set_to_inactive": "1s",
          "name": "string",
          "description": "string",
          "is_tourshift": true,
          "min_shift_width": 0,
          "max_shift_width": 0,
          "min_agents": 0,
          "max_agents": 0,
          "shift_start_boundary_minutes": 0,
          "same_time_each_DOW": true,
          "same_length_per_agent": true,
          "member_placement_rules": [
            {
              "member_scheduling_activity": {
                "activity_sid": "string",
                "member_non_skill_activity": {
                  "datetime_set_to_inactive": "1s",
                  "inherited_from_entity": {
                    "parent_type": "CALL_CENTER_NODE",
                    "parent_sid": 0
                  },
                  "name": "string",
                  "description": "string",
                  "red": 0,
                  "green": 0,
                  "blue": 0,
                  "transparency": 0,
                  "non_skill_activity_sid": 0
                },
                "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
                "is_skill_activity": true,
                "reason_codes": [
                  {
                    "datetime_set_to_inactive": "1s",
                    "name": "string",
                    "is_planned": true,
                    "is_paid": true,
                    "is_default": true,
                    "reason_code_id": 0,
                    "scheduling_activity_sid": 0
                  }
                ],
                "scheduling_activity_sid": 0,
                "pause_codes": [
                  "string"
                ]
              },
              "activity_order": 0,
              "min_duration_minutes": 0,
              "max_duration_minutes": 0,
              "placement_rule_sid": 0,
              "shift_template_sid": 0,
              "scheduling_activity_sid": 0,
              "schedule_scenario_sid": 0
            }
          ],
          "DOW_placements": [
            {
              "placement_type": "MUST_NOT",
              "day_of_week": "MON",
              "start_minute": 0,
              "end_minute": 0,
              "week_number": 0
            }
          ],
          "member_agent_groups": [
            {
              "parent_entity": {
                "parent_type": "CALL_CENTER_NODE",
                "parent_sid": 0
              },
              "datetime_set_to_inactive": "1s",
              "name": "string",
              "description": "string",
              "member_constraint_rules": [
                {
                  "scheduling_activity": {
                    "activity_sid": "string",
                    "member_non_skill_activity": {
                      "datetime_set_to_inactive": "1s",
                      "inherited_from_entity": {
                        "parent_type": "CALL_CENTER_NODE",
                        "parent_sid": 0
                      },
                      "name": "string",
                      "description": "string",
                      "red": 0,
                      "green": 0,
                      "blue": 0,
                      "transparency": 0,
                      "non_skill_activity_sid": 0
                    },
                    "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
                    "is_skill_activity": true,
                    "reason_codes": [
                      {
                        "datetime_set_to_inactive": "1s",
                        "name": "string",
                        "is_planned": true,
                        "is_paid": true,
                        "is_default": true,
                        "reason_code_id": 0,
                        "scheduling_activity_sid": 0
                      }
                    ],
                    "scheduling_activity_sid": 0,
                    "pause_codes": [
                      "string"
                    ]
                  }
                }
              ],
              "member_wfm_agents": [
                {
                  "tcn_agent_sid": "string",
                  "datetime_set_to_inactive": "1s",
                  "created_at": "1s",
                  "name": "string",
                  "member_constraint_rules": [
                    {
                      "scheduling_activity": {
                        "activity_sid": "string",
                        "member_non_skill_activity": {
                          "datetime_set_to_inactive": "1s",
                          "inherited_from_entity": {
                            "parent_type": "CALL_CENTER_NODE",
                            "parent_sid": 0
                          },
                          "name": "string",
                          "description": "string",
                          "red": 0,
                          "green": 0,
                          "blue": 0,
                          "transparency": 0,
                          "non_skill_activity_sid": 0
                        },
                        "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
                        "is_skill_activity": true,
                        "reason_codes": [
                          {
                            "datetime_set_to_inactive": "1s",
                            "name": "string",
                            "is_planned": true,
                            "is_paid": true,
                            "is_default": true,
                            "reason_code_id": 0,
                            "scheduling_activity_sid": 0
                          }
                        ],
                        "scheduling_activity_sid": 0,
                        "pause_codes": [
                          "string"
                        ]
                      }
                    }
                  ],
                  "member_skill_proficiencies": [
                    {
                      "preferred_skill_profile_sid": "string",
                      "parent_entity": {
                        "parent_type": "CALL_CENTER_NODE",
                        "parent_sid": 0
                      },
                      "manual_proficiency_value": 0,
                      "skill_name": "string",
                      "skill_profile_name": "string",
                      "skill_profile_proficiency_value": 0,
                      "skill_proficiency_sid": 0,
                      "skill_sid": 0
                    }
                  ],
                  "member_agent_availability_patterns": [
                    {
                      "parent_entity": {
                        "parent_type": "CALL_CENTER_NODE",
                        "parent_sid": 0
                      },
                      "datetime_pattern": {
                        "week_maps": [
                          {
                            "datetime_range": {},
                            "day_maps": [
                              null
                            ]
                          }
                        ],
                        "calendar_items": [
                          {
                            "datetime_range": {},
                            "value": {}
                          }
                        ]
                      },
                      "scheduling_activity_sid": "string",
                      "agent_availability_pattern_sid": 0,
                      "schedule_scenario_sid": 0
                    }
                  ],
                  "tcn_agent_is_enabled": true,
                  "wfm_agent_sid": 0
                }
              ],
              "member_skill_proficiencies": [
                {
                  "preferred_skill_profile_sid": "string",
                  "parent_entity": {
                    "parent_type": "CALL_CENTER_NODE",
                    "parent_sid": 0
                  },
                  "manual_proficiency_value": 0,
                  "skill_name": "string",
                  "skill_profile_name": "string",
                  "skill_profile_proficiency_value": 0,
                  "skill_proficiency_sid": 0,
                  "skill_sid": 0
                }
              ],
              "member_agent_availability_patterns": [
                {
                  "parent_entity": {
                    "parent_type": "CALL_CENTER_NODE",
                    "parent_sid": 0
                  },
                  "datetime_pattern": {
                    "week_maps": [
                      {
                        "datetime_range": {
                          "start_datetime": "1s",
                          "end_datetime": "1s"
                        },
                        "day_maps": [
                          {
                            "day_of_week": "MON",
                            "value": {},
                            "start_minute_in_day": 0,
                            "end_minute_in_day": 0
                          }
                        ]
                      }
                    ],
                    "calendar_items": [
                      {
                        "datetime_range": {
                          "start_datetime": "1s",
                          "end_datetime": "1s"
                        },
                        "value": {
                          "availability_option": "AVAILABLE"
                        }
                      }
                    ]
                  },
                  "scheduling_activity_sid": "string",
                  "agent_availability_pattern_sid": 0,
                  "schedule_scenario_sid": 0
                }
              ],
              "agent_group_sid": 0,
              "schedule_scenario_sid": 0
            }
          ],
          "shift_template_sid": 0,
          "program_node_sid": 0,
          "schedule_scenario_sid": 0
        },
        "is_locked": true,
        "width_in_minutes": 0,
        "shift_segments": [
          {
            "scheduling_activity": {
              "activity_sid": "string",
              "member_non_skill_activity": {
                "datetime_set_to_inactive": "1s",
                "inherited_from_entity": {
                  "parent_type": "CALL_CENTER_NODE",
                  "parent_sid": 0
                },
                "name": "string",
                "description": "string",
                "red": 0,
                "green": 0,
                "blue": 0,
                "transparency": 0,
                "non_skill_activity_sid": 0
              },
              "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
              "is_skill_activity": true,
              "reason_codes": [
                {
                  "datetime_set_to_inactive": "1s",
                  "name": "string",
                  "is_planned": true,
                  "is_paid": true,
                  "is_default": true,
                  "reason_code_id": 0,
                  "scheduling_activity_sid": 0
                }
              ],
              "scheduling_activity_sid": 0,
              "pause_codes": [
                "string"
              ]
            },
            "order_in_shift_instance": 0,
            "width_in_minutes": 0,
            "start_minute_in_shift": 0,
            "call_stats_by_skill_collection": [
              {
                "skill_collection": {
                  "skill_profile_category_type": "SINGLE_SKILL_PROFILE",
                  "skill_profile_category_sid": 0
                },
                "num_calls": 0,
                "percent_fit": 0
              }
            ],
            "shift_segment_sid": 0,
            "shift_instance_sid": 0,
            "scheduling_activity_sid": 0,
            "reason_code_id": 0
          }
        ],
        "planned_shrinkage_percent": 0,
        "shift_instance_sid": 0,
        "shift_template_sid": 0,
        "originating_program_node_sid": 0,
        "schedule_sid": 0,
        "wfm_agent_sid": 0
      }
    ],
    "performance_metrics": [
      {
        "date_range": {
          "start_datetime": "1s",
          "end_datetime": "1s"
        },
        "metric_type": "FTE_REQUIRED_VS_ACHIEVED_SIMPLE",
        "total_calls_required": 0,
        "total_ftes_achieved": 0,
        "num_intervals_with_required_calls": 0,
        "num_intervals_with_ftes_but_no_schedules": 0,
        "num_intervals_with_ftes_but_no_forecasted_calls": 0,
        "total_unscheduled_calls": 0,
        "total_unnecessary_ftes": 0,
        "interval_width_in_minutes": 0,
        "fte_intervals": [
          {
            "start_datetime": "1s",
            "required_calls": 0,
            "achieved_ftes": 0
          }
        ],
        "service_level_intervals": [
          {
            "start_datetime": "1s",
            "service_level_achieved": 0
          }
        ],
        "metrics_by_skill_collection": [
          {
            "date_range": {
              "start_datetime": "1s",
              "end_datetime": "1s"
            },
            "metric_type": "FTE_REQUIRED_VS_ACHIEVED_SIMPLE",
            "skill_collection": {
              "skill_profile_category_type": "SINGLE_SKILL_PROFILE",
              "skill_profile_category_sid": 0
            },
            "total_calls_required": 0,
            "total_ftes_achieved": 0,
            "num_intervals_with_required_calls": 0,
            "num_intervals_with_ftes_but_no_schedules": 0,
            "num_intervals_with_ftes_but_no_forecasted_calls": 0,
            "total_unscheduled_calls": 0,
            "total_unnecessary_ftes": 0,
            "interval_width_in_minutes": 0,
            "fte_intervals": [
              {
                "start_datetime": "1s",
                "required_calls": 0,
                "achieved_ftes": 0
              }
            ],
            "service_level_intervals": [
              {
                "start_datetime": "1s",
                "service_level_achieved": 0
              }
            ]
          }
        ]
      }
    ],
    "performance_metrics_v2": [
      {
        "date_range": {
          "start_datetime": "1s",
          "end_datetime": "1s"
        },
        "metric_type": "FTE_REQUIRED_VS_ACHIEVED_SIMPLE",
        "total_fte_intervals_required": 0,
        "total_fte_intervals_achieved": 0,
        "num_intervals_with_call_ftes": 0,
        "num_intervals_with_shift_ftes": 0,
        "num_intervals_with_call_ftes_but_no_shifts": 0,
        "num_intervals_with_shifts_but_no_call_ftes": 0,
        "total_underscheduled_call_ftes": 0,
        "total_overscheduled_call_ftes": 0,
        "interval_width_in_minutes": 0,
        "fte_occupancy_intervals": [
          {
            "start_datetime": "1s",
            "required_fte_occupancy": 0,
            "achieved_fte_occupancy": 0,
            "required_fte": 0,
            "achieved_fte": 0,
            "productive_fte": 0,
            "achieved_fte_with_shrinkage_applied": 0,
            "productive_fte_with_shrinkage_applied": 0
          }
        ],
        "service_level_intervals": [
          {
            "start_datetime": "1s",
            "service_level_achieved": 0
          }
        ],
        "metrics_by_skill_collection": [
          {
            "date_range": {
              "start_datetime": "1s",
              "end_datetime": "1s"
            },
            "metric_type": "FTE_REQUIRED_VS_ACHIEVED_SIMPLE",
            "skill_collection": {
              "skill_profile_category_type": "SINGLE_SKILL_PROFILE",
              "skill_profile_category_sid": 0
            },
            "total_fte_intervals_required": 0,
            "total_fte_intervals_achieved": 0,
            "num_intervals_with_call_ftes": 0,
            "num_intervals_with_shift_ftes": 0,
            "num_intervals_with_call_ftes_but_no_shifts": 0,
            "num_intervals_with_shifts_but_no_call_ftes": 0,
            "total_underscheduled_call_ftes": 0,
            "total_overscheduled_call_ftes": 0,
            "interval_width_in_minutes": 0,
            "fte_occupancy_intervals": [
              {
                "start_datetime": "1s",
                "required_fte_occupancy": 0,
                "achieved_fte_occupancy": 0,
                "required_fte": 0,
                "achieved_fte": 0,
                "productive_fte": 0,
                "achieved_fte_with_shrinkage_applied": 0,
                "productive_fte_with_shrinkage_applied": 0
              }
            ],
            "service_level_intervals": [
              {
                "start_datetime": "1s",
                "service_level_achieved": 0
              }
            ],
            "total_required_fte": 0,
            "total_achieved_fte": 0,
            "total_productive_fte": 0,
            "total_achieved_fte_with_shrinkage_applied": 0,
            "total_productive_fte_with_shrinkage_applied": 0
          }
        ],
        "total_required_fte": 0,
        "total_achieved_fte": 0,
        "total_productive_fte": 0,
        "total_achieved_fte_with_shrinkage_applied": 0,
        "total_productive_fte_with_shrinkage_applied": 0
      }
    ],
    "draft_schedule_sid": 0,
    "schedule_scenario_sid": 0
  }
}

🔴500Server Error