diff --git a/content/en/api/v2/on-call/examples.json b/content/en/api/v2/on-call/examples.json index 3bee55c24e1..2630a391431 100644 --- a/content/en/api/v2/on-call/examples.json +++ b/content/en/api/v2/on-call/examples.json @@ -58,6 +58,10 @@ "id": "00000000-aba2-0000-0000-000000000000", "type": "schedules" }, + { + "id": "00000000-aba2-0000-0000-000000000000_previous", + "type": "schedule_target" + }, { "id": "00000000-aba3-0000-0000-000000000000", "type": "teams" @@ -75,13 +79,28 @@ "id": "00000000-aba2-0000-0000-000000000000", "type": "schedules" }, + { + "attributes": { + "position": "previous" + }, + "id": "00000000-aba2-0000-0000-000000000000_previous", + "relationships": { + "schedule": { + "data": { + "id": "00000000-aba2-0000-0000-000000000000", + "type": "schedules" + } + } + }, + "type": "schedule_target" + }, { "id": "00000000-aba3-0000-0000-000000000000", "type": "teams" } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Represents the data for a single escalation policy, including its attributes, ID, relationships, and resource type.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Defines the main attributes of an escalation policy, such as its name and behavior on policy end.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Specifies the name of the escalation policy.

\n
\n \n
\n
\n
\n
\n
\n

resolve_page_on_policy_end

\n
\n

boolean

\n

Indicates whether the page is automatically resolved when the policy ends.

\n
\n \n
\n
\n
\n
\n
\n

retries

\n
\n

int64

\n

Specifies how many times the escalation sequence is retried if there is no response.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Specifies the unique identifier of the escalation policy.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Represents the relationships for an escalation policy, including references to steps and teams.

\n
\n
\n
\n
\n
\n

steps [required]

\n
\n

object

\n

Defines the relationship to a collection of steps within an escalation policy. Contains an array of step data references.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of references to the steps defined in this escalation policy.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier for the step resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type steps. \nAllowed enum values: steps

default: steps

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

teams

\n
\n

object

\n

Associates teams with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of team references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type policies. \nAllowed enum values: policies

default: policies

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Provides any included related resources, such as steps or targets, returned with the policy.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Provides a reference to a team, including ID, type, and basic attributes/relationships.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

URL or reference for the team's avatar (if available).

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A short text describing the team.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

A unique handle/slug for the team.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full, human-readable name of the team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The team's unique identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Represents a single step in an escalation policy, including its attributes, relationships, and resource type.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Defines attributes for an escalation policy step, such as assignment strategy and escalation timeout.

\n
\n
\n
\n
\n
\n

assignment

\n
\n

enum

\n

Specifies how this escalation step will assign targets (example default or round-robin). \nAllowed enum values: default,round-robin

\n
\n \n
\n
\n
\n
\n
\n

escalate_after_seconds

\n
\n

int64

\n

Specifies how many seconds to wait before escalating to the next step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Specifies the unique identifier of this escalation policy step.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Represents the relationship of an escalation policy step to its targets.

\n
\n
\n
\n
\n
\n

targets

\n
\n

object

\n

A list of escalation targets for a step

\n
\n
\n
\n
\n
\n

data

\n
\n

[ <oneOf>]

\n

The EscalationTargets data.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Represents a team target for an escalation policy step, including the team's ID and resource type.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the team resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type teams. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Represents a user target for an escalation policy step, including the user's ID and resource type.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the user resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type users. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Represents a schedule target for an escalation policy step, including its ID and resource type.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the schedule resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type schedules. \nAllowed enum values: schedules

default: schedules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type steps. \nAllowed enum values: steps

default: steps

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Represents a user object in the context of an escalation policy, including their id, type, and basic attributes.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Provides basic user information for an escalation policy, including a name and email address.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The user's email address.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The user's name.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The user's status. \nAllowed enum values: active,deactivated,pending

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique user identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Represents the primary data object for a schedule, linking attributes and relationships.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Provides core properties of a schedule object such as its name and time zone.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

A short name for the schedule.

\n
\n \n
\n
\n
\n
\n
\n

time_zone

\n
\n

string

\n

The time zone in which this schedule operates.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The schedule's unique identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Groups the relationships for a schedule object, referencing layers and teams.

\n
\n
\n
\n
\n
\n

layers

\n
\n

object

\n

Associates layers with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of layer references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the layer in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Layers resource type. \nAllowed enum values: layers

default: layers

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

teams

\n
\n

object

\n

Associates teams with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of team references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Schedules resource type. \nAllowed enum values: schedules

default: schedules

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Represents the data for a single escalation policy, including its attributes, ID, relationships, and resource type.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Defines the main attributes of an escalation policy, such as its name and behavior on policy end.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Specifies the name of the escalation policy.

\n
\n \n
\n
\n
\n
\n
\n

resolve_page_on_policy_end

\n
\n

boolean

\n

Indicates whether the page is automatically resolved when the policy ends.

\n
\n \n
\n
\n
\n
\n
\n

retries

\n
\n

int64

\n

Specifies how many times the escalation sequence is retried if there is no response.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Specifies the unique identifier of the escalation policy.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Represents the relationships for an escalation policy, including references to steps and teams.

\n
\n
\n
\n
\n
\n

steps [required]

\n
\n

object

\n

