Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Schedule overrides

Create override

Creates a new override for the schedule with given id and properties.<br> <br> Permissions required: Permission to create an override:

  • the user has edit configuration right.
  • the user is a member of the team that the schedule belongs to.
  • the user is adding override to themself.
  • the user exists in the schedule directly or indirectly.
post/api/{cloudId}/v1/schedules/{scheduleId}/overrides

Path parameters

scheduleIdstring required

ID of the schedule.

Request body

startDatestring date-time required

Start time of the override.

endDatestring date-time required

End time of the override.

rotationIdsstring[]

IDs of the rotations that this override is applied to. Should be null to apply override to all rotations.

Example request

{
  "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"
  ]
}

Response

Returned if the override is created successfully.

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"
  ]
}