Overflow parameter when updating a schedule

Hi, I’m trying to figure out how overflow parameter works. Currently I see no effect when using overflow=true/false.

Can someone please to share an example of a proper usage?

Here is an example of a response I receive when updating a schedule.
You can see that start/end dates are similar for both overflow=true and overflow=false.

I tried to use an example from this page, but it didn’t help:
https://developer.pagerduty.com/api-reference/reference/REST/openapiv3.json/paths/~1schedules~1{id}/put

“final_schedule”: {
“name”: “Final Schedule”,
“rendered_schedule_entries”: [
{
“start”: “2022-03-02T10:00:00Z”,
“end”: “2022-03-02T17:00:00Z”,
“user”: {
“id”: “”,
“type”: “user_reference”,
“summary”: “5fqPre”,
“self”: “https://api.pagerduty.com/users/”,
“html_url”: “https://oktatest.pagerduty.com/users/
},
“id”: null
}

“rendered_schedule_entries”: [
{
“start”: “2022-03-02T10:00:00Z”,
“end”: “2022-03-02T17:00:00Z”,
“user”: {
“id”: “”,
“type”: “user_reference”,
“summary”: “5fqPre”,
“self”: “https://api.pagerduty.com/users/”,
“html_url”: “https://oktatest.pagerduty.com/users/
},
“id”: null
}

The schedule layer details.

“schedule_layers”: [
{
“name”: “Schedule Layer 2”,
“rendered_schedule_entries”: [],
“rendered_coverage_percentage”: null,
“id”: “”,
“start”: “2022-03-02T10:00:00Z”,
“end”: “2023-04-02T14:00:00Z”,
“rotation_virtual_start”: “2022-03-02T10:00:00Z”,
“rotation_turn_length_seconds”: 43200,
“users”: [
{
“user”: {
“id”: “”,
“type”: “user_reference”,
“summary”: “5fqPre”,
“self”: “https://api.pagerduty.com/users/”,
“html_url”: “https://oktatest.pagerduty.com/users/
}
}
],
“restrictions”: [
{
“type”: “daily_restriction”,
“start_time_of_day”: “10:00:00”,
“duration_seconds”: 25200
}
]
}
],

Hi Anatolii,

Thanks for reaching out to us about this.

With the overflow parameter, this returns details on the entire shift for the person oncall during the slice of time requested. You can omit this parameter if you don’t care to know details on the entire oncall shift. If you do want to see the entire shift that may go over that slice of time, you can use the overflow parameter to extend the time requested.

For example, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from 2011-06-01T10:00:00Z to 2011-06-01T14:00:00Z:

If you omit overflow=true parameter, you will get one schedule entry returned with a start of:
2011-06-01T10:00:00Z to 2011-06-01T14:00:00Z.

If you do include the overflow=true parameter, you will get one schedule entry returned with a start of :
2011-06-01T00:00:00Z and end of 2011-06-02T00:00:00Z.

Hope this helps clarify things a little further and please reach out to support@pagerduty.com to go through a specific example from your instance.

1 Like