Defines the relationship to a collection of steps within an escalation policy. Contains an array of step data references.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of references to the steps defined in this escalation policy.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier for the step resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type steps. \nAllowed enum values: steps

default: steps

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

teams

\n
\n

object

\n

Associates teams with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of team references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type policies. \nAllowed enum values: policies

default: policies

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Provides any included related resources, such as steps or targets, returned with the policy.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Represents a single step in an escalation policy, including its attributes, relationships, and resource type.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Defines attributes for an escalation policy step, such as assignment strategy and escalation timeout.

\n
\n
\n
\n
\n
\n

assignment

\n
\n

enum

\n

Specifies how this escalation step will assign targets (example default or round-robin). \nAllowed enum values: default,round-robin

\n
\n \n
\n
\n
\n
\n
\n

escalate_after_seconds

\n
\n

int64

\n

Specifies how many seconds to wait before escalating to the next step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Specifies the unique identifier of this escalation policy step.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Represents the relationship of an escalation policy step to its targets.

\n
\n
\n
\n
\n
\n

targets

\n
\n

object

\n

A list of escalation targets for a step

\n
\n
\n
\n
\n
\n

data

\n
\n

[ <oneOf>]

\n

The EscalationTargets data.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Represents a team target for an escalation policy step, including the team's ID and resource type.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the team resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type teams. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Represents a user target for an escalation policy step, including the user's ID and resource type.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the user resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type users. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the schedule resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type schedules. \nAllowed enum values: schedules

default: schedules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Relationship reference to a configured schedule target.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the configured schedule target.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type schedule_target. \nAllowed enum values: schedule_target

default: schedule_target

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type steps. \nAllowed enum values: steps

default: steps

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Represents a user object in the context of an escalation policy, including their id, type, and basic attributes.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Provides basic user information for an escalation policy, including a name and email address.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The user's email address.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The user's name.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The user's status. \nAllowed enum values: active,deactivated,pending

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique user identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Represents the primary data object for a schedule, linking attributes and relationships.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Provides core properties of a schedule object such as its name and time zone.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

A short name for the schedule.

\n
\n \n
\n
\n
\n
\n
\n

time_zone

\n
\n

string

\n

The time zone in which this schedule operates.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The schedule's unique identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Groups the relationships for a schedule object, referencing layers and teams.

\n
\n
\n
\n
\n
\n

layers

\n
\n

object

\n

Associates layers with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of layer references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the layer in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Layers resource type. \nAllowed enum values: layers

default: layers

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

teams

\n
\n

object

\n

Associates teams with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of team references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Schedules resource type. \nAllowed enum values: schedules

default: schedules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Full resource representation of a configured schedule target with position (previous, current, or next).

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for a configured schedule target, including position.

\n
\n
\n
\n
\n
\n

position [required]

\n
\n

enum

\n

Specifies the position of a schedule target (example previous, current, or next). \nAllowed enum values: previous,current,next

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the configured schedule target.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Represents the relationships of a configured schedule target.

\n
\n
\n
\n
\n
\n

schedule [required]

\n
\n

object

\n

Holds the schedule reference for a configured schedule target.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the schedule resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type schedules. \nAllowed enum values: schedules

default: schedules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type schedule_target. \nAllowed enum values: schedule_target

default: schedule_target

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Provides a reference to a team, including ID, type, and basic attributes/relationships.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

URL or reference for the team's avatar (if available).

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A short text describing the team.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

A unique handle/slug for the team.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full, human-readable name of the team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The team's unique identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -154,6 +173,11 @@ "escalate_after_seconds": 3600, "targets": [ { + "config": { + "schedule": { + "position": "previous" + } + }, "id": "00000000-aba1-0000-0000-000000000000", "type": "users" } @@ -174,7 +198,7 @@ "type": "policies" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Represents the data for creating an escalation policy, including its attributes, relationships, and resource type.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Defines the attributes for creating an escalation policy, including its description, name, resolution behavior, retries, and steps.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Specifies the name for the new escalation policy.

\n
\n \n
\n
\n
\n
\n
\n

resolve_page_on_policy_end

\n
\n

boolean

\n

Indicates whether the page is automatically resolved when the policy ends.

\n
\n \n
\n
\n
\n
\n
\n

retries

\n
\n

int64

\n

Specifies how many times the escalation sequence is retried if there is no response.

\n
\n \n
\n
\n
\n
\n
\n

steps [required]

\n
\n

[object]

\n

A list of escalation steps, each defining assignment, escalation timeout, and targets for the new policy.

\n
\n
\n
\n
\n
\n

assignment

\n
\n

enum

\n

Specifies how this escalation step will assign targets (example default or round-robin). \nAllowed enum values: default,round-robin

\n
\n \n
\n
\n
\n
\n
\n

escalate_after_seconds

\n
\n

int64

\n

Defines how many seconds to wait before escalating to the next step.

\n
\n \n
\n
\n
\n
\n
\n

targets [required]

\n
\n

[object]

\n

Specifies the collection of escalation targets for this step.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Specifies the unique identifier for this target.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Specifies the type of escalation target (example users, schedules, or teams). \nAllowed enum values: users,schedules,teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Represents relationships in an escalation policy creation request, including references to teams.

\n
\n
\n
\n
\n
\n

teams

\n
\n

object

\n

Associates teams with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of team references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type policies. \nAllowed enum values: policies

