Skip to main content

on_call_user_schedule

Creates, updates, deletes, gets or lists an on_call_user_schedule resource.

Overview

Nameon_call_user_schedule
TypeResource
Iddatadog.service_management.on_call_user_schedule

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringThe ShiftData id.
attributesobjectAttributes for an on-call shift.
relationshipsobjectRelationships for an on-call shift.
typestringIndicates that the resource is of type 'shifts'. (default: shifts, example: shifts)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_schedule_on_call_userselectschedule_id, regioninclude, filter[at_ts]Retrieves the user who is on-call for the specified schedule at a given time.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstring(default: datadoghq.com)
schedule_idstringThe ID of the schedule.
filter[at_ts]stringRetrieves the on-call user at the given timestamp (ISO-8601). Defaults to the current time if omitted."
includestringSpecifies related resources to include in the response as a comma-separated list. Allowed value: user.

SELECT examples

Retrieves the user who is on-call for the specified schedule at a given time.

SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.on_call_user_schedule
WHERE schedule_id = '{{ schedule_id }}' -- required
AND region = '{{ region }}' -- required
AND include = '{{ include }}'
AND filter[at_ts] = '{{ filter[at_ts] }}'
;