v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB

Schedule overrides

Get override

Returns the details of the override of a schedule with given IDs in the request. <br> <br> Permissions required: Permission to access to the schedule:

the user has read-only administrative right.
the schedule's assigned team is one of the teams that the user belongs to.
the user is added to a rotation of the schedule as a responder.
a team is added to a rotation of the schedule as a responder, and the user is a member of this team.
an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation.
there is an override to the user in the schedule.

get/api/{cloudId}/v1/schedules/{scheduleId}/overrides/{alias}

Path parameters

scheduleIdstring required

ID of the schedule.

aliasstring required

Alias of the override.

Response

Returned if the request is successful.

aliasstring

Alias of the override.

startDatestring date-time

Start time of the override.

endDatestring date-time

End time of the override.

rotationIdsstring[]

IDs of the rotations that override applies to. Null if no rotation is specified during override creation.

Example response

{
  "alias": "c73c3ffa-dcc3-4f28-ad13-d150ec108fc9",
  "responder": {
    "type": "user",
    "id": "1626a3a7-e159-45e0-b067-b99210917b16"
  },
  "startDate": "2023-11-27T05:00:00Z",
  "endDate": "2023-11-28T10:00:00Z",
  "rotationIds": [
    "dec43451-becf-4d2b-99c6-2f98ff2c1eb3",
    "0c829882-7de3-431e-8b64-8edcca7606d8"
  ]
}