default: policies

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Represents the data for creating an escalation policy, including its attributes, relationships, and resource type.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Defines the attributes for creating an escalation policy, including its description, name, resolution behavior, retries, and steps.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Specifies the name for the new escalation policy.

\n
\n \n
\n
\n
\n
\n
\n

resolve_page_on_policy_end

\n
\n

boolean

\n

Indicates whether the page is automatically resolved when the policy ends.

\n
\n \n
\n
\n
\n
\n
\n

retries

\n
\n

int64

\n

Specifies how many times the escalation sequence is retried if there is no response.

\n
\n \n
\n
\n
\n
\n
\n

steps [required]

\n
\n

[object]

\n

A list of escalation steps, each defining assignment, escalation timeout, and targets for the new policy.

\n
\n
\n
\n
\n
\n

assignment

\n
\n

enum

\n

Specifies how this escalation step will assign targets (example default or round-robin). \nAllowed enum values: default,round-robin

\n
\n \n
\n
\n
\n
\n
\n

escalate_after_seconds

\n
\n

int64

\n

Defines how many seconds to wait before escalating to the next step.

\n
\n \n
\n
\n
\n
\n
\n

targets [required]

\n
\n

[object]

\n

Specifies the collection of escalation targets for this step.

\n
\n
\n
\n
\n
\n

config

\n
\n

object

\n

Configuration for an escalation target, such as schedule position.

\n
\n
\n
\n
\n
\n

schedule

\n
\n

object

\n

Schedule-specific configuration for an escalation target.

\n
\n
\n
\n
\n
\n

position

\n
\n

enum

\n

Specifies the position of a schedule target (example previous, current, or next). \nAllowed enum values: previous,current,next

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Specifies the unique identifier for this target.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Specifies the type of escalation target (example users, schedules, or teams). \nAllowed enum values: users,schedules,teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Represents relationships in an escalation policy creation request, including references to teams.

\n
\n
\n
\n
\n
\n

teams

\n
\n

object

\n

Associates teams with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of team references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type policies. \nAllowed enum values: policies

default: policies

\n
\n \n
\n
\n
\n
" } }, "DeleteOnCallEscalationPolicy": { @@ -277,6 +301,10 @@ "id": "00000000-aba2-0000-0000-000000000000", "type": "schedules" }, + { + "id": "00000000-aba2-0000-0000-000000000000_previous", + "type": "schedule_target" + }, { "id": "00000000-aba3-0000-0000-000000000000", "type": "teams" @@ -294,13 +322,28 @@ "id": "00000000-aba2-0000-0000-000000000000", "type": "schedules" }, + { + "attributes": { + "position": "previous" + }, + "id": "00000000-aba2-0000-0000-000000000000_previous", + "relationships": { + "schedule": { + "data": { + "id": "00000000-aba2-0000-0000-000000000000", + "type": "schedules" + } + } + }, + "type": "schedule_target" + }, { "id": "00000000-aba3-0000-0000-000000000000", "type": "teams" } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Represents the data for a single escalation policy, including its attributes, ID, relationships, and resource type.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Defines the main attributes of an escalation policy, such as its name and behavior on policy end.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Specifies the name of the escalation policy.

\n
\n \n
\n
\n
\n
\n
\n

resolve_page_on_policy_end

\n
\n

boolean

\n

Indicates whether the page is automatically resolved when the policy ends.

\n
\n \n
\n
\n
\n
\n
\n

retries

\n
\n

int64

\n

Specifies how many times the escalation sequence is retried if there is no response.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Specifies the unique identifier of the escalation policy.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Represents the relationships for an escalation policy, including references to steps and teams.

\n
\n
\n
\n
\n
\n

steps [required]

\n
\n

object

\n

Defines the relationship to a collection of steps within an escalation policy. Contains an array of step data references.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of references to the steps defined in this escalation policy.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier for the step resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type steps. \nAllowed enum values: steps

default: steps

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

teams

\n
\n

object

\n

Associates teams with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of team references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type policies. \nAllowed enum values: policies

default: policies

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Provides any included related resources, such as steps or targets, returned with the policy.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Provides a reference to a team, including ID, type, and basic attributes/relationships.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

URL or reference for the team's avatar (if available).

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A short text describing the team.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

A unique handle/slug for the team.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full, human-readable name of the team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The team's unique identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Represents a single step in an escalation policy, including its attributes, relationships, and resource type.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Defines attributes for an escalation policy step, such as assignment strategy and escalation timeout.

\n
\n
\n
\n
\n
\n

assignment

\n
\n

enum

\n

Specifies how this escalation step will assign targets (example default or round-robin). \nAllowed enum values: default,round-robin

\n
\n \n
\n
\n
\n
\n
\n

escalate_after_seconds

\n
\n

int64

\n

Specifies how many seconds to wait before escalating to the next step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Specifies the unique identifier of this escalation policy step.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Represents the relationship of an escalation policy step to its targets.

\n
\n
\n
\n
\n
\n

targets

\n
\n

object

\n

A list of escalation targets for a step

\n
\n
\n
\n
\n
\n

data

\n
\n

[ <oneOf>]

\n

The EscalationTargets data.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Represents a team target for an escalation policy step, including the team's ID and resource type.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the team resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type teams. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Represents a user target for an escalation policy step, including the user's ID and resource type.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the user resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type users. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Represents a schedule target for an escalation policy step, including its ID and resource type.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the schedule resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type schedules. \nAllowed enum values: schedules

