Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Schedule overrides

List overrides

Lists all ongoing and future overrides of the schedule with given id in the request. It optionally takes two parameters - offset and size.<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

Path parameters

scheduleIdstring required

ID of the schedule.

Query parameters

sizeinteger

The limit parameter controls the maximum number of items that may be returned for a single request.

offsetinteger

The offset parameter controls the starting point within the collection of resource results.

Response

Returned if the request is successful.

Example response

{
  "values": [
    {
      "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"
      ]
    }
  ],
  "links": {
    "next": "/v1/schedules/f8f2a4ec-54b2-4513-865b-8cb3b81c9544/overrides?offset=50&size=25"
  }
}