Skip to main content

overrides

Overview

Nameoverrides
TypeResource
Idpagerduty.schedules.overrides

Fields

NameDatatypeDescription
idstring
_idstring
endstringThe end date and time for the override.
html_urlstringa URL at which the entity is uniquely displayed in the Web app
selfstringthe API show URL at which the object is accessible
startstringThe start date and time for the override.
summarystringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier.
typestringA string that determines the schema of the object. This must be the standard name for the entity, suffixed by _reference if the object is a reference.
userobject

Methods

NameAccessible byRequired ParamsDescription
list_schedule_overridesSELECTid, since, untilList overrides for a given time range.

A Schedule determines the time periods that users are On-Call.

For more information see the API Concepts Document

Scoped OAuth requires: schedules.read
create_schedule_overrideINSERTidCreate one or more overrides, each for a specific user covering a specified time range. If you create an override on top of an existing override, the last created override will have priority.

A Schedule determines the time periods that users are On-Call.

Note: An older implementation of this endpoint only supported creating a single ocverride per request. That functionality is still supported, but deprecated and may be removed in the future.

For more information see the API Concepts Document

Scoped OAuth requires: schedules.write
delete_schedule_overrideDELETEid, override_idRemove an override.

You cannot remove a past override.

If the override start time is before the current time, but the end time is after the current time, the override will be truncated to the current time.

If the override is truncated, the status code will be 200 OK, as opposed to a 204 No Content for a successful delete.

A Schedule determines the time periods that users are On-Call.

For more information see the API Concepts Document

Scoped OAuth requires: schedules.write
_list_schedule_overridesEXECid, since, untilList overrides for a given time range.

A Schedule determines the time periods that users are On-Call.

For more information see the API Concepts Document

Scoped OAuth requires: schedules.read