default: schedules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type steps. \nAllowed enum values: steps

default: steps

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Represents a user object in the context of an escalation policy, including their id, type, and basic attributes.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Provides basic user information for an escalation policy, including a name and email address.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The user's email address.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The user's name.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The user's status. \nAllowed enum values: active,deactivated,pending

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique user identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Represents the primary data object for a schedule, linking attributes and relationships.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Provides core properties of a schedule object such as its name and time zone.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

A short name for the schedule.

\n
\n \n
\n
\n
\n
\n
\n

time_zone

\n
\n

string

\n

The time zone in which this schedule operates.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The schedule's unique identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Groups the relationships for a schedule object, referencing layers and teams.

\n
\n
\n
\n
\n
\n

layers

\n
\n

object

\n

Associates layers with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of layer references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the layer in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Layers resource type. \nAllowed enum values: layers

default: layers

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

teams

\n
\n

object

\n

Associates teams with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of team references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Schedules resource type. \nAllowed enum values: schedules

default: schedules

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Represents the data for a single escalation policy, including its attributes, ID, relationships, and resource type.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Defines the main attributes of an escalation policy, such as its name and behavior on policy end.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Specifies the name of the escalation policy.

\n
\n \n
\n
\n
\n
\n
\n

resolve_page_on_policy_end

\n
\n

boolean

\n

Indicates whether the page is automatically resolved when the policy ends.

\n
\n \n
\n
\n
\n
\n
\n

retries

\n
\n

int64

\n

Specifies how many times the escalation sequence is retried if there is no response.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Specifies the unique identifier of the escalation policy.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Represents the relationships for an escalation policy, including references to steps and teams.

\n
\n
\n
\n
\n
\n

steps [required]

\n
\n

object

\n

Defines the relationship to a collection of steps within an escalation policy. Contains an array of step data references.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of references to the steps defined in this escalation policy.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier for the step resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type steps. \nAllowed enum values: steps

default: steps

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

teams

\n
\n

object

\n

Associates teams with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of team references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type policies. \nAllowed enum values: policies

default: policies

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Provides any included related resources, such as steps or targets, returned with the policy.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Represents a single step in an escalation policy, including its attributes, relationships, and resource type.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Defines attributes for an escalation policy step, such as assignment strategy and escalation timeout.

\n
\n
\n
\n
\n
\n

assignment

\n
\n

enum

\n

Specifies how this escalation step will assign targets (example default or round-robin). \nAllowed enum values: default,round-robin

\n
\n \n
\n
\n
\n
\n
\n

escalate_after_seconds

\n
\n

int64

\n

Specifies how many seconds to wait before escalating to the next step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Specifies the unique identifier of this escalation policy step.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Represents the relationship of an escalation policy step to its targets.

\n
\n
\n
\n
\n
\n

targets

\n
\n

object

\n

A list of escalation targets for a step

\n
\n
\n
\n
\n
\n

data

\n
\n

[ <oneOf>]

\n

The EscalationTargets data.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Represents a team target for an escalation policy step, including the team's ID and resource type.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the team resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type teams. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Represents a user target for an escalation policy step, including the user's ID and resource type.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the user resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type users. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the schedule resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type schedules. \nAllowed enum values: schedules

default: schedules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Relationship reference to a configured schedule target.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the configured schedule target.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type schedule_target. \nAllowed enum values: schedule_target

default: schedule_target

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type steps. \nAllowed enum values: steps

default: steps

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Represents a user object in the context of an escalation policy, including their id, type, and basic attributes.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Provides basic user information for an escalation policy, including a name and email address.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The user's email address.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The user's name.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The user's status. \nAllowed enum values: active,deactivated,pending

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique user identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Represents the primary data object for a schedule, linking attributes and relationships.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Provides core properties of a schedule object such as its name and time zone.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

A short name for the schedule.

\n
\n \n
\n
\n
\n
\n
\n

time_zone

\n
\n

string

\n

The time zone in which this schedule operates.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The schedule's unique identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Groups the relationships for a schedule object, referencing layers and teams.

\n
\n
\n
\n
\n
\n

layers

\n
\n

object

\n

Associates layers with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of layer references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the layer in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Layers resource type. \nAllowed enum values: layers

default: layers

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

teams

\n
\n

object

\n

Associates teams with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of team references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Schedules resource type. \nAllowed enum values: schedules

default: schedules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Full resource representation of a configured schedule target with position (previous, current, or next).

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for a configured schedule target, including position.

\n
\n
\n
\n
\n
\n

position [required]

\n
\n

enum

\n

Specifies the position of a schedule target (example previous, current, or next). \nAllowed enum values: previous,current,next

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the configured schedule target.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Represents the relationships of a configured schedule target.

\n
\n
\n
\n
\n
\n

schedule [required]

\n
\n

object

\n

Holds the schedule reference for a configured schedule target.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the schedule resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type schedules. \nAllowed enum values: schedules

default: schedules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type schedule_target. \nAllowed enum values: schedule_target

default: schedule_target

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Provides a reference to a team, including ID, type, and basic attributes/relationships.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

URL or reference for the team's avatar (if available).

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A short text describing the team.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

A unique handle/slug for the team.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full, human-readable name of the team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The team's unique identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -408,6 +451,10 @@ "id": "00000000-aba2-0000-0000-000000000000", "type": "schedules" }, + { + "id": "00000000-aba2-0000-0000-000000000000_previous", + "type": "schedule_target" + }, { "id": "00000000-aba3-0000-0000-000000000000", "type": "teams" @@ -425,13 +472,28 @@ "id": "00000000-aba2-0000-0000-000000000000", "type": "schedules" }, + { + "attributes": { + "position": "previous" + }, + "id": "00000000-aba2-0000-0000-000000000000_previous", + "relationships": { + "schedule": { + "data": { + "id": "00000000-aba2-0000-0000-000000000000", + "type": "schedules" + } + } + }, + "type": "schedule_target" + }, { "id": "00000000-aba3-0000-0000-000000000000", "type": "teams" } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Represents the data for a single escalation policy, including its attributes, ID, relationships, and resource type.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Defines the main attributes of an escalation policy, such as its name and behavior on policy end.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Specifies the name of the escalation policy.

\n
\n \n
\n
\n
\n
\n
\n

resolve_page_on_policy_end

\n
\n

boolean

\n

Indicates whether the page is automatically resolved when the policy ends.

\n
\n \n
\n
\n
\n
\n
\n

retries

\n
\n

int64

\n

Specifies how many times the escalation sequence is retried if there is no response.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Specifies the unique identifier of the escalation policy.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Represents the relationships for an escalation policy, including references to steps and teams.

\n
\n
\n
\n
\n
\n

steps [required]

\n
\n

object

\n

Defines the relationship to a collection of steps within an escalation policy. Contains an array of step data references.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of references to the steps defined in this escalation policy.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier for the step resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type steps. \nAllowed enum values: steps

default: steps

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

teams

\n
\n

object

\n

Associates teams with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of team references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type policies. \nAllowed enum values: policies

default: policies

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Provides any included related resources, such as steps or targets, returned with the policy.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Provides a reference to a team, including ID, type, and basic attributes/relationships.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

URL or reference for the team's avatar (if available).

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A short text describing the team.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

A unique handle/slug for the team.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full, human-readable name of the team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The team's unique identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Represents a single step in an escalation policy, including its attributes, relationships, and resource type.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Defines attributes for an escalation policy step, such as assignment strategy and escalation timeout.

\n
\n
\n
\n
\n
\n

assignment

\n
\n

enum

\n

Specifies how this escalation step will assign targets (example default or round-robin). \nAllowed enum values: default,round-robin

\n
\n \n
\n
\n
\n
\n
\n

escalate_after_seconds

\n
\n

int64

\n

Specifies how many seconds to wait before escalating to the next step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Specifies the unique identifier of this escalation policy step.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Represents the relationship of an escalation policy step to its targets.

\n
\n
\n
\n
\n
\n

targets

\n
\n

object

\n

A list of escalation targets for a step

\n
\n
\n
\n
\n
\n

data

\n
\n

[ <oneOf>]

\n

The EscalationTargets data.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Represents a team target for an escalation policy step, including the team's ID and resource type.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the team resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type teams. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Represents a user target for an escalation policy step, including the user's ID and resource type.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the user resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type users. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Represents a schedule target for an escalation policy step, including its ID and resource type.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the schedule resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type schedules. \nAllowed enum values: schedules

default: schedules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type steps. \nAllowed enum values: steps

default: steps

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Represents a user object in the context of an escalation policy, including their id, type, and basic attributes.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Provides basic user information for an escalation policy, including a name and email address.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The user's email address.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The user's name.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The user's status. \nAllowed enum values: active,deactivated,pending

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique user identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Represents the primary data object for a schedule, linking attributes and relationships.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Provides core properties of a schedule object such as its name and time zone.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

A short name for the schedule.

\n
\n \n
\n
\n
\n
\n
\n

time_zone

\n
\n

string

\n

The time zone in which this schedule operates.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The schedule's unique identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Groups the relationships for a schedule object, referencing layers and teams.

\n
\n
\n
\n
\n
\n

layers

\n
\n

object

\n

Associates layers with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of layer references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the layer in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Layers resource type. \nAllowed enum values: layers

default: layers

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

teams

\n
\n

object

\n

Associates teams with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of team references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Schedules resource type. \nAllowed enum values: schedules

default: schedules

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Represents the data for a single escalation policy, including its attributes, ID, relationships, and resource type.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Defines the main attributes of an escalation policy, such as its name and behavior on policy end.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Specifies the name of the escalation policy.

\n
\n \n
\n
\n
\n
\n
\n

resolve_page_on_policy_end

\n
\n

boolean

\n

Indicates whether the page is automatically resolved when the policy ends.

\n
\n \n
\n
\n
\n
\n
\n

retries

\n
\n

int64

\n

Specifies how many times the escalation sequence is retried if there is no response.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Specifies the unique identifier of the escalation policy.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Represents the relationships for an escalation policy, including references to steps and teams.

\n
\n
\n
\n
\n
\n

steps [required]

\n
\n

object

\n

Defines the relationship to a collection of steps within an escalation policy. Contains an array of step data references.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of references to the steps defined in this escalation policy.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier for the step resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type steps. \nAllowed enum values: steps

default: steps

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

teams

\n
\n

object

\n

Associates teams with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of team references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type policies. \nAllowed enum values: policies

default: policies

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Provides any included related resources, such as steps or targets, returned with the policy.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Represents a single step in an escalation policy, including its attributes, relationships, and resource type.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Defines attributes for an escalation policy step, such as assignment strategy and escalation timeout.

\n
\n
\n
\n
\n
\n

assignment

\n
\n

enum

\n

Specifies how this escalation step will assign targets (example default or round-robin). \nAllowed enum values: default,round-robin

\n
\n \n
\n
\n
\n
\n
\n

escalate_after_seconds

\n
\n

int64

\n

Specifies how many seconds to wait before escalating to the next step.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Specifies the unique identifier of this escalation policy step.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Represents the relationship of an escalation policy step to its targets.

\n
\n
\n
\n
\n
\n

targets

\n
\n

object

\n

A list of escalation targets for a step

\n
\n
\n
\n
\n
\n

data

\n
\n

[ <oneOf>]

\n

The EscalationTargets data.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Represents a team target for an escalation policy step, including the team's ID and resource type.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the team resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type teams. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Represents a user target for an escalation policy step, including the user's ID and resource type.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the user resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type users. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the schedule resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type schedules. \nAllowed enum values: schedules

default: schedules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Relationship reference to a configured schedule target.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the configured schedule target.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type schedule_target. \nAllowed enum values: schedule_target

default: schedule_target

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type steps. \nAllowed enum values: steps

default: steps

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Represents a user object in the context of an escalation policy, including their id, type, and basic attributes.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Provides basic user information for an escalation policy, including a name and email address.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The user's email address.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The user's name.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The user's status. \nAllowed enum values: active,deactivated,pending

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique user identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Represents the primary data object for a schedule, linking attributes and relationships.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Provides core properties of a schedule object such as its name and time zone.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

A short name for the schedule.

\n
\n \n
\n
\n
\n
\n
\n

time_zone

\n
\n

string

\n

The time zone in which this schedule operates.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The schedule's unique identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Groups the relationships for a schedule object, referencing layers and teams.

\n
\n
\n
\n
\n
\n

layers

\n
\n

object

\n

Associates layers with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of layer references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the layer in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Layers resource type. \nAllowed enum values: layers

default: layers

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

teams

\n
\n

object

\n

Associates teams with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of team references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Schedules resource type. \nAllowed enum values: schedules

default: schedules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Full resource representation of a configured schedule target with position (previous, current, or next).

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for a configured schedule target, including position.

\n
\n
\n
\n
\n
\n

position [required]

\n
\n

enum

\n

Specifies the position of a schedule target (example previous, current, or next). \nAllowed enum values: previous,current,next

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the configured schedule target.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Represents the relationships of a configured schedule target.

\n
\n
\n
\n
\n
\n

schedule [required]

\n
\n

object

\n

Holds the schedule reference for a configured schedule target.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the schedule resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type schedules. \nAllowed enum values: schedules

default: schedules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type schedule_target. \nAllowed enum values: schedule_target

default: schedule_target

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Provides a reference to a team, including ID, type, and basic attributes/relationships.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

URL or reference for the team's avatar (if available).

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A short text describing the team.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

A unique handle/slug for the team.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full, human-readable name of the team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The team's unique identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -514,6 +576,11 @@ "id": "00000000-aba1-0000-0000-000000000000", "targets": [ { + "config": { + "schedule": { + "position": "previous" + } + }, "id": "00000000-aba1-0000-0000-000000000000", "type": "users" } @@ -535,7 +602,7 @@ "type": "policies" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Represents the data for updating an existing escalation policy, including its ID, attributes, relationships, and resource type.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Defines the attributes that can be updated for an escalation policy, such as description, name, resolution behavior, retries, and steps.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Specifies the name of the escalation policy.

\n
\n \n
\n
\n
\n
\n
\n

resolve_page_on_policy_end

\n
\n

boolean

\n

Indicates whether the page is automatically resolved when the policy ends.

\n
\n \n
\n
\n
\n
\n
\n

retries

\n
\n

int64

\n

Specifies how many times the escalation sequence is retried if there is no response.

\n
\n \n
\n
\n
\n
\n
\n

steps [required]

\n
\n

[object]

\n

A list of escalation steps, each defining assignment, escalation timeout, and targets.

\n
\n
\n
\n
\n
\n

assignment

\n
\n

enum

\n

Specifies how this escalation step will assign targets (example default or round-robin). \nAllowed enum values: default,round-robin

\n
\n \n
\n
\n
\n
\n
\n

escalate_after_seconds

\n
\n

int64

\n

Defines how many seconds to wait before escalating to the next step.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Specifies the unique identifier of this step.

\n
\n \n
\n
\n
\n
\n
\n

targets [required]

\n
\n

[object]

\n

Specifies the collection of escalation targets for this step.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Specifies the unique identifier for this target.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Specifies the type of escalation target (example users, schedules, or teams). \nAllowed enum values: users,schedules,teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the escalation policy being updated.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Represents relationships in an escalation policy update request, including references to teams.

\n
\n
\n
\n
\n
\n

teams

\n
\n

object

\n

Associates teams with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of team references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type policies. \nAllowed enum values: policies

default: policies

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Represents the data for updating an existing escalation policy, including its ID, attributes, relationships, and resource type.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Defines the attributes that can be updated for an escalation policy, such as description, name, resolution behavior, retries, and steps.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Specifies the name of the escalation policy.

\n
\n \n
\n
\n
\n
\n
\n

resolve_page_on_policy_end

\n
\n

boolean

\n

Indicates whether the page is automatically resolved when the policy ends.

\n
\n \n
\n
\n
\n
\n
\n

retries

\n
\n

int64

\n

Specifies how many times the escalation sequence is retried if there is no response.

\n
\n \n
\n
\n
\n
\n
\n

steps [required]

\n
\n

[object]

\n

A list of escalation steps, each defining assignment, escalation timeout, and targets.

\n
\n
\n
\n
\n
\n

assignment

\n
\n

enum

\n

Specifies how this escalation step will assign targets (example default or round-robin). \nAllowed enum values: default,round-robin

\n
\n \n
\n
\n
\n
\n
\n

escalate_after_seconds

\n
\n

int64

\n

Defines how many seconds to wait before escalating to the next step.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Specifies the unique identifier of this step.

\n
\n \n
\n
\n
\n
\n
\n

targets [required]

\n
\n

[object]

\n

Specifies the collection of escalation targets for this step.

\n
\n
\n
\n
\n
\n

config

\n
\n

object

\n

Configuration for an escalation target, such as schedule position.

\n
\n
\n
\n
\n
\n

schedule

\n
\n

object

\n

Schedule-specific configuration for an escalation target.

\n
\n
\n
\n
\n
\n

position

\n
\n

enum

\n

Specifies the position of a schedule target (example previous, current, or next). \nAllowed enum values: previous,current,next

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Specifies the unique identifier for this target.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Specifies the type of escalation target (example users, schedules, or teams). \nAllowed enum values: users,schedules,teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Specifies the unique identifier of the escalation policy being updated.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Represents relationships in an escalation policy update request, including references to teams.

\n
\n
\n
\n
\n
\n

teams

\n
\n

object

\n

Associates teams with this schedule in a data structure.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of team references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team in this relationship.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Indicates that the resource is of type policies. \nAllowed enum values: policies

default: policies

\n
\n \n
\n
\n
\n
" } }, "CreateOnCallSchedule": { diff --git a/content/en/api/v2/on-call/request.CreateOnCallEscalationPolicy.json b/content/en/api/v2/on-call/request.CreateOnCallEscalationPolicy.json index 31acc8b90b8..e9055a34465 100644 --- a/content/en/api/v2/on-call/request.CreateOnCallEscalationPolicy.json +++ b/content/en/api/v2/on-call/request.CreateOnCallEscalationPolicy.json @@ -17,6 +17,15 @@ "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", "type": "schedules" }, + { + "config": { + "schedule": { + "position": "previous" + } + }, + "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "schedules" + }, { "id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", "type": "teams" diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 86def950cf6..d270daa41d9 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -11226,6 +11226,76 @@ components: required: - type type: object + ConfiguredSchedule: + description: Full resource representation of a configured schedule target with + position (previous, current, or next). + properties: + attributes: + $ref: '#/components/schemas/ConfiguredScheduleTargetAttributes' + id: + description: Specifies the unique identifier of the configured schedule + target. + example: 00000000-aba1-0000-0000-000000000000_previous + type: string + relationships: + $ref: '#/components/schemas/ConfiguredScheduleTargetRelationships' + type: + $ref: '#/components/schemas/ConfiguredScheduleTargetType' + required: + - type + - id + - attributes + - relationships + type: object + ConfiguredScheduleTarget: + description: Relationship reference to a configured schedule target. + properties: + id: + description: Specifies the unique identifier of the configured schedule + target. + example: 00000000-aba1-0000-0000-000000000000_previous + type: string + type: + $ref: '#/components/schemas/ConfiguredScheduleTargetType' + required: + - type + - id + type: object + ConfiguredScheduleTargetAttributes: + description: Attributes for a configured schedule target, including position. + example: + position: previous + properties: + position: + $ref: '#/components/schemas/ScheduleTargetPosition' + required: + - position + type: object + ConfiguredScheduleTargetRelationships: + description: Represents the relationships of a configured schedule target. + properties: + schedule: + $ref: '#/components/schemas/ConfiguredScheduleTargetRelationshipsSchedule' + required: + - schedule + type: object + ConfiguredScheduleTargetRelationshipsSchedule: + description: Holds the schedule reference for a configured schedule target. + properties: + data: + $ref: '#/components/schemas/ScheduleTarget' + required: + - data + type: object + ConfiguredScheduleTargetType: + default: schedule_target + description: Indicates that the resource is of type `schedule_target`. + enum: + - schedule_target + example: schedule_target + type: string + x-enum-varnames: + - SCHEDULE_TARGET ConfluentAccountCreateRequest: description: Payload schema when adding a Confluent account. properties: @@ -18735,6 +18805,8 @@ components: type: users - id: 00000000-aba2-0000-0000-000000000000 type: schedules + - id: 00000000-aba2-0000-0000-000000000000_previous + type: schedule_target - id: 00000000-aba3-0000-0000-000000000000 type: teams type: steps @@ -18742,6 +18814,15 @@ components: type: users - id: 00000000-aba2-0000-0000-000000000000 type: schedules + - attributes: + position: previous + id: 00000000-aba2-0000-0000-000000000000_previous + relationships: + schedule: + data: + id: 00000000-aba2-0000-0000-000000000000 + type: schedules + type: schedule_target - id: 00000000-aba3-0000-0000-000000000000 type: teams properties: @@ -18769,7 +18850,10 @@ components: targets: - id: 00000000-aba1-0000-0000-000000000000 type: users - - id: 00000000-aba2-0000-0000-000000000000 + - config: + schedule: + position: previous + id: 00000000-aba2-0000-0000-000000000000 type: schedules - id: 00000000-aba3-0000-0000-000000000000 type: teams @@ -18813,6 +18897,7 @@ components: name: description: Specifies the name for the new escalation policy. example: On-Call Escalation Policy + minLength: 1 type: string resolve_page_on_policy_end: description: Indicates whether the page is automatically resolved when the @@ -18822,12 +18907,16 @@ components: description: Specifies how many times the escalation sequence is retried if there is no response. format: int64 + maximum: 10 + minimum: 0 type: integer steps: description: A list of escalation steps, each defining assignment, escalation timeout, and targets for the new policy. items: $ref: '#/components/schemas/EscalationPolicyCreateRequestDataAttributesStepsItems' + maxItems: 10 + minItems: 1 type: array required: - name @@ -18844,6 +18933,8 @@ components: step. example: 3600 format: int64 + maximum: 36000 + minimum: 60 type: integer targets: description: Specifies the collection of escalation targets for this step. @@ -18895,6 +18986,7 @@ components: name: description: Specifies the name of the escalation policy. example: On-Call Escalation Policy + minLength: 1 type: string resolve_page_on_policy_end: description: Indicates whether the page is automatically resolved when the @@ -18904,6 +18996,8 @@ components: description: Specifies how many times the escalation sequence is retried if there is no response. format: int64 + maximum: 10 + minimum: 0 type: integer required: - name @@ -18966,10 +19060,11 @@ components: description: Represents included related resources when retrieving an escalation policy, such as teams, steps, or targets. oneOf: - - $ref: '#/components/schemas/TeamReference' - $ref: '#/components/schemas/EscalationPolicyStep' - $ref: '#/components/schemas/EscalationPolicyUser' - $ref: '#/components/schemas/ScheduleData' + - $ref: '#/components/schemas/ConfiguredSchedule' + - $ref: '#/components/schemas/TeamReference' EscalationPolicyStep: description: Represents a single step in an escalation policy, including its attributes, relationships, and resource type. @@ -19017,8 +19112,10 @@ components: type: object EscalationPolicyStepTarget: description: Defines a single escalation target within a step for an escalation - policy creation request. Contains `id` and `type`. + policy creation request. Contains `id`, `type`, and optional `config`. properties: + config: + $ref: '#/components/schemas/EscalationPolicyStepTargetConfig' id: description: Specifies the unique identifier for this target. example: 00000000-aba1-0000-0000-000000000000 @@ -19026,6 +19123,18 @@ components: type: $ref: '#/components/schemas/EscalationPolicyStepTargetType' type: object + EscalationPolicyStepTargetConfig: + description: Configuration for an escalation target, such as schedule position. + properties: + schedule: + $ref: '#/components/schemas/EscalationPolicyStepTargetConfigSchedule' + type: object + EscalationPolicyStepTargetConfigSchedule: + description: Schedule-specific configuration for an escalation target. + properties: + position: + $ref: '#/components/schemas/ScheduleTargetPosition' + type: object EscalationPolicyStepTargetType: description: Specifies the type of escalation target (example `users`, `schedules`, or `teams`). @@ -19106,6 +19215,7 @@ components: name: description: Specifies the name of the escalation policy. example: On-Call Escalation Policy + minLength: 1 type: string resolve_page_on_policy_end: description: Indicates whether the page is automatically resolved when the @@ -19115,12 +19225,16 @@ components: description: Specifies how many times the escalation sequence is retried if there is no response. format: int64 + maximum: 10 + minimum: 0 type: integer steps: description: A list of escalation steps, each defining assignment, escalation timeout, and targets. items: $ref: '#/components/schemas/EscalationPolicyUpdateRequestDataAttributesStepsItems' + maxItems: 10 + minItems: 1 type: array required: - name @@ -19138,6 +19252,8 @@ components: step. example: 3600 format: int64 + maximum: 36000 + minimum: 60 type: integer id: description: Specifies the unique identifier of this step. @@ -19246,12 +19362,13 @@ components: x-enum-varnames: - USERS EscalationTarget: - description: Represents an escalation target, which can be a team, user, or - schedule. + description: Represents an escalation target, which can be a team, user, schedule, + or configured schedule target. oneOf: - $ref: '#/components/schemas/TeamTarget' - $ref: '#/components/schemas/UserTarget' - $ref: '#/components/schemas/ScheduleTarget' + - $ref: '#/components/schemas/ConfiguredScheduleTarget' EscalationTargets: description: A list of escalation targets for a step properties: @@ -45350,7 +45467,8 @@ components: type: object ScheduleTarget: description: Represents a schedule target for an escalation policy step, including - its ID and resource type. + its ID and resource type. This is a shortcut for a configured schedule target + with position set to 'current'. properties: id: description: Specifies the unique identifier of the schedule resource. @@ -45362,6 +45480,19 @@ components: - type - id type: object + ScheduleTargetPosition: + description: Specifies the position of a schedule target (example `previous`, + `current`, or `next`). + enum: + - previous + - current + - next + example: previous + type: string + x-enum-varnames: + - PREVIOUS + - CURRENT + - NEXT ScheduleTargetType: default: schedules description: Indicates that the resource is of type `schedules`.