"""Request Body Schemas for API Tools

DO NOT EDIT THIS MODULE DIRECTLY.

THIS MODULE WAS AUTO-GENERATED AND CONTAINS OpenAPI REQUEST BODY SCHEMAS
FOR TOOLS WITH COMPLEX REQUEST BODIES. ANY CHANGES TO THIS MODULE WILL
BE OVERWRITTEN BY THE TRANSPILER.
"""

from typing import Any

REQUEST_BODY_SCHEMAS: dict[str, Any] = {
    "ASSIGNTAGSTOPAGERDUTYENTITY": '{"type": "object", "description": "Tags to add to or remove from the entity.", "properties": {"add": {"type": "array", "description": "Array of tags and/or tag references to add to the entity.\nFor elements with type `tag_reference`, the tag with the corresponding `id` is added to the entity.\nFor elements with type `tag`, if there is an existing tag with the given\nlabel that tag is added to the entity. If there is no existing tag with that label and the user has permission\nto create tags, a new tag is created with that label and assigned to the entity.\n", "items": {"title": "Tags to add", "type": "object", "properties": {"type": {"type": "string", "enum": ["tag", "tag_reference"]}, "label": {"type": "string", "description": "The label of the tag. Should be used when type is "tag".", "maxLength": 191}, "id": {"type": "string", "description": "The id of the tag. Should be used when type is "tag_reference".", "readOnly": true}}, "required": ["type"]}}, "remove": {"type": "array", "description": "Array of tag references to remove from the entity.", "items": {"title": "Tags to remove.", "type": "object", "properties": {"type": {"type": "string", "enum": ["tag_reference"]}, "id": {"type": "string", "description": "The id of the tag", "readOnly": true}}, "required": ["type", "id"]}}}}',  # noqa: E501
    "INSTALLPAGERDUTYADDON": '{"type": "object", "properties": {"addon": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "description": "The type of Add-on.", "enum": ["full_page_addon", "incident_show_addon"]}, "name": {"type": "string", "description": "The name of the Add-on.", "maxLength": 100}, "src": {"type": "string", "format": "url", "description": "The source URL to display in a frame in the PagerDuty UI. HTTPS is required."}}, "required": ["type", "name", "src"], "example": {"type": "full_page_addon", "name": "Internal Status Page", "src": "https://intranet.example.com/status"}}]}}, "required": ["addon"]}',  # noqa: E501
    "UPDATEPAGERDUTYADDON": '{"type": "object", "properties": {"addon": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "description": "The type of Add-on.", "enum": ["full_page_addon", "incident_show_addon"]}, "name": {"type": "string", "description": "The name of the Add-on.", "maxLength": 100}, "src": {"type": "string", "format": "url", "description": "The source URL to display in a frame in the PagerDuty UI. HTTPS is required."}}, "required": ["type", "name", "src"], "example": {"type": "full_page_addon", "name": "Internal Status Page", "src": "https://intranet.example.com/status"}}]}}, "required": ["addon"]}',  # noqa: E501
    "CREATEALERTGROUPINGSETTING": '{"type": "object", "properties": {"alert_grouping_setting": {"type": "object", "description": "Defines how alerts will be automatically grouped into incidents based on the configurations defined. Note that the Alert Grouping Setting features are available only on certain plans.\n", "properties": {"id": {"type": "string", "readOnly": true}, "name": {"type": "string", "nullable": true, "description": "An optional short-form string that provides succinct information about an AlertGroupingSetting object suitable for primary labeling of the entity. It is not intended to be an identifier."}, "description": {"type": "string", "nullable": true, "description": "An optional description in string that provides more information about an AlertGroupingSetting object."}, "type": {"type": "string", "enum": ["content_based", "content_based_intelligent", "intelligent", "time"]}, "config": {"anyOf": [{"type": "object", "title": "Content Only Grouping", "description": "The configuration for Content Based Alert Grouping", "properties": {"aggregate": {"type": "string", "description": "Whether Alerts should be grouped if `all` or `any` specified fields match. If `all` is selected, an exact match on every specified field name must occur for Alerts to be grouped. If `any` is selected, Alerts will be grouped when there is an exact match on at least one of the specified fields.", "enum": ["all, any"]}, "fields": {"type": "array", "description": "An array of strings which represent the fields with which to group against. Depending on the aggregate, Alerts will group if some or all the fields match.", "items": {"type": "string"}}, "time_window": {"type": "integer", "minimum": 300, "maximum": 86400, "description": "The maximum amount of time allowed between Alerts. Any Alerts arriving greater than `time_window` seconds apart will not be grouped together. This is a rolling time window up to 24 hours and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours (24 hours only applies to single-service settings). To use the "recommended_time_window," set the value to 0, otherwise the value must be between 300 <= time_window <= 3600 or 86400(i.e. 24 hours)."}, "recommended_time_window": {"readOnly": true, "type": "integer", "description": "In order to ensure your Service has the optimal grouping window, we use data science to calculate your Service\'s average Alert inter-arrival time. We encourage customer\'s to use this value, please set `time_window` to 0 to use the `recommended_time_window`."}}}, {"type": "object", "title": "Content and Intelligent Grouping", "description": "The configuration for Content Based Intelligent Alert Grouping", "properties": {"aggregate": {"type": "string", "description": "Whether Alerts should be grouped if `all` or `any` specified fields match. If `all` is selected, an exact match on every specified field name must occur for Alerts to be grouped. If `any` is selected, Alerts will be grouped when there is an exact match on at least one of the specified fields.", "enum": ["all, any"]}, "fields": {"type": "array", "description": "An array of strings which represent the fields with which to group against. Depending on the aggregate, Alerts will group if some or all the fields match.", "items": {"type": "string"}}, "time_window": {"type": "integer", "minimum": 300, "maximum": 3600, "description": "The maximum amount of time allowed between Alerts. Any Alerts arriving greater than `time_window` seconds apart will not be grouped together. This is a rolling time window up to 24 hours and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours (24 hours only applies to single-service settings). To use the "recommended_time_window," set the value to 0, otherwise the value must be between 300 <= time_window <= 3600."}, "recommended_time_window": {"readOnly": true, "type": "integer", "description": "In order to ensure your Service has the optimal grouping window, we use data science to calculate your Service\'s average Alert inter-arrival time. We encourage customer\'s to use this value, please set `time_window` to 0 to use the `recommended_time_window`."}}}, {"type": "object", "title": "Time Grouping", "description": "The configuration for Time Based Alert Grouping", "properties": {"timeout": {"type": "integer", "minimum": 60, "maximum": 86400, "description": "The duration in seconds within which to automatically group incoming Alerts. To continue grouping Alerts until the Incident is resolved, set this value to 0."}}}, {"type": "object", "title": "Intelligent Grouping", "description": "The configuration for Intelligent Alert Grouping", "properties": {"time_window": {"type": "integer", "minimum": 300, "maximum": 3600, "description": "The maximum amount of time allowed between Alerts. Any Alerts arriving greater than `time_window` seconds apart will not be grouped together. This is a rolling time window up to 24 hours and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours (24 hours only applies to single-service settings). To use the "recommended_time_window," set the value to 0, otherwise the value must be between 300 <= time_window <= 3600."}, "recommended_time_window": {"readOnly": true, "type": "integer", "description": "In order to ensure your Service has the optimal grouping window, we use data science to calculate your Service\'s average Alert inter-arrival time. We encourage customer\'s to use this value, please set `time_window` to 0 to use the `recommended_time_window`."}, "iag_fields": {"type": "array", "description": "An array of strings which represent the iag fields with which to intelligently group against.", "default": ["summary"], "items": {"type": "string"}}}}]}, "services": {"type": "array", "description": "The array of one or many Services with just ServiceID/name that the AlertGroupingSetting applies to. Type of content_based_intelligent allows for only one service in the array.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["service_reference"]}}}]}}, "created_at": {"type": "string", "format": "date-time", "description": "The ISO8601 date/time an AlertGroupingSetting got created at.", "readOnly": true}, "updated_at": {"type": "string", "format": "date-time", "description": "The ISO8601 date/time an AlertGroupingSetting last got updated at.", "readOnly": true}}}}, "required": ["alert_grouping_setting"]}',  # noqa: E501
    "UPDATEALERTGROUPINGSETTING": '{"type": "object", "properties": {"alert_grouping_setting": {"type": "object", "description": "Defines how alerts will be automatically grouped into incidents based on the configurations defined. Note that the Alert Grouping Setting features are available only on certain plans.\n", "properties": {"id": {"type": "string", "readOnly": true}, "name": {"type": "string", "nullable": true, "description": "An optional short-form string that provides succinct information about an AlertGroupingSetting object suitable for primary labeling of the entity. It is not intended to be an identifier."}, "description": {"type": "string", "nullable": true, "description": "An optional description in string that provides more information about an AlertGroupingSetting object."}, "type": {"type": "string", "enum": ["content_based", "content_based_intelligent", "intelligent", "time"]}, "config": {"anyOf": [{"type": "object", "title": "Content Only Grouping", "description": "The configuration for Content Based Alert Grouping", "properties": {"aggregate": {"type": "string", "description": "Whether Alerts should be grouped if `all` or `any` specified fields match. If `all` is selected, an exact match on every specified field name must occur for Alerts to be grouped. If `any` is selected, Alerts will be grouped when there is an exact match on at least one of the specified fields.", "enum": ["all, any"]}, "fields": {"type": "array", "description": "An array of strings which represent the fields with which to group against. Depending on the aggregate, Alerts will group if some or all the fields match.", "items": {"type": "string"}}, "time_window": {"type": "integer", "minimum": 300, "maximum": 86400, "description": "The maximum amount of time allowed between Alerts. Any Alerts arriving greater than `time_window` seconds apart will not be grouped together. This is a rolling time window up to 24 hours and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours (24 hours only applies to single-service settings). To use the "recommended_time_window," set the value to 0, otherwise the value must be between 300 <= time_window <= 3600 or 86400(i.e. 24 hours)."}, "recommended_time_window": {"readOnly": true, "type": "integer", "description": "In order to ensure your Service has the optimal grouping window, we use data science to calculate your Service\'s average Alert inter-arrival time. We encourage customer\'s to use this value, please set `time_window` to 0 to use the `recommended_time_window`."}}}, {"type": "object", "title": "Content and Intelligent Grouping", "description": "The configuration for Content Based Intelligent Alert Grouping", "properties": {"aggregate": {"type": "string", "description": "Whether Alerts should be grouped if `all` or `any` specified fields match. If `all` is selected, an exact match on every specified field name must occur for Alerts to be grouped. If `any` is selected, Alerts will be grouped when there is an exact match on at least one of the specified fields.", "enum": ["all, any"]}, "fields": {"type": "array", "description": "An array of strings which represent the fields with which to group against. Depending on the aggregate, Alerts will group if some or all the fields match.", "items": {"type": "string"}}, "time_window": {"type": "integer", "minimum": 300, "maximum": 3600, "description": "The maximum amount of time allowed between Alerts. Any Alerts arriving greater than `time_window` seconds apart will not be grouped together. This is a rolling time window up to 24 hours and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours (24 hours only applies to single-service settings). To use the "recommended_time_window," set the value to 0, otherwise the value must be between 300 <= time_window <= 3600."}, "recommended_time_window": {"readOnly": true, "type": "integer", "description": "In order to ensure your Service has the optimal grouping window, we use data science to calculate your Service\'s average Alert inter-arrival time. We encourage customer\'s to use this value, please set `time_window` to 0 to use the `recommended_time_window`."}}}, {"type": "object", "title": "Time Grouping", "description": "The configuration for Time Based Alert Grouping", "properties": {"timeout": {"type": "integer", "minimum": 60, "maximum": 86400, "description": "The duration in seconds within which to automatically group incoming Alerts. To continue grouping Alerts until the Incident is resolved, set this value to 0."}}}, {"type": "object", "title": "Intelligent Grouping", "description": "The configuration for Intelligent Alert Grouping", "properties": {"time_window": {"type": "integer", "minimum": 300, "maximum": 3600, "description": "The maximum amount of time allowed between Alerts. Any Alerts arriving greater than `time_window` seconds apart will not be grouped together. This is a rolling time window up to 24 hours and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours (24 hours only applies to single-service settings). To use the "recommended_time_window," set the value to 0, otherwise the value must be between 300 <= time_window <= 3600."}, "recommended_time_window": {"readOnly": true, "type": "integer", "description": "In order to ensure your Service has the optimal grouping window, we use data science to calculate your Service\'s average Alert inter-arrival time. We encourage customer\'s to use this value, please set `time_window` to 0 to use the `recommended_time_window`."}, "iag_fields": {"type": "array", "description": "An array of strings which represent the iag fields with which to intelligently group against.", "default": ["summary"], "items": {"type": "string"}}}}]}, "services": {"type": "array", "description": "The array of one or many Services with just ServiceID/name that the AlertGroupingSetting applies to. Type of content_based_intelligent allows for only one service in the array.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["service_reference"]}}}]}}, "created_at": {"type": "string", "format": "date-time", "description": "The ISO8601 date/time an AlertGroupingSetting got created at.", "readOnly": true}, "updated_at": {"type": "string", "format": "date-time", "description": "The ISO8601 date/time an AlertGroupingSetting last got updated at.", "readOnly": true}}}}, "required": ["alert_grouping_setting"]}',  # noqa: E501
    "GETINCIDENTMETRICS": '{"type": "object", "properties": {"filters": {"type": "object", "description": "Accepts a set of filters to apply to the Incidents before aggregating.  Any incidents that do not match the included filters will be omitted from the results.", "properties": {"created_at_start": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any incidents with a created_at less than this value will be omitted from the results. The maximum supported time range in conjunction with created_at_end is one year.", "example": "2024-01-01T00:00:00+05:00"}, "created_at_end": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any incidents with a created_at greater than or equal to this value will be omitted from the results. The maximum supported time range in conjunction with created_at_start is one year.", "example": "2024-02-01T00:00:00Z"}, "urgency": {"type": "string", "description": "Any incidents whose urgency does not match the provided string will be omitted from the results.", "example": "high", "enum": ["high", "low"]}, "major": {"type": "boolean", "description": "A boolean flag including whether results should contain *only* [major incidents](https://support.pagerduty.com/docs/operational-reviews#major-incidents), or exclude major incidents. If no value is provided all incidents will be included.", "example": true}, "min_ackowledgements": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of acknowledgements to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 acknowledgement. If no value is provided, all incidents will be included.", "example": 1}, "min_timeout_escalations": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of timeout escalations to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 timeout escalation. If no value is provided, all incidents will be included.", "example": 1}, "min_manual_escalations": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of manual escalations to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 manual escalation. If no value is provided, all incidents will be included.", "example": 1}, "team_ids": {"type": "array", "description": "An array of team IDs. Only incidents related to these teams will be included in the results. If omitted, all teams the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["P373JQQ", "PAECHJV", "P7SYGW6"]}, "service_ids": {"type": "array", "description": "An array of service IDs. Only incidents related to these services will be included in the results. If omitted, all services the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["PSEJLIN", "PSLWBL8", "PT4KHLX"]}, "escalation_policy_ids": {"type": "array", "description": "An array of escalation policy IDs. Only incidents related to these escalation policies will be included in the results. If omitted, all escalation policies the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["PDJXDF3", "PG4EHNS"]}, "priority_ids": {"type": "array", "description": "An array of priority IDs. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.", "items": {"type": "string"}, "example": ["PC8O0L3", "PX01HJD", "P5FK83M"]}, "priority_names": {"type": "array", "description": "An array of user-defined priority names. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.", "items": {"type": "string"}, "example": ["P1", "P2", "P3"]}, "pd_advance_used": {"type": "boolean", "description": "If true, only incidents where PD Advance was used will be included in the results, and vice versa. If omitted, all incidents will be included.", "example": true}}}, "time_zone": {"type": "string", "description": "The time zone to use for the results and grouping. Must be in tzdata format. See list of accepted values [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).", "example": "Etc/UTC"}, "order": {"type": "string", "description": "The order in which the results were sorted; asc for ascending, desc for descending.", "enum": ["asc", "desc"]}, "order_by": {"type": "string", "description": "The column that was used for ordering the results.", "example": "created_at"}, "aggregate_unit": {"type": "string", "description": "The time unit to aggregate metrics by.  If no value is provided, the metrics will be aggregated for the entire period.", "nullable": true, "example": "day", "enum": ["day", "week", "month"]}}}',  # noqa: E501
    "GETESCALATIONPOLICYMETRICS": '{"type": "object", "properties": {"filters": {"type": "object", "description": "Accepts a set of filters to apply to the Incidents before aggregating.  Any incidents that do not match the included filters will be omitted from the results.", "properties": {"created_at_start": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any incidents with a created_at less than this value will be omitted from the results. The maximum supported time range in conjunction with created_at_end is one year.", "example": "2024-01-01T00:00:00+05:00"}, "created_at_end": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any incidents with a created_at greater than or equal to this value will be omitted from the results. The maximum supported time range in conjunction with created_at_start is one year.", "example": "2024-02-01T00:00:00Z"}, "urgency": {"type": "string", "description": "Any incidents whose urgency does not match the provided string will be omitted from the results.", "example": "high", "enum": ["high", "low"]}, "major": {"type": "boolean", "description": "A boolean flag including whether results should contain *only* [major incidents](https://support.pagerduty.com/docs/operational-reviews#major-incidents), or exclude major incidents. If no value is provided all incidents will be included.", "example": true}, "min_ackowledgements": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of acknowledgements to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 acknowledgement. If no value is provided, all incidents will be included.", "example": 1}, "min_timeout_escalations": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of timeout escalations to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 timeout escalation. If no value is provided, all incidents will be included.", "example": 1}, "min_manual_escalations": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of manual escalations to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 manual escalation. If no value is provided, all incidents will be included.", "example": 1}, "team_ids": {"type": "array", "description": "An array of team IDs. Only incidents related to these teams will be included in the results. If omitted, all teams the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["P373JQQ", "PAECHJV", "P7SYGW6"]}, "service_ids": {"type": "array", "description": "An array of service IDs. Only incidents related to these services will be included in the results. If omitted, all services the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["PSEJLIN", "PSLWBL8", "PT4KHLX"]}, "escalation_policy_ids": {"type": "array", "description": "An array of escalation policy IDs. Only incidents related to these escalation policies will be included in the results. If omitted, all escalation policies the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["PDJXDF3", "PG4EHNS"]}, "priority_ids": {"type": "array", "description": "An array of priority IDs. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.", "items": {"type": "string"}, "example": ["PC8O0L3", "PX01HJD", "P5FK83M"]}, "priority_names": {"type": "array", "description": "An array of user-defined priority names. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.", "items": {"type": "string"}, "example": ["P1", "P2", "P3"]}, "pd_advance_used": {"type": "boolean", "description": "If true, only incidents where PD Advance was used will be included in the results, and vice versa. If omitted, all incidents will be included.", "example": true}}}, "time_zone": {"type": "string", "description": "The time zone to use for the results and grouping. Must be in tzdata format. See list of accepted values [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).", "example": "Etc/UTC"}, "order": {"type": "string", "description": "The order in which the results were sorted; asc for ascending, desc for descending.", "enum": ["asc", "desc"]}, "order_by": {"type": "string", "description": "The column that was used for ordering the results.", "example": "created_at"}, "aggregate_unit": {"type": "string", "description": "The time unit to aggregate metrics by.  If no value is provided, the metrics will be aggregated for the entire period.", "nullable": true, "example": "day", "enum": ["day", "week", "month"]}}}',  # noqa: E501
    "FETCHINCIDENTMETRICS": '{"type": "object", "properties": {"filters": {"type": "object", "description": "Accepts a set of filters to apply to the Incidents before aggregating.  Any incidents that do not match the included filters will be omitted from the results.", "properties": {"created_at_start": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any incidents with a created_at less than this value will be omitted from the results. The maximum supported time range in conjunction with created_at_end is one year.", "example": "2024-01-01T00:00:00+05:00"}, "created_at_end": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any incidents with a created_at greater than or equal to this value will be omitted from the results. The maximum supported time range in conjunction with created_at_start is one year.", "example": "2024-02-01T00:00:00Z"}, "urgency": {"type": "string", "description": "Any incidents whose urgency does not match the provided string will be omitted from the results.", "example": "high", "enum": ["high", "low"]}, "major": {"type": "boolean", "description": "A boolean flag including whether results should contain *only* [major incidents](https://support.pagerduty.com/docs/operational-reviews#major-incidents), or exclude major incidents. If no value is provided all incidents will be included.", "example": true}, "min_ackowledgements": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of acknowledgements to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 acknowledgement. If no value is provided, all incidents will be included.", "example": 1}, "min_timeout_escalations": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of timeout escalations to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 timeout escalation. If no value is provided, all incidents will be included.", "example": 1}, "min_manual_escalations": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of manual escalations to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 manual escalation. If no value is provided, all incidents will be included.", "example": 1}, "team_ids": {"type": "array", "description": "An array of team IDs. Only incidents related to these teams will be included in the results. If omitted, all teams the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["P373JQQ", "PAECHJV", "P7SYGW6"]}, "service_ids": {"type": "array", "description": "An array of service IDs. Only incidents related to these services will be included in the results. If omitted, all services the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["PSEJLIN", "PSLWBL8", "PT4KHLX"]}, "escalation_policy_ids": {"type": "array", "description": "An array of escalation policy IDs. Only incidents related to these escalation policies will be included in the results. If omitted, all escalation policies the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["PDJXDF3", "PG4EHNS"]}, "priority_ids": {"type": "array", "description": "An array of priority IDs. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.", "items": {"type": "string"}, "example": ["PC8O0L3", "PX01HJD", "P5FK83M"]}, "priority_names": {"type": "array", "description": "An array of user-defined priority names. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.", "items": {"type": "string"}, "example": ["P1", "P2", "P3"]}, "pd_advance_used": {"type": "boolean", "description": "If true, only incidents where PD Advance was used will be included in the results, and vice versa. If omitted, all incidents will be included.", "example": true}}}, "time_zone": {"type": "string", "description": "The time zone to use for the results and grouping. Must be in tzdata format. See list of accepted values [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).", "example": "Etc/UTC"}, "order": {"type": "string", "description": "The order in which the results were sorted; asc for ascending, desc for descending.", "enum": ["asc", "desc"]}, "order_by": {"type": "string", "description": "The column that was used for ordering the results.", "example": "created_at"}, "aggregate_unit": {"type": "string", "description": "The time unit to aggregate metrics by.  If no value is provided, the metrics will be aggregated for the entire period.", "nullable": true, "example": "day", "enum": ["day", "week", "month"]}}}',  # noqa: E501
    "GETINCIDENTANALYTICSMETRICS": '{"type": "object", "properties": {"filters": {"type": "object", "description": "Accepts a set of filters to apply to the Incidents before aggregating.  Any incidents that do not match the included filters will be omitted from the results.", "properties": {"created_at_start": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any incidents with a created_at less than this value will be omitted from the results. The maximum supported time range in conjunction with created_at_end is one year.", "example": "2024-01-01T00:00:00+05:00"}, "created_at_end": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any incidents with a created_at greater than or equal to this value will be omitted from the results. The maximum supported time range in conjunction with created_at_start is one year.", "example": "2024-02-01T00:00:00Z"}, "urgency": {"type": "string", "description": "Any incidents whose urgency does not match the provided string will be omitted from the results.", "example": "high", "enum": ["high", "low"]}, "major": {"type": "boolean", "description": "A boolean flag including whether results should contain *only* [major incidents](https://support.pagerduty.com/docs/operational-reviews#major-incidents), or exclude major incidents. If no value is provided all incidents will be included.", "example": true}, "min_ackowledgements": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of acknowledgements to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 acknowledgement. If no value is provided, all incidents will be included.", "example": 1}, "min_timeout_escalations": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of timeout escalations to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 timeout escalation. If no value is provided, all incidents will be included.", "example": 1}, "min_manual_escalations": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of manual escalations to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 manual escalation. If no value is provided, all incidents will be included.", "example": 1}, "team_ids": {"type": "array", "description": "An array of team IDs. Only incidents related to these teams will be included in the results. If omitted, all teams the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["P373JQQ", "PAECHJV", "P7SYGW6"]}, "service_ids": {"type": "array", "description": "An array of service IDs. Only incidents related to these services will be included in the results. If omitted, all services the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["PSEJLIN", "PSLWBL8", "PT4KHLX"]}, "escalation_policy_ids": {"type": "array", "description": "An array of escalation policy IDs. Only incidents related to these escalation policies will be included in the results. If omitted, all escalation policies the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["PDJXDF3", "PG4EHNS"]}, "priority_ids": {"type": "array", "description": "An array of priority IDs. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.", "items": {"type": "string"}, "example": ["PC8O0L3", "PX01HJD", "P5FK83M"]}, "priority_names": {"type": "array", "description": "An array of user-defined priority names. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.", "items": {"type": "string"}, "example": ["P1", "P2", "P3"]}, "pd_advance_used": {"type": "boolean", "description": "If true, only incidents where PD Advance was used will be included in the results, and vice versa. If omitted, all incidents will be included.", "example": true}}}, "time_zone": {"type": "string", "description": "The time zone to use for the results and grouping. Must be in tzdata format. See list of accepted values [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).", "example": "Etc/UTC"}, "order": {"type": "string", "description": "The order in which the results were sorted; asc for ascending, desc for descending.", "enum": ["asc", "desc"]}, "order_by": {"type": "string", "description": "The column that was used for ordering the results.", "example": "created_at"}, "aggregate_unit": {"type": "string", "description": "The time unit to aggregate metrics by.  If no value is provided, the metrics will be aggregated for the entire period.", "nullable": true, "example": "day", "enum": ["day", "week", "month"]}}}',  # noqa: E501
    "GETAGGREGATEDINCIDENTMETRICS": '{"type": "object", "properties": {"filters": {"type": "object", "description": "Accepts a set of filters to apply to the Incidents before aggregating.  Any incidents that do not match the included filters will be omitted from the results.", "properties": {"created_at_start": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any incidents with a created_at less than this value will be omitted from the results. The maximum supported time range in conjunction with created_at_end is one year.", "example": "2024-01-01T00:00:00+05:00"}, "created_at_end": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any incidents with a created_at greater than or equal to this value will be omitted from the results. The maximum supported time range in conjunction with created_at_start is one year.", "example": "2024-02-01T00:00:00Z"}, "urgency": {"type": "string", "description": "Any incidents whose urgency does not match the provided string will be omitted from the results.", "example": "high", "enum": ["high", "low"]}, "major": {"type": "boolean", "description": "A boolean flag including whether results should contain *only* [major incidents](https://support.pagerduty.com/docs/operational-reviews#major-incidents), or exclude major incidents. If no value is provided all incidents will be included.", "example": true}, "min_ackowledgements": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of acknowledgements to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 acknowledgement. If no value is provided, all incidents will be included.", "example": 1}, "min_timeout_escalations": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of timeout escalations to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 timeout escalation. If no value is provided, all incidents will be included.", "example": 1}, "min_manual_escalations": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of manual escalations to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 manual escalation. If no value is provided, all incidents will be included.", "example": 1}, "team_ids": {"type": "array", "description": "An array of team IDs. Only incidents related to these teams will be included in the results. If omitted, all teams the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["P373JQQ", "PAECHJV", "P7SYGW6"]}, "service_ids": {"type": "array", "description": "An array of service IDs. Only incidents related to these services will be included in the results. If omitted, all services the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["PSEJLIN", "PSLWBL8", "PT4KHLX"]}, "escalation_policy_ids": {"type": "array", "description": "An array of escalation policy IDs. Only incidents related to these escalation policies will be included in the results. If omitted, all escalation policies the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["PDJXDF3", "PG4EHNS"]}, "priority_ids": {"type": "array", "description": "An array of priority IDs. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.", "items": {"type": "string"}, "example": ["PC8O0L3", "PX01HJD", "P5FK83M"]}, "priority_names": {"type": "array", "description": "An array of user-defined priority names. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.", "items": {"type": "string"}, "example": ["P1", "P2", "P3"]}, "pd_advance_used": {"type": "boolean", "description": "If true, only incidents where PD Advance was used will be included in the results, and vice versa. If omitted, all incidents will be included.", "example": true}}}, "time_zone": {"type": "string", "description": "The time zone to use for the results and grouping. Must be in tzdata format. See list of accepted values [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).", "example": "Etc/UTC"}, "order": {"type": "string", "description": "The order in which the results were sorted; asc for ascending, desc for descending.", "enum": ["asc", "desc"]}, "order_by": {"type": "string", "description": "The column that was used for ordering the results.", "example": "created_at"}, "aggregate_unit": {"type": "string", "description": "The time unit to aggregate metrics by.  If no value is provided, the metrics will be aggregated for the entire period.", "nullable": true, "example": "day", "enum": ["day", "week", "month"]}}}',  # noqa: E501
    "GETTEAMINCIDENTMETRICS": '{"type": "object", "properties": {"filters": {"type": "object", "description": "Accepts a set of filters to apply to the Incidents before aggregating.  Any incidents that do not match the included filters will be omitted from the results.", "properties": {"created_at_start": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any incidents with a created_at less than this value will be omitted from the results. The maximum supported time range in conjunction with created_at_end is one year.", "example": "2024-01-01T00:00:00+05:00"}, "created_at_end": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any incidents with a created_at greater than or equal to this value will be omitted from the results. The maximum supported time range in conjunction with created_at_start is one year.", "example": "2024-02-01T00:00:00Z"}, "urgency": {"type": "string", "description": "Any incidents whose urgency does not match the provided string will be omitted from the results.", "example": "high", "enum": ["high", "low"]}, "major": {"type": "boolean", "description": "A boolean flag including whether results should contain *only* [major incidents](https://support.pagerduty.com/docs/operational-reviews#major-incidents), or exclude major incidents. If no value is provided all incidents will be included.", "example": true}, "min_ackowledgements": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of acknowledgements to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 acknowledgement. If no value is provided, all incidents will be included.", "example": 1}, "min_timeout_escalations": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of timeout escalations to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 timeout escalation. If no value is provided, all incidents will be included.", "example": 1}, "min_manual_escalations": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of manual escalations to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 manual escalation. If no value is provided, all incidents will be included.", "example": 1}, "team_ids": {"type": "array", "description": "An array of team IDs. Only incidents related to these teams will be included in the results. If omitted, all teams the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["P373JQQ", "PAECHJV", "P7SYGW6"]}, "service_ids": {"type": "array", "description": "An array of service IDs. Only incidents related to these services will be included in the results. If omitted, all services the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["PSEJLIN", "PSLWBL8", "PT4KHLX"]}, "escalation_policy_ids": {"type": "array", "description": "An array of escalation policy IDs. Only incidents related to these escalation policies will be included in the results. If omitted, all escalation policies the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["PDJXDF3", "PG4EHNS"]}, "priority_ids": {"type": "array", "description": "An array of priority IDs. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.", "items": {"type": "string"}, "example": ["PC8O0L3", "PX01HJD", "P5FK83M"]}, "priority_names": {"type": "array", "description": "An array of user-defined priority names. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.", "items": {"type": "string"}, "example": ["P1", "P2", "P3"]}, "pd_advance_used": {"type": "boolean", "description": "If true, only incidents where PD Advance was used will be included in the results, and vice versa. If omitted, all incidents will be included.", "example": true}}}, "time_zone": {"type": "string", "description": "The time zone to use for the results and grouping. Must be in tzdata format. See list of accepted values [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).", "example": "Etc/UTC"}, "order": {"type": "string", "description": "The order in which the results were sorted; asc for ascending, desc for descending.", "enum": ["asc", "desc"]}, "order_by": {"type": "string", "description": "The column that was used for ordering the results.", "example": "created_at"}, "aggregate_unit": {"type": "string", "description": "The time unit to aggregate metrics by.  If no value is provided, the metrics will be aggregated for the entire period.", "nullable": true, "example": "day", "enum": ["day", "week", "month"]}}}',  # noqa: E501
    "GETANALYTICSMETRICSFORALLTEAMS": '{"type": "object", "properties": {"filters": {"type": "object", "description": "Accepts a set of filters to apply to the Incidents before aggregating.  Any incidents that do not match the included filters will be omitted from the results.", "properties": {"created_at_start": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any incidents with a created_at less than this value will be omitted from the results. The maximum supported time range in conjunction with created_at_end is one year.", "example": "2024-01-01T00:00:00+05:00"}, "created_at_end": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any incidents with a created_at greater than or equal to this value will be omitted from the results. The maximum supported time range in conjunction with created_at_start is one year.", "example": "2024-02-01T00:00:00Z"}, "urgency": {"type": "string", "description": "Any incidents whose urgency does not match the provided string will be omitted from the results.", "example": "high", "enum": ["high", "low"]}, "major": {"type": "boolean", "description": "A boolean flag including whether results should contain *only* [major incidents](https://support.pagerduty.com/docs/operational-reviews#major-incidents), or exclude major incidents. If no value is provided all incidents will be included.", "example": true}, "min_ackowledgements": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of acknowledgements to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 acknowledgement. If no value is provided, all incidents will be included.", "example": 1}, "min_timeout_escalations": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of timeout escalations to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 timeout escalation. If no value is provided, all incidents will be included.", "example": 1}, "min_manual_escalations": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of manual escalations to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 manual escalation. If no value is provided, all incidents will be included.", "example": 1}, "team_ids": {"type": "array", "description": "An array of team IDs. Only incidents related to these teams will be included in the results. If omitted, all teams the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["P373JQQ", "PAECHJV", "P7SYGW6"]}, "service_ids": {"type": "array", "description": "An array of service IDs. Only incidents related to these services will be included in the results. If omitted, all services the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["PSEJLIN", "PSLWBL8", "PT4KHLX"]}, "escalation_policy_ids": {"type": "array", "description": "An array of escalation policy IDs. Only incidents related to these escalation policies will be included in the results. If omitted, all escalation policies the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["PDJXDF3", "PG4EHNS"]}, "priority_ids": {"type": "array", "description": "An array of priority IDs. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.", "items": {"type": "string"}, "example": ["PC8O0L3", "PX01HJD", "P5FK83M"]}, "priority_names": {"type": "array", "description": "An array of user-defined priority names. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.", "items": {"type": "string"}, "example": ["P1", "P2", "P3"]}, "pd_advance_used": {"type": "boolean", "description": "If true, only incidents where PD Advance was used will be included in the results, and vice versa. If omitted, all incidents will be included.", "example": true}}}, "time_zone": {"type": "string", "description": "The time zone to use for the results and grouping. Must be in tzdata format. See list of accepted values [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).", "example": "Etc/UTC"}, "order": {"type": "string", "description": "The order in which the results were sorted; asc for ascending, desc for descending.", "enum": ["asc", "desc"]}, "order_by": {"type": "string", "description": "The column that was used for ordering the results.", "example": "created_at"}, "aggregate_unit": {"type": "string", "description": "The time unit to aggregate metrics by.  If no value is provided, the metrics will be aggregated for the entire period.", "nullable": true, "example": "day", "enum": ["day", "week", "month"]}}}',  # noqa: E501
    "GETANALYTICSMETRICSPDADVANCEUSAGE": '{"type": "object", "properties": {"filters": {"type": "object", "description": "Accepts a set of filters to apply to the Incidents before aggregating.  Any incidents that do not match the included filters will be omitted from the results.", "properties": {"created_at_start": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any PD Advance usage with a created_at less than this value will be omitted from the results. The maximum supported time range in conjunction with created_at_end is one year.", "example": "2024-01-01T00:00:00+05:00"}, "created_at_end": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any PD Advance usage with a created_at greater than or equal to this value will be omitted from the results. The maximum supported time range in conjunction with created_at_start is one year.", "example": "2024-02-01T00:00:00Z"}, "incident_created_at_start": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any incidents with a created_at less than this value will be omitted from the results. The maximum supported time range in conjunction with incident_created_at_end is one year.", "example": "2024-01-01T00:00:00+05:00"}, "incident_created_at_end": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any incidents with a created_at greater than or equal to this value will be omitted from the results. The maximum supported time range in conjunction with incident_created_at_start is one year.", "example": "2024-02-01T00:00:00Z"}, "urgency": {"type": "string", "description": "Any incidents whose urgency does not match the provided string will be omitted from the results.", "example": "high", "enum": ["high", "low"]}, "major": {"type": "boolean", "description": "A boolean flag including whether results should contain *only* [major incidents](https://support.pagerduty.com/docs/operational-reviews#major-incidents), or exclude major incidents. If no value is provided all incidents will be included.", "example": true}, "min_ackowledgements": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of acknowledgements to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 acknowledgement. If no value is provided, all incidents will be included.", "example": 1}, "min_timeout_escalations": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of timeout escalations to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 timeout escalation. If no value is provided, all incidents will be included.", "example": 1}, "min_manual_escalations": {"type": "integer", "description": "An integer that sets the requirement for the minimum number of manual escalations to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 manual escalation. If no value is provided, all incidents will be included.", "example": 1}, "team_ids": {"type": "array", "description": "An array of team IDs. Only incidents related to these teams will be included in the results. If omitted, all teams the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["P373JQQ", "PAECHJV", "P7SYGW6"]}, "service_ids": {"type": "array", "description": "An array of service IDs. Only incidents related to these services will be included in the results. If omitted, all services the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["PSEJLIN", "PSLWBL8", "PT4KHLX"]}, "escalation_policy_ids": {"type": "array", "description": "An array of escalation policy IDs. Only incidents related to these escalation policies will be included in the results. If omitted, all escalation policies the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["PDJXDF3", "PG4EHNS"]}, "priority_ids": {"type": "array", "description": "An array of priority IDs. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.", "items": {"type": "string"}, "example": ["PC8O0L3", "PX01HJD", "P5FK83M"]}, "priority_names": {"type": "array", "description": "An array of user-defined priority names. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.", "items": {"type": "string"}, "example": ["P1", "P2", "P3"]}}}, "time_zone": {"type": "string", "description": "The time zone to use for the results and grouping. Must be in tzdata format. See list of accepted values [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).", "example": "Etc/UTC"}}}',  # noqa: E501
    "RETRIEVEANALYTICSDATA": '{"type": "object", "properties": {"filters": {"type": "object", "description": "Accepts a set of filters to apply to the Incidents before aggregating.  Any incidents that do not match the included filters will be omitted from the results", "properties": {"date_range_start": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any incidents with a created_at less than this value will be omitted from the results. The maximum supported time range in conjunction with date_range_end is one year.", "example": "2023-10-01T00:00:00+05:00"}, "date_range_end": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any incidents with a created_at greater than or equal to this value will be omitted from the results. The maximum supported time range in conjunction with date_range_start is one year.", "example": "2023-10-01T00:00:00Z"}, "urgency": {"type": "string", "description": "Any incidents whose urgency does not match the provided string will be omitted from the results.", "example": "high", "enum": ["high", "low"]}, "team_ids": {"type": "array", "description": "An array of team IDs. Only incidents related to these teams will be included in the results. If omitted, all teams the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["P373JQQ", "PAECHJV", "P7SYGW6"]}, "responder_ids": {"type": "array", "description": "An array of responder IDs. Only incidents related to these responders will be included in the results. If omitted, all responders the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["PDJXDF3", "PG4EHNS"]}, "priority_ids": {"type": "array", "description": "An array of priority IDs. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.", "items": {"type": "string"}, "example": ["PC8O0L3", "PX01HJD", "P5FK83M"]}, "priority_names": {"type": "array", "description": "An array of user-defined priority names. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.", "items": {"type": "string"}, "example": ["P1", "P2", "P3"]}}}, "time_zone": {"type": "string", "description": "The time zone to use for the results and grouping.", "example": "Etc/UTC"}, "order": {"type": "string", "description": "The order in which the results were sorted; asc for ascending, desc for descending.", "enum": ["asc", "desc"]}, "order_by": {"type": "string", "description": "The column that was used for ordering the results.", "example": "user_id"}}}',  # noqa: E501
    "FETCHRESPONDERTEAMMETRICS": '{"type": "object", "properties": {"filters": {"type": "object", "description": "Accepts a set of filters to apply to the Incidents before aggregating.  Any incidents that do not match the included filters will be omitted from the results", "properties": {"date_range_start": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any incidents with a created_at less than this value will be omitted from the results. The maximum supported time range in conjunction with date_range_end is one year.", "example": "2023-10-01T00:00:00+05:00"}, "date_range_end": {"type": "string", "description": "Accepts an ISO8601 DateTime string. Any incidents with a created_at greater than or equal to this value will be omitted from the results. The maximum supported time range in conjunction with date_range_start is one year.", "example": "2023-10-01T00:00:00Z"}, "urgency": {"type": "string", "description": "Any incidents whose urgency does not match the provided string will be omitted from the results.", "example": "high", "enum": ["high", "low"]}, "team_ids": {"type": "array", "description": "An array of team IDs. Only incidents related to these teams will be included in the results. If omitted, all teams the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["P373JQQ", "PAECHJV", "P7SYGW6"]}, "responder_ids": {"type": "array", "description": "An array of responder IDs. Only incidents related to these responders will be included in the results. If omitted, all responders the requestor has access to will be included in the results.", "items": {"type": "string"}, "example": ["PDJXDF3", "PG4EHNS"]}, "priority_ids": {"type": "array", "description": "An array of priority IDs. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.", "items": {"type": "string"}, "example": ["PC8O0L3", "PX01HJD", "P5FK83M"]}, "priority_names": {"type": "array", "description": "An array of user-defined priority names. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.", "items": {"type": "string"}, "example": ["P1", "P2", "P3"]}}}, "time_zone": {"type": "string", "description": "The time zone to use for the results and grouping.", "example": "Etc/UTC"}, "order": {"type": "string", "description": "The order in which the results were sorted; asc for ascending, desc for descending.", "enum": ["asc", "desc"]}, "order_by": {"type": "string", "description": "The column that was used for ordering the results.", "example": "user_id"}}}',  # noqa: E501
    "GETINCIDENTANALYTICS": '{"type": "object", "properties": {"filters": {"type": "object", "description": "Filters the result, only show incidents that match the conditions passed in the filter.", "properties": {"created_at_start": {"type": "string", "description": "Filters the result, showing only the incidents where the creation timestamp is greater than or equal to the filter value.", "example": "2023-05-01T00:00:00-04:00"}, "created_at_end": {"type": "string", "description": "Filters the result, showing only the incidents where the creation timestamp is less than the filter value.", "example": "2023-06-01T00:00:00-04:00"}, "updated_after": {"type": "string", "description": "Filters the result, showing only incidents where the updated_at value is greater than the filter value."}, "urgency": {"type": "string", "description": "Filters the result, showing only the incidents where urgency matches the filter value.", "example": "high"}, "major": {"type": "boolean", "description": "An incident is classified as a [major incident](https://support.pagerduty.com/docs/operational-reviews#major-incidents) if it has one of the two highest priorities, or if multiple responders are added and acknowledge the incident.", "example": true}, "team_ids": {"type": "array", "description": "An array of team IDs. Only incidents that are assigned to a member of these teams will be returned. Account must have the teams ability to use this parameter.", "items": {"type": "string"}, "example": ["P373JQQ", "PAECHJV", "P7SYGW6"]}, "service_ids": {"type": "array", "description": "An array of service IDs. Only results related to these services will be returned.", "items": {"type": "string"}, "example": ["PC8O0L3", "PX01HJD", "P5FK83M"]}, "priority_ids": {"type": "array", "description": "The priority_ids filter applied to the results.", "items": {"type": "string"}, "example": ["PITMC5Y", "PEHBBT8", "PB8QADI"]}, "priority_names": {"type": "array", "description": "The priority_names filter applied to the results.", "items": {"type": "string"}, "example": ["P1", "P2", "P3"]}, "incident_type_ids": {"type": "array", "description": "Filter incidents by specific incident type IDs. Only incidents matching the given IDs will be returned.", "items": {"type": "string"}, "example": ["PIJ90N7", "PKL73Z2"]}}}, "starting_after": {"type": "string", "description": "A cursor to indicate the reference point that the results should follow"}, "ending_before": {"type": "string", "description": "A cursor to indicate the reference point that the results should precede"}, "order": {"type": "string", "description": "The order the results;  asc for ascending, desc for descending. Defaults to \'desc\'.", "enum": ["asc", "desc"]}, "order_by": {"type": "string", "description": "The column to use for ordering the results. Defaults to \'created_at\'.", "enum": ["created_at", "seconds_to_resolve"]}, "limit": {"type": "integer", "description": "Number of results to include in each batch.\nLimits between 1 to 1000 are accepted.", "example": 20, "minimum": 0, "exclusiveMinimum": true, "maximum": 1000, "exclusiveMaximum": false}, "time_zone": {"type": "string", "description": "The time zone to use for the results.", "example": "Etc/UTC"}}}',  # noqa: E501
    "GETRESPONDERINCIDENTANALYTICS": '{"type": "object", "properties": {"filters": {"type": "object", "description": "Filters the result, only show incidents that match the conditions passed in the filter.", "properties": {"created_at_start": {"type": "string", "description": "Filters the result, showing only the incidents where the creation timestamp is greater than the filter value.", "example": "2023-05-01T00:00:00-04:00"}, "created_at_end": {"type": "string", "description": "Filters the result, showing only the incidents where the creation timestamp is less than the filter value.", "example": "2023-06-01T00:00:00-04:00"}, "urgency": {"type": "string", "description": "Filters the result, showing only the incidents where urgency matches the filter value.", "example": "high"}, "major": {"type": "boolean", "description": "An incident is classified as a [major incident](https://support.pagerduty.com/docs/operational-reviews#major-incidents) if it has one of the two highest priorities, or if multiple responders are added and acknowledge the incident.", "example": true}, "team_ids": {"type": "array", "description": "An array of team IDs. Only incidents that are assigned to a member of these teams will be returned. Account must have the teams ability to use this parameter.", "items": {"type": "string"}, "example": ["P373JQQ", "PAECHJV", "P7SYGW6"]}, "service_ids": {"type": "array", "description": "An array of service IDs. Only results related to these services will be returned.", "items": {"type": "string"}, "example": ["PC8O0L3", "PX01HJD", "P5FK83M"]}, "priority_ids": {"type": "array", "description": "The priority_ids filter applied to the results.", "items": {"type": "string"}, "example": ["PITMC5Y", "PEHBBT8", "PB8QADI"]}, "priority_names": {"type": "array", "description": "The priority_names filter applied to the results.", "items": {"type": "string"}, "example": ["P1", "P2", "P3"]}, "incident_type_ids": {"type": "array", "description": "Filter incidents by specific incident type IDs. Only incidents matching the given IDs will be returned.", "items": {"type": "string"}, "example": ["PIJ90N7", "PKL73Z2"]}}}, "starting_after": {"type": "string", "description": "A cursor to indicate the reference point that the results should follow"}, "ending_before": {"type": "string", "description": "A cursor to indicate the reference point that the results should precede"}, "order": {"type": "string", "description": "The order in which to display the results; asc for ascending, desc for descending. Defaults to `desc`.", "enum": ["asc", "desc"]}, "order_by": {"type": "string", "description": "The column to use for ordering the results. Defaults to `incident_created_at`.", "enum": ["incident_created_at"]}, "limit": {"type": "integer", "description": "Number of results to include in each batch.\nLimits between 1 to 1000 are accepted.", "example": 20, "minimum": 0, "exclusiveMinimum": true, "maximum": 1000, "exclusiveMaximum": false}, "time_zone": {"type": "string", "description": "The time zone to use for the results.", "example": "Etc/UTC"}}}',  # noqa: E501
    "CREATEAUTOMATIONACTION": '{"type": "object", "properties": {"action": {"oneOf": [{"allOf": [{"type": "object", "properties": {"name": {"type": "string", "example": "Restart apache", "maxLength": 255}, "description": {"type": "string", "example": "Restarts apache on the us-west-2-shopping-cart host", "maxLength": 1024}, "action_classification": {"type": "string", "enum": ["diagnostic", "remediation"], "nullable": true}, "action_type": {"type": "string", "enum": ["script", "process_automation"], "example": "process_automation"}, "runner": {"type": "string", "example": "1a6763bd-b1ad-458f-a347-6c8a9bea2d70", "maxLength": 36}, "services": {"nullable": false, "type": "array", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["service_reference"]}}}]}}, "teams": {"nullable": false, "type": "array", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["team_reference"]}}}]}}, "only_invocable_on_unresolved_incidents": {"type": "boolean", "description": "If true, the action can only be invoked against an unresolved incident.", "default": false, "example": false}, "allow_invocation_manually": {"type": "boolean", "description": "If true, the action can only be invoked manually by a user.", "default": true, "example": true}, "allow_invocation_from_event_orchestration": {"type": "boolean", "description": "If true, the action can only be invoked automatically by an Event Orchestration.", "default": true, "example": true}, "map_to_all_services": {"type": "boolean", "description": "If true, the action will be associated with every service.", "default": false, "example": false}}, "required": ["name", "description", "action_type"]}, {"type": "object", "properties": {"action_data_reference": {"type": "object", "properties": {"script": {"type": "string", "description": "Body of the script to be executed on the Runner. To execute it, the Runner will write the content of the property into a temp file, make the file executable and execute it. It is assumed that the Runner has a properly configured environment to run the script as an executable file. This behaviour can be altered by providing the `invocation_command` property. The maxLength value is specified in bytes.", "example": "print("Hello from a Python script!")", "maxLength": 16777215}, "invocation_command": {"type": "string", "description": "The command to executed a script with. With the body of the script written into a temp file, the Runner will execute the `<invocation_command> <temp_file>` command. The maxLength value is specified in bytes.", "example": "/usr/local/bin/python3", "maxLength": 65535}}, "required": ["script"]}}, "required": ["action_data_reference"]}]}, {"allOf": [{"type": "object", "properties": {"name": {"type": "string", "example": "Restart apache", "maxLength": 255}, "description": {"type": "string", "example": "Restarts apache on the us-west-2-shopping-cart host", "maxLength": 1024}, "action_classification": {"type": "string", "enum": ["diagnostic", "remediation"], "nullable": true}, "action_type": {"type": "string", "enum": ["script", "process_automation"], "example": "process_automation"}, "runner": {"type": "string", "example": "1a6763bd-b1ad-458f-a347-6c8a9bea2d70", "maxLength": 36}, "services": {"nullable": false, "type": "array", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["service_reference"]}}}]}}, "teams": {"nullable": false, "type": "array", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["team_reference"]}}}]}}, "only_invocable_on_unresolved_incidents": {"type": "boolean", "description": "If true, the action can only be invoked against an unresolved incident.", "default": false, "example": false}, "allow_invocation_manually": {"type": "boolean", "description": "If true, the action can only be invoked manually by a user.", "default": true, "example": true}, "allow_invocation_from_event_orchestration": {"type": "boolean", "description": "If true, the action can only be invoked automatically by an Event Orchestration.", "default": true, "example": true}, "map_to_all_services": {"type": "boolean", "description": "If true, the action will be associated with every service.", "default": false, "example": false}}, "required": ["name", "description", "action_type"]}, {"type": "object", "properties": {"action_data_reference": {"type": "object", "properties": {"process_automation_job_id": {"type": "string", "example": "79c199bba1aff6e519f198457f5ec0fc", "maxLength": 36}, "process_automation_job_arguments": {"type": "string", "description": "Arguments to pass to the Process Automation job. The maxLength value is specified in bytes.", "example": "-env production", "maxLength": 1024}, "process_automation_node_filter": {"type": "string", "description": "Node filter for the Process Automation job. The maxLength value is specified in bytes. Filter syntax: https://docs.rundeck.com/docs/manual/11-node-filters.html#node-filter-syntax", "example": "mynode1 !nodename: mynode2", "maxLength": 1024}}, "required": ["process_automation_job_id"]}}, "required": ["action_data_reference"]}]}], "discriminator": {"propertyName": "action_type", "mapping": {"script": "#/components/schemas/AutomationActionsScriptActionPostBody", "process_automation": "#/components/schemas/AutomationActionsProcessAutomationJobActionPostBody"}}}}, "required": ["action"]}',  # noqa: E501
    "UPDATEAUTOMATIONACTION": '{"type": "object", "properties": {"action": {"oneOf": [{"allOf": [{"type": "object", "properties": {"name": {"type": "string", "example": "Restart apache", "maxLength": 255}, "description": {"type": "string", "example": "Restarts apache on the us-west-2-shopping-cart host", "maxLength": 1024}, "action_classification": {"type": "string", "enum": ["diagnostic", "remediation"], "nullable": true}, "action_type": {"type": "string", "enum": ["script", "process_automation"], "example": "process_automation"}, "runner": {"type": "string", "maxLength": 36}, "only_invocable_on_unresolved_incidents": {"type": "boolean", "description": "If true, the action can only be invoked against an unresolved incident.", "default": false, "example": false}, "allow_invocation_manually": {"type": "boolean", "description": "If true, the action can only be invoked manually by a user.", "default": true, "example": true}, "allow_invocation_from_event_orchestration": {"type": "boolean", "description": "If true, the action can only be invoked automatically by an Event Orchestration.", "default": true, "example": true}, "map_to_all_services": {"type": "boolean", "description": "If true, the action will be associated with every service.", "default": false, "example": false}}}, {"type": "object", "properties": {"action_data_reference": {"type": "object", "properties": {"script": {"type": "string", "description": "Body of the script to be executed on the Runner. To execute it, the Runner will write the content of the property into a temp file, make the file executable and execute it. It is assumed that the Runner has a properly configured environment to run the script as an executable file. This behaviour can be altered by providing the `invocation_command` property. The maxLength value is specified in bytes.", "example": "print("Hello from a Python script!")", "maxLength": 16777215}, "invocation_command": {"type": "string", "description": "The command to executed a script with. With the body of the script written into a temp file, the Runner will execute the `<invocation_command> <temp_file>` command. The maxLength value is specified in bytes.", "example": "/usr/local/bin/python3", "maxLength": 65535}}, "required": ["script"]}}}]}, {"allOf": [{"type": "object", "properties": {"name": {"type": "string", "example": "Restart apache", "maxLength": 255}, "description": {"type": "string", "example": "Restarts apache on the us-west-2-shopping-cart host", "maxLength": 1024}, "action_classification": {"type": "string", "enum": ["diagnostic", "remediation"], "nullable": true}, "action_type": {"type": "string", "enum": ["script", "process_automation"], "example": "process_automation"}, "runner": {"type": "string", "maxLength": 36}, "only_invocable_on_unresolved_incidents": {"type": "boolean", "description": "If true, the action can only be invoked against an unresolved incident.", "default": false, "example": false}, "allow_invocation_manually": {"type": "boolean", "description": "If true, the action can only be invoked manually by a user.", "default": true, "example": true}, "allow_invocation_from_event_orchestration": {"type": "boolean", "description": "If true, the action can only be invoked automatically by an Event Orchestration.", "default": true, "example": true}, "map_to_all_services": {"type": "boolean", "description": "If true, the action will be associated with every service.", "default": false, "example": false}}}, {"type": "object", "properties": {"action_data_reference": {"type": "object", "properties": {"process_automation_job_id": {"type": "string", "example": "79c199bba1aff6e519f198457f5ec0fc", "maxLength": 36}, "process_automation_job_arguments": {"type": "string", "description": "Arguments to pass to the Process Automation job. The maxLength value is specified in bytes.", "example": "-env production", "maxLength": 1024}, "process_automation_node_filter": {"type": "string", "description": "Node filter for the Process Automation job. The maxLength value is specified in bytes. Filter syntax: https://docs.rundeck.com/docs/manual/11-node-filters.html#node-filter-syntax", "example": "mynode1 !nodename: mynode2", "maxLength": 1024}}, "required": ["process_automation_job_id"]}}}]}], "discriminator": {"propertyName": "action_type", "mapping": {"script": "#/components/schemas/AutomationActionsScriptActionPutBody", "process_automation": "#/components/schemas/AutomationActionsProcessAutomationJobActionPutBody"}}}}, "required": ["action"]}',  # noqa: E501
    "ASSOCIATEAUTOMATIONACTIONWITHSERVICE": '{"type": "object", "properties": {"service": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["service_reference"]}}}]}}, "required": ["service"]}',  # noqa: E501
    "ASSOCIATEAUTOMATIONACTIONWITHTEAM": '{"type": "object", "properties": {"team": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["team_reference"]}}}]}}, "required": ["team"]}',  # noqa: E501
    "CREATEAUTOMATIONRUNNER": '{"type": "object", "properties": {"runner": {"oneOf": [{"type": "object", "title": "RunnerSidecarPostBody", "properties": {"runner_type": {"description": "sidecar -- The runner is backed by an external sidecar that polls for invocations.\nrunbook -- The runner communicates directly with a runbook instance.\n", "type": "string", "enum": ["sidecar", "runbook"], "example": "runbook"}, "name": {"type": "string", "maxLength": 255, "example": "us-west-2 prod runner"}, "description": {"type": "string", "maxLength": 1024, "example": "us-west-2 runner provisioned in the production environment by the SRE team"}, "teams": {"type": "array", "description": "The list of teams associated with the Runner", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["team_reference"]}}}]}}}, "required": ["runner_type", "name", "description"]}, {"type": "object", "title": "RunnerRunbookPostBody", "properties": {"runner_type": {"description": "sidecar -- The runner is backed by an external sidecar that polls for invocations.\nrunbook -- The runner communicates directly with a runbook instance.\n", "type": "string", "enum": ["sidecar", "runbook"], "example": "runbook"}, "name": {"type": "string", "maxLength": 255, "example": "us-west-2 prod runner"}, "description": {"type": "string", "maxLength": 1024, "example": "us-west-2 runner provisioned in the production environment by the SRE team"}, "runbook_base_uri": {"type": "string", "description": "The base URI of the Runbook server to connect to. May only contain alphanumeric characters, periods, underscores and dashes. Specified as the subdomain portion of an RBA host, as in <runbook_base_uri>.runbook.pagerduty.cloud", "maxLength": 255, "example": "subdomain"}, "runbook_api_key": {"type": "string", "maxLength": 64, "description": "The API key to connect to the Runbook server with. If omitted, the previously stored value will remain unchanged"}, "teams": {"type": "array", "description": "The list of teams associated with the Runner", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["team_reference"]}}}]}}}, "required": ["runner_type", "name", "description", "runbook_base_uri", "runbook_api_key"]}], "discriminator": {"propertyName": "runner_type"}}}, "required": ["runner"]}',  # noqa: E501
    "UPDATEAUTOMATIONACTIONRUNNER": '{"type": "object", "properties": {"runner": {"oneOf": [{"type": "object", "title": "RunnerSidecarBody", "properties": {"name": {"type": "string", "maxLength": 255, "example": "us-west-2 prod runner"}, "description": {"type": "string", "maxLength": 1024, "example": "us-west-2 runner provisioned in the production environment by the SRE team"}}}, {"type": "object", "title": "RunnerRunbookBody", "properties": {"name": {"type": "string", "maxLength": 255, "example": "us-west-2 prod runner"}, "description": {"type": "string", "maxLength": 1024, "example": "us-west-2 runner provisioned in the production environment by the SRE team"}, "runbook_base_uri": {"type": "string", "description": "The base URI of the Runbook server to connect to. May only contain alphanumeric characters, periods, underscores and dashes. Specified as the subdomain portion of an RBA host, as in <runbook_base_uri>.runbook.pagerduty.cloud", "maxLength": 255, "example": "subdomain"}, "runbook_api_key": {"type": "string", "maxLength": 64, "description": "The API key to connect to the Runbook server with. If omitted, the previously stored value will remain unchanged"}}}], "discriminator": {"propertyName": "runner_type"}}}, "required": ["runner"]}',  # noqa: E501
    "ASSOCIATERUNNERWITHTEAM": '{"type": "object", "properties": {"team": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["team_reference"]}}}]}}, "required": ["team"]}',  # noqa: E501
    "SUBSCRIBEBUSINESSSERVICEENTITIES": '{"type": "object", "properties": {"subscribers": {"type": "array", "uniqueItems": true, "minItems": 1, "items": {"title": "NotificationSubscriber", "description": "A reference of a subscriber entity.", "type": "object", "properties": {"subscriber_id": {"type": "string", "description": "The ID of the entity being subscribed"}, "subscriber_type": {"type": "string", "description": "The type of the entity being subscribed", "enum": ["user", "team"]}}, "example": {"subscriber_id": "PD1234", "subscriber_type": "user"}}}}, "required": ["subscribers"]}',  # noqa: E501
    "UNSUBSCRIBEBUSINESSSERVICENOTIFICATIONS": '{"type": "object", "properties": {"subscribers": {"type": "array", "uniqueItems": true, "minItems": 1, "items": {"title": "NotificationSubscriber", "description": "A reference of a subscriber entity.", "type": "object", "properties": {"subscriber_id": {"type": "string", "description": "The ID of the entity being subscribed"}, "subscriber_type": {"type": "string", "description": "The type of the entity being subscribed", "enum": ["user", "team"]}}, "example": {"subscriber_id": "PD1234", "subscriber_type": "user"}}}}, "required": ["subscribers"]}',  # noqa: E501
    "SETBUSINESSSERVICEPRIORITY": '{"description": "", "type": "object", "properties": {"global_threshold": {"type": "object", "properties": {"id": {"type": "string", "minLength": 1}, "order": {"type": "number"}}, "required": ["id", "order"]}}, "required": ["global_threshold"]}',  # noqa: E501
    "UPDATECHANGEEVENT": '{"type": "object", "properties": {"change_event": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"timestamp": {"type": "string", "format": "date-time", "readOnly": true, "description": "The time at which the emitting tool detected or generated the event."}, "type": {"type": "string", "readOnly": true, "default": "change_event", "description": "The type of object being created.", "enum": ["change_event"]}, "services": {"type": "array", "readOnly": true, "description": "An array containing Service objects that this change event is associated with.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["service_reference"]}}}]}}, "integration": {"allOf": [{"readOnly": true}, {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["aws_cloudwatch_inbound_integration_reference", "cloudkick_inbound_integration_reference", "event_transformer_api_inbound_integration_reference", "generic_email_inbound_integration_reference", "generic_events_api_inbound_integration_reference", "keynote_inbound_integration_reference", "nagios_inbound_integration_reference", "pingdom_inbound_integration_reference", "sql_monitor_inbound_integration_reference", "events_api_v2_inbound_integration_reference", "inbound_integration_reference"]}}}]}]}, "routing_key": {"readOnly": true, "title": "Routing Key", "description": "This is the 32 character Integration Key for an Integration on a Service. The same Integration Key can be used for both alert and change events.", "type": "string"}, "summary": {"type": "string", "description": "A brief text summary of the event. Displayed in PagerDuty to provide information about the change. The maximum permitted length of this property is 1024 characters."}, "source": {"type": "string", "readOnly": true, "description": "The unique name of the location where the Change Event occurred."}, "links": {"type": "array", "readOnly": true, "description": "List of links to include.", "items": {"type": "object", "properties": {"href": {"type": "string"}, "text": {"type": "string"}}}}, "images": {"type": "array", "readOnly": true, "items": {"type": "object", "properties": {"src": {"type": "string"}, "href": {"type": "string"}, "alt": {"type": "string"}}}}, "custom_details": {"type": "object", "description": "Additional details about the change event.", "title": "Custom Details"}}, "example": {"summary": "Build Success - Increase snapshot create timeout to 30 seconds", "timestamp": "2020-07-17T08:42:58Z", "type": "change_event", "source": "acme-build-pipeline-tool-default-i-9999", "integration": {"id": "PEYSGVF", "type": "inbound_integration_reference"}, "services": [{"id": "PEYSGRV", "type": "service_reference"}], "custom_details": {"build_state": "passed", "build_number": "2", "run_time": "1236s"}, "links": [{"href": "https://acme.pagerduty.dev/build/2", "text": "View more details in Acme!"}]}}]}}, "required": ["change_event"]}',  # noqa: E501
    "CREATEESCALATIONPOLICY": '{"type": "object", "properties": {"escalation_policy": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "description": "The type of object being created.", "default": "escalation_policy", "enum": ["escalation_policy"]}, "name": {"type": "string", "description": "The name of the escalation policy."}, "description": {"type": "string", "description": "Escalation policy description."}, "num_loops": {"type": "integer", "description": "The number of times the escalation policy will repeat after reaching the end of its escalation.", "default": 0, "minimum": 0}, "on_call_handoff_notifications": {"type": "string", "description": "Determines how on call handoff notifications will be sent for users on the escalation policy. Defaults to "if_has_services".", "enum": ["if_has_services", "always"]}, "escalation_rules": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "escalation_delay_in_minutes": {"type": "integer", "description": "The number of minutes before an unacknowledged incident escalates away from this rule."}, "targets": {"type": "array", "minItems": 1, "maxItems": 10, "description": "The targets an incident should be assigned to upon reaching this rule.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "description": "The escalation target is the entity that will be assigned an incident upon escalation.", "properties": {"type": {"enum": ["user", "schedule", "user_reference", "schedule_reference"], "type": "string"}}}]}}, "escalation_rule_assignment_strategy": {"type": "string", "description": "The strategy used to assign the escalation rule to an incident.", "enum": ["round_robin", "assign_to_everyone"]}}, "required": ["escalation_delay_in_minutes", "targets"], "example": {"escalation_delay_in_minutes": 30, "targets": [{"id": "PAM4FGS", "type": "user_reference"}, {"id": "PI7DH85", "type": "schedule_reference"}]}}}, "services": {"type": "array", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["service_reference"]}}}]}, "minLength": 0, "readOnly": true}, "teams": {"type": "array", "description": "Team associated with the policy. Account must have the `teams` ability to use this parameter. Only one team may be associated with the policy.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["team_reference"]}}}]}, "minLength": 0}}, "required": ["type", "name", "escalation_rules"], "example": {"id": "PQIL2IX", "type": "escalation_policy", "name": "Engineering Escalation Policy", "escalation_rules": [{"escalation_delay_in_minutes": 30, "targets": [{"id": "PEYSGVF", "type": "user_reference"}], "escalation_rule_assignment_strategy": [{"type": "round_robin"}]}], "services": [{"id": "PIJ90N7", "type": "service_reference"}], "num_loops": 2, "on_call_handoff_notifications": "if_has_services", "teams": [{"id": "PQ9K7I8", "type": "team_reference"}], "description": "Here is the ep for the engineering team."}}]}}, "required": ["escalation_policy"]}',  # noqa: E501
    "UPDATEESCALATIONPOLICY": '{"type": "object", "properties": {"escalation_policy": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "description": "The type of object being created.", "default": "escalation_policy", "enum": ["escalation_policy"]}, "name": {"type": "string", "description": "The name of the escalation policy."}, "description": {"type": "string", "description": "Escalation policy description."}, "num_loops": {"type": "integer", "description": "The number of times the escalation policy will repeat after reaching the end of its escalation.", "default": 0, "minimum": 0}, "on_call_handoff_notifications": {"type": "string", "description": "Determines how on call handoff notifications will be sent for users on the escalation policy. Defaults to "if_has_services".", "enum": ["if_has_services", "always"]}, "escalation_rules": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "escalation_delay_in_minutes": {"type": "integer", "description": "The number of minutes before an unacknowledged incident escalates away from this rule."}, "targets": {"type": "array", "minItems": 1, "maxItems": 10, "description": "The targets an incident should be assigned to upon reaching this rule.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "description": "The escalation target is the entity that will be assigned an incident upon escalation.", "properties": {"type": {"enum": ["user", "schedule", "user_reference", "schedule_reference"], "type": "string"}}}]}}, "escalation_rule_assignment_strategy": {"type": "string", "description": "The strategy used to assign the escalation rule to an incident.", "enum": ["round_robin", "assign_to_everyone"]}}, "required": ["escalation_delay_in_minutes", "targets"], "example": {"escalation_delay_in_minutes": 30, "targets": [{"id": "PAM4FGS", "type": "user_reference"}, {"id": "PI7DH85", "type": "schedule_reference"}]}}}, "services": {"type": "array", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["service_reference"]}}}]}, "minLength": 0, "readOnly": true}, "teams": {"type": "array", "description": "Team associated with the policy. Account must have the `teams` ability to use this parameter. Only one team may be associated with the policy.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["team_reference"]}}}]}, "minLength": 0}}, "required": ["type", "name", "escalation_rules"], "example": {"id": "PQIL2IX", "type": "escalation_policy", "name": "Engineering Escalation Policy", "escalation_rules": [{"escalation_delay_in_minutes": 30, "targets": [{"id": "PEYSGVF", "type": "user_reference"}], "escalation_rule_assignment_strategy": [{"type": "round_robin"}]}], "services": [{"id": "PIJ90N7", "type": "service_reference"}], "num_loops": 2, "on_call_handoff_notifications": "if_has_services", "teams": [{"id": "PQ9K7I8", "type": "team_reference"}], "description": "Here is the ep for the engineering team."}}]}}, "required": ["escalation_policy"]}',  # noqa: E501
    "CREATEGLOBALEVENTORCHESTRATION": '{"type": "object", "properties": {"orchestration": {"type": "object", "properties": {"id": {"type": "string", "description": "ID of the Orchestration.", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}, "name": {"type": "string", "description": "Name of the Orchestration."}, "description": {"type": "string", "description": "A description of this Orchestration\'s purpose."}, "team": {"type": "object", "description": "Reference to the team that owns the Orchestration. If none is specified, only admins have access.", "properties": {"id": {"type": "string"}, "type": {"type": "string", "description": "A string that determines the schema of the object", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}}, "integrations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "description": "ID of the Integration.", "readOnly": true}, "label": {"type": "string", "description": "Name of the Integration."}, "parameters": {"type": "object", "readOnly": true, "properties": {"routing_key": {"type": "string", "description": "Routing Key used to send Events to this Orchestration", "readOnly": true}, "type": {"type": "string", "default": "global", "readOnly": true}}}}}, "readOnly": true}, "routes": {"type": "integer", "description": "Number of different Service Orchestration being routed to", "readOnly": true}, "created_at": {"type": "string", "format": "date-time", "description": "The date the Orchestration was created at.", "readOnly": true}, "created_by": {"type": "object", "description": "Reference to the user that has created the Orchestration.", "properties": {"id": {"type": "string", "readOnly": true}, "type": {"type": "string", "description": "A string that determines the schema of the object", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}, "readOnly": true}, "updated_at": {"type": "string", "format": "date-time", "description": "The date the Orchestration was last updated.", "readOnly": true}, "updated_by": {"type": "object", "description": "Reference to the user that has updated the Orchestration last.", "properties": {"id": {"type": "string", "readOnly": true}, "type": {"type": "string", "description": "A string that determines the schema of the object", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}, "readOnly": true}, "version": {"type": "string", "description": "Version of the Orchestration.", "readOnly": true}}}}, "required": ["orchestration"]}',  # noqa: E501
    "UPDATEEVENTORCHESTRATION": '{"type": "object", "properties": {"orchestration": {"type": "object", "properties": {"id": {"type": "string", "description": "ID of the Orchestration.", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}, "name": {"type": "string", "description": "Name of the Orchestration."}, "description": {"type": "string", "description": "A description of this Orchestration\'s purpose."}, "team": {"type": "object", "description": "Reference to the team that owns the Orchestration. If none is specified, only admins have access.", "properties": {"id": {"type": "string"}, "type": {"type": "string", "description": "A string that determines the schema of the object", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}}, "integrations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "description": "ID of the Integration.", "readOnly": true}, "label": {"type": "string", "description": "Name of the Integration."}, "parameters": {"type": "object", "readOnly": true, "properties": {"routing_key": {"type": "string", "description": "Routing Key used to send Events to this Orchestration", "readOnly": true}, "type": {"type": "string", "default": "global", "readOnly": true}}}}}, "readOnly": true}, "routes": {"type": "integer", "description": "Number of different Service Orchestration being routed to", "readOnly": true}, "created_at": {"type": "string", "format": "date-time", "description": "The date the Orchestration was created at.", "readOnly": true}, "created_by": {"type": "object", "description": "Reference to the user that has created the Orchestration.", "properties": {"id": {"type": "string", "readOnly": true}, "type": {"type": "string", "description": "A string that determines the schema of the object", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}, "readOnly": true}, "updated_at": {"type": "string", "format": "date-time", "description": "The date the Orchestration was last updated.", "readOnly": true}, "updated_by": {"type": "object", "description": "Reference to the user that has updated the Orchestration last.", "properties": {"id": {"type": "string", "readOnly": true}, "type": {"type": "string", "description": "A string that determines the schema of the object", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}, "readOnly": true}, "version": {"type": "string", "description": "Version of the Orchestration.", "readOnly": true}}}}, "required": ["orchestration"]}',  # noqa: E501
    "CREATEEVENTINTEGRATION": '{"type": "object", "properties": {"integration": {"type": "object", "properties": {"label": {"type": "string", "description": "Name of the Integration."}}, "required": ["label"]}}, "required": ["integration"]}',  # noqa: E501
    "UPDATEEVENTINTEGRATION": '{"type": "object", "properties": {"integration": {"type": "object", "properties": {"label": {"type": "string", "description": "Name of the Integration."}}, "required": ["label"]}}, "required": ["integration"]}',  # noqa: E501
    "MIGRATEINTEGRATIONTOEVENTORCHESTRATION": '{"type": "object", "properties": {"source_id": {"type": "string", "description": "The ID of the Event Orchestration you\'ll be moving the Integration away from"}, "source_type": {"type": "string", "description": "The type of of the `source_id` object", "enum": ["orchestration"]}, "integration_id": {"type": "string", "description": "The ID of the Integration you\'ll be moving"}}, "required": ["source_id", "source_type", "integration_id"]}',  # noqa: E501
    "UPDATEEVENTORCHESTRATIONGLOBALRULES": '{"allOf": [{"type": "object", "properties": {"orchestration_path": {"type": "object", "properties": {"type": {"type": "string", "default": "service", "readOnly": true}, "parent": {"type": "object", "properties": {"id": {"type": "string", "description": "ID of the object these Orchestration Rules belongs to.", "readOnly": true}, "type": {"type": "string", "description": "A string that determines the schema of the parent object", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the parent object is accessible", "readOnly": true}}, "readOnly": true}, "sets": {"type": "array", "description": "Must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph of rules.", "items": {"type": "object", "description": "A set of rules", "properties": {"id": {"type": "string", "description": "The ID of this set of rules. Rules in other sets can route events into this set using the "route_to" properties.", "default": "start"}, "rules": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "description": "ID of the rule", "readOnly": true}, "label": {"type": "string", "description": "A description of this rule\'s purpose."}, "conditions": {"type": "array", "description": "Each of these conditions is evaluated to check if an event matches this rule. The rule is considered a match if **any** of these conditions match.", "items": {"type": "object", "properties": {"expression": {"type": "string", "description": "A PCL condition string", "example": "event.summary matches part \'my service error\'"}}}}, "actions": {"type": "object", "description": "When an event matches this rule, these are the actions that will be taken to change the resulting alert and incident."}, "disabled": {"type": "boolean", "description": "Indicates whether the rule is disabled and would therefore not be evaluated."}}}}}}}, "catch_all": {"type": "object", "description": "When none of the Rules in a set match an event, we apply the catch_all actions to the event.", "properties": {"actions": {"type": "object", "description": "These are the actions that will be taken to change the resulting alert and incident."}}}, "created_at": {"type": "string", "format": "date-time", "description": "The date/time the object was created.", "readOnly": true}, "created_by": {"type": "object", "description": "Reference to the user that created the object.", "properties": {"id": {"type": "string", "readOnly": true}, "type": {"type": "string", "description": "A 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.", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}, "readOnly": true}, "updated_at": {"type": "string", "format": "date-time", "description": "The date/time the object was last updated.", "readOnly": true}, "updated_by": {"type": "object", "description": "Reference to the user that last updated the object.", "properties": {"id": {"type": "string", "readOnly": true}, "type": {"type": "string", "description": "A 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.", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}, "readOnly": true}, "version": {"type": "string", "description": "Version of these Orchestration Rules", "readOnly": true}}}}, "required": ["orchestration_path"]}, {"type": "object", "properties": {"orchestration_path": {"properties": {"type": {"description": "Indicates that these are a set of "global" rules.", "default": "global"}, "parent": {"properties": {"id": {"description": "ID of the Global Event Orchestration these Global Rules belongs to."}, "type": {"enum": ["event_orchestration_reference"]}}}, "sets": {"description": "You must define at least a "start" set, but you can also define any number of additional sets that are routed to by other rules to form a directional graph.", "items": {"properties": {"rules": {"items": {"properties": {"actions": {"allOf": [{"properties": {"route_to": {"type": "string", "description": "The ID of a Set from this Global Orchestration whose rules you also want to use with event that match this rule."}}}, {"type": "object", "properties": {"suppress": {"type": "boolean", "description": "If true, the resulting alert is suppressed. Suppressed alerts will not trigger an incident."}, "suspend": {"type": "integer", "description": "The number of seconds to suspend the resulting alert before triggering. This effectively pauses incident notifications. If a resolve event arrives before the alert triggers then PagerDuty won\'t create an incident for this the resulting alert."}, "drop_event": {"type": "boolean", "description": "If true, this event will be dropped. Dropped events will not trigger or resolve an alert or an incident. Dropped events will not be evaluated against router rules."}}}, {"type": "object", "properties": {"priority": {"type": "string", "description": "The ID of the priority you want to set on resulting incident. You can find the list of priority IDs for your account by calling the priorities endpoint.", "example": "P53ZZH5"}, "escalation_policy": {"type": "string", "description": "The ID of the Escalation Policy you want to assign incidents to. Event rules with this action will override the Escalation Policy already set on a Service\'s settings, with what is configured by this action.", "example": "PQOMK4S"}, "annotate": {"type": "string", "description": "Add this text as a note on the resulting incident. AIOps users can additionally use the {{event}} variable to include elements of the event payload in the note."}}}, {"type": "object", "properties": {"severity": {"type": "string", "description": "Set the severity of the resulting alert.", "enum": ["info", "error", "warning", "critical"]}, "event_action": {"type": "string", "description": "Set whether the resulting alert status is trigger or resolve.", "enum": ["trigger", "resolve"]}, "variables": {"type": "array", "description": "Populate variables from event payloads and use those variables in other event actions.", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the variable", "example": "server_name"}, "path": {"type": "string", "description": "Path to a field in an event, in dot-notation.", "example": "event.summary"}, "type": {"type": "string", "description": "The type of operation to populate the variable. Currently only Regex-based variable extraction is supported.", "enum": ["regex"]}, "value": {"type": "string", "description": "A RE2 regular expression. If it contains one or more capture groups, their values will be extracted and appended together. If it contains no capture groups, the whole match is used.", "example": "High CPU on (.*) server"}}}}, "extractions": {"type": "array", "description": "Dynamically extract values to set and modify new and existing PD-CEF fields.", "items": {"anyOf": [{"type": "object", "description": "Use a template string & variables", "properties": {"target": {"type": "string", "description": "The PD-CEF field that will be set with the value from the template.", "example": "event.summary"}, "template": {"type": "string", "description": "A value that will be used to populate the target PD-CEF field. You can include variables extracted from the payload by using string interpolation.", "example": "High CPU on {{hostname}} server"}}}, {"type": "object", "description": "Use a regex to extract a value", "properties": {"target": {"type": "string", "description": "The PD-CEF field that will be set with the value from the regex.", "example": "event.custom_details.server"}, "regex": {"type": "string", "description": "A RE2 regular expression. If it contains one or more capture groups, their values will be extracted and appended together. If it contains no capture groups, the whole match is used.", "example": "High CPU on (.*) server"}, "source": {"type": "string", "description": "The path to the event field where the regex will be applied to extract a value.", "example": "event.summary"}}}]}}}}, {"type": "object", "properties": {"automation_actions": {"type": "array", "description": "Create a Webhoook associated with the resulting incident.", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the Webhook."}, "url": {"type": "string", "description": "The API endpoint where PagerDuty\'s servers will send the webhook request."}, "auto_send": {"type": "boolean", "description": "When true, PagerDuty\'s servers will automatically send this webhook request as soon as the resulting incident or alert is created. When false, your incident responder will be able to manually trigger the Webhook via the PagerDuty website & mobile app.", "default": false}, "headers": {"type": "array", "description": "Specify custom key/value pairs that\'ll be sent with the webhook request as request headers.", "items": {"type": "object", "properties": {"key": {"type": "string"}, "value": {"type": "string", "description": "AIOps users can additionally use the {{event}} variable to include elements of the event payload in the header value."}}}}, "trigger_types": {"type": "array", "description": "The Webhook will be associated (or automatically triggered, if `auto_send` is `true`) with the incident, whenever an alert reaches the specified state\n\nNote: `auto_send` must be `true` for trigger types of `alert_suppressed` and `alert_suspended`\n", "minItems": 1, "maxItems": 1, "uniqueItems": true, "items": {"type": "string", "enum": ["alert_triggered", "alert_suppressed", "alert_suspended"]}}, "parameters": {"type": "array", "description": "Specify custom key/value pairs that\'ll be included in the webhook request\'s JSON payload.", "items": {"type": "object", "properties": {"key": {"type": "string"}, "value": {"type": "string", "description": "AIOps users can additionally use the {{event}} variable to include elements of the event payload in the parameter value."}}}}}}}}}, {"type": "object", "properties": {"incident_custom_field_updates": {"type": "array", "description": "Configure custom field updates for the incident.", "items": {"type": "object", "properties": {"id": {"type": "string", "description": "Unique identifier for the custom field resource. You can find the list of IDs by calling the List Custom Fields endpoint.", "example": "PEXCK89"}, "value": {"type": "string", "description": "A value that will be used to populate the specified Incident Custom Field. AIOps users can additionally use the {{event}} variable to include elements of the event payload in the custom field value.", "example": "High CPU on server"}}}}}}]}}}}}}}, "catch_all": {"description": "When none of the rules match an event, the event will be routed according to the catch_all settings.", "properties": {"actions": {"allOf": [{"type": "object", "properties": {"suppress": {"type": "boolean", "description": "If true, the resulting alert is suppressed. Suppressed alerts will not trigger an incident."}, "suspend": {"type": "integer", "description": "The number of seconds to suspend the resulting alert before triggering. This effectively pauses incident notifications. If a resolve event arrives before the alert triggers then PagerDuty won\'t create an incident for this the resulting alert."}, "drop_event": {"type": "boolean", "description": "If true, this event will be dropped. Dropped events will not trigger or resolve an alert or an incident. Dropped events will not be evaluated against router rules."}}}, {"type": "object", "properties": {"priority": {"type": "string", "description": "The ID of the priority you want to set on resulting incident. You can find the list of priority IDs for your account by calling the priorities endpoint.", "example": "P53ZZH5"}, "escalation_policy": {"type": "string", "description": "The ID of the Escalation Policy you want to assign incidents to. Event rules with this action will override the Escalation Policy already set on a Service\'s settings, with what is configured by this action.", "example": "PQOMK4S"}, "annotate": {"type": "string", "description": "Add this text as a note on the resulting incident. AIOps users can additionally use the {{event}} variable to include elements of the event payload in the note."}}}, {"type": "object", "properties": {"severity": {"type": "string", "description": "Set the severity of the resulting alert.", "enum": ["info", "error", "warning", "critical"]}, "event_action": {"type": "string", "description": "Set whether the resulting alert status is trigger or resolve.", "enum": ["trigger", "resolve"]}, "variables": {"type": "array", "description": "Populate variables from event payloads and use those variables in other event actions.", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the variable", "example": "server_name"}, "path": {"type": "string", "description": "Path to a field in an event, in dot-notation.", "example": "event.summary"}, "type": {"type": "string", "description": "The type of operation to populate the variable. Currently only Regex-based variable extraction is supported.", "enum": ["regex"]}, "value": {"type": "string", "description": "A RE2 regular expression. If it contains one or more capture groups, their values will be extracted and appended together. If it contains no capture groups, the whole match is used.", "example": "High CPU on (.*) server"}}}}, "extractions": {"type": "array", "description": "Dynamically extract values to set and modify new and existing PD-CEF fields.", "items": {"anyOf": [{"type": "object", "description": "Use a template string & variables", "properties": {"target": {"type": "string", "description": "The PD-CEF field that will be set with the value from the template.", "example": "event.summary"}, "template": {"type": "string", "description": "A value that will be used to populate the target PD-CEF field. You can include variables extracted from the payload by using string interpolation.", "example": "High CPU on {{hostname}} server"}}}, {"type": "object", "description": "Use a regex to extract a value", "properties": {"target": {"type": "string", "description": "The PD-CEF field that will be set with the value from the regex.", "example": "event.custom_details.server"}, "regex": {"type": "string", "description": "A RE2 regular expression. If it contains one or more capture groups, their values will be extracted and appended together. If it contains no capture groups, the whole match is used.", "example": "High CPU on (.*) server"}, "source": {"type": "string", "description": "The path to the event field where the regex will be applied to extract a value.", "example": "event.summary"}}}]}}}}, {"type": "object", "properties": {"automation_actions": {"type": "array", "description": "Create a Webhoook associated with the resulting incident.", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the Webhook."}, "url": {"type": "string", "description": "The API endpoint where PagerDuty\'s servers will send the webhook request."}, "auto_send": {"type": "boolean", "description": "When true, PagerDuty\'s servers will automatically send this webhook request as soon as the resulting incident or alert is created. When false, your incident responder will be able to manually trigger the Webhook via the PagerDuty website & mobile app.", "default": false}, "headers": {"type": "array", "description": "Specify custom key/value pairs that\'ll be sent with the webhook request as request headers.", "items": {"type": "object", "properties": {"key": {"type": "string"}, "value": {"type": "string", "description": "AIOps users can additionally use the {{event}} variable to include elements of the event payload in the header value."}}}}, "trigger_types": {"type": "array", "description": "The Webhook will be associated (or automatically triggered, if `auto_send` is `true`) with the incident, whenever an alert reaches the specified state\n\nNote: `auto_send` must be `true` for trigger types of `alert_suppressed` and `alert_suspended`\n", "minItems": 1, "maxItems": 1, "uniqueItems": true, "items": {"type": "string", "enum": ["alert_triggered", "alert_suppressed", "alert_suspended"]}}, "parameters": {"type": "array", "description": "Specify custom key/value pairs that\'ll be included in the webhook request\'s JSON payload.", "items": {"type": "object", "properties": {"key": {"type": "string"}, "value": {"type": "string", "description": "AIOps users can additionally use the {{event}} variable to include elements of the event payload in the parameter value."}}}}}}}}}, {"type": "object", "properties": {"incident_custom_field_updates": {"type": "array", "description": "Configure custom field updates for the incident.", "items": {"type": "object", "properties": {"id": {"type": "string", "description": "Unique identifier for the custom field resource. You can find the list of IDs by calling the List Custom Fields endpoint.", "example": "PEXCK89"}, "value": {"type": "string", "description": "A value that will be used to populate the specified Incident Custom Field. AIOps users can additionally use the {{event}} variable to include elements of the event payload in the custom field value.", "example": "High CPU on server"}}}}}}]}}}}}}, "example": {"$ref": "#/components/examples/OrchestrationPathGlobalTypeResponse/value"}}]}',  # noqa: E501
    "UPDATEORCHESTRATIONROUTINGRULES": '{"allOf": [{"type": "object", "properties": {"orchestration_path": {"type": "object", "properties": {"type": {"type": "string", "default": "service", "readOnly": true}, "parent": {"type": "object", "properties": {"id": {"type": "string", "description": "ID of the object these Orchestration Rules belongs to.", "readOnly": true}, "type": {"type": "string", "description": "A string that determines the schema of the parent object", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the parent object is accessible", "readOnly": true}}, "readOnly": true}, "sets": {"type": "array", "description": "Must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph of rules.", "items": {"type": "object", "description": "A set of rules", "properties": {"id": {"type": "string", "description": "The ID of this set of rules. Rules in other sets can route events into this set using the "route_to" properties.", "default": "start"}, "rules": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "description": "ID of the rule", "readOnly": true}, "label": {"type": "string", "description": "A description of this rule\'s purpose."}, "conditions": {"type": "array", "description": "Each of these conditions is evaluated to check if an event matches this rule. The rule is considered a match if **any** of these conditions match.", "items": {"type": "object", "properties": {"expression": {"type": "string", "description": "A PCL condition string", "example": "event.summary matches part \'my service error\'"}}}}, "actions": {"type": "object", "description": "When an event matches this rule, these are the actions that will be taken to change the resulting alert and incident."}, "disabled": {"type": "boolean", "description": "Indicates whether the rule is disabled and would therefore not be evaluated."}}}}}}}, "catch_all": {"type": "object", "description": "When none of the Rules in a set match an event, we apply the catch_all actions to the event.", "properties": {"actions": {"type": "object", "description": "These are the actions that will be taken to change the resulting alert and incident."}}}, "created_at": {"type": "string", "format": "date-time", "description": "The date/time the object was created.", "readOnly": true}, "created_by": {"type": "object", "description": "Reference to the user that created the object.", "properties": {"id": {"type": "string", "readOnly": true}, "type": {"type": "string", "description": "A 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.", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}, "readOnly": true}, "updated_at": {"type": "string", "format": "date-time", "description": "The date/time the object was last updated.", "readOnly": true}, "updated_by": {"type": "object", "description": "Reference to the user that last updated the object.", "properties": {"id": {"type": "string", "readOnly": true}, "type": {"type": "string", "description": "A 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.", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}, "readOnly": true}, "version": {"type": "string", "description": "Version of these Orchestration Rules", "readOnly": true}}}}, "required": ["orchestration_path"]}, {"type": "object", "properties": {"orchestration_path": {"properties": {"type": {"description": "Indicates that these are a "router" type set of rules.", "default": "router"}, "parent": {"properties": {"id": {"description": "ID of the Global Event Orchestration this Router belongs to."}, "type": {"enum": ["event_orchestration_reference"]}}}, "sets": {"description": "The Router contains a single set of rules (the "start" set). The Router evaluates Events against these Rules, one at a time, and routes each Event to a specific Service based on the first rule that matches.", "maxItems": 1, "minItems": 1, "items": {"properties": {"rules": {"items": {"properties": {"actions": {"properties": {"route_to": {"type": "string", "description": "The ID of the target Service for the resulting alert. You can find the service you want to route to by calling the services endpoint.", "example": "PSI2I2O"}, "dynamic_route_to": {"type": "object", "description": "Use the contents of an event payload to dynamically route an event to the target service. Available to AIOps customers. Note it can only be used once in the Router, and only in the first rule. The dynamic_route_to rule cannot have conditions or a route_to action defined.", "properties": {"source": {"type": "string", "description": "The path to a field in an event.", "example": "event.summary"}, "regex": {"type": "string", "description": "A RE2 regular expression, used to extract a value from the source field.", "example": "(.*)"}, "lookup_by": {"type": "string", "description": "Indicates whether the extracted value from the source is a service\'s name or ID.", "enum": ["service_name", "service_id"]}}}}}}}}}}}, "catch_all": {"description": "When none of the rules match an event, the event will be routed according to the catch_all settings.", "properties": {"actions": {"properties": {"route_to": {"description": "With a value of \'unrouted\', all events are sent to the Unrouted Orchestration.", "type": "string", "default": "unrouted"}}}}}}}}, "example": {"orchestration_path": {"type": "router", "parent": {"id": "b02e973d-9620-4e0a-9edc-00fedf7d4694", "self": "https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694", "type": "event_orchestration_reference"}, "self": "https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/router", "sets": [{"id": "start", "rules": [{"label": "Events relating to our relational database", "id": "1c26698b", "conditions": [{"expression": "event.summary matches part \'database\'"}, {"expression": "event.source matches regex \'db[0-9]+-server\'"}], "actions": {"route_to": "PB31XBA"}}, {"label": "Events relating to our www app server", "id": "d9801904", "conditions": [{"expression": "event.summary matches part \'www\'"}], "actions": {"route_to": "PC2D9ML"}}]}], "catch_all": {"actions": {"route_to": "unrouted"}}, "created_at": "2021-11-18T16:42:01Z", "created_by": {"id": "P8B9WR8", "self": "https://api.pagerduty.com/users/P8B9WR8", "type": "user_reference"}, "updated_at": "2021-11-18T16:42:01Z", "updated_by": {"id": "P8B9WR8", "self": "https://api.pagerduty.com/users/P8B9WR8", "type": "user_reference"}, "version": "9co0z4b152oICsoV91_PW2.ww8ip_xap"}}}]}',  # noqa: E501
    "UPDATEUNROUTEDEVENTRULES": '{"allOf": [{"type": "object", "properties": {"orchestration_path": {"type": "object", "properties": {"type": {"type": "string", "default": "service", "readOnly": true}, "parent": {"type": "object", "properties": {"id": {"type": "string", "description": "ID of the object these Orchestration Rules belongs to.", "readOnly": true}, "type": {"type": "string", "description": "A string that determines the schema of the parent object", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the parent object is accessible", "readOnly": true}}, "readOnly": true}, "sets": {"type": "array", "description": "Must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph of rules.", "items": {"type": "object", "description": "A set of rules", "properties": {"id": {"type": "string", "description": "The ID of this set of rules. Rules in other sets can route events into this set using the "route_to" properties.", "default": "start"}, "rules": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "description": "ID of the rule", "readOnly": true}, "label": {"type": "string", "description": "A description of this rule\'s purpose."}, "conditions": {"type": "array", "description": "Each of these conditions is evaluated to check if an event matches this rule. The rule is considered a match if **any** of these conditions match.", "items": {"type": "object", "properties": {"expression": {"type": "string", "description": "A PCL condition string", "example": "event.summary matches part \'my service error\'"}}}}, "actions": {"type": "object", "description": "When an event matches this rule, these are the actions that will be taken to change the resulting alert and incident."}, "disabled": {"type": "boolean", "description": "Indicates whether the rule is disabled and would therefore not be evaluated."}}}}}}}, "catch_all": {"type": "object", "description": "When none of the Rules in a set match an event, we apply the catch_all actions to the event.", "properties": {"actions": {"type": "object", "description": "These are the actions that will be taken to change the resulting alert and incident."}}}, "created_at": {"type": "string", "format": "date-time", "description": "The date/time the object was created.", "readOnly": true}, "created_by": {"type": "object", "description": "Reference to the user that created the object.", "properties": {"id": {"type": "string", "readOnly": true}, "type": {"type": "string", "description": "A 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.", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}, "readOnly": true}, "updated_at": {"type": "string", "format": "date-time", "description": "The date/time the object was last updated.", "readOnly": true}, "updated_by": {"type": "object", "description": "Reference to the user that last updated the object.", "properties": {"id": {"type": "string", "readOnly": true}, "type": {"type": "string", "description": "A 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.", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}, "readOnly": true}, "version": {"type": "string", "description": "Version of these Orchestration Rules", "readOnly": true}}}}, "required": ["orchestration_path"]}, {"type": "object", "properties": {"orchestration_path": {"properties": {"type": {"description": "Indicates that these are a "unrouted" type set of rules.", "default": "unrouted"}, "parent": {"properties": {"id": {"description": "ID of the Global Event Orchestration this Unrouted Orchestration belongs to."}, "type": {"enum": ["event_orchestration_reference"]}}}, "sets": {"description": "An Unrouted Orchestration must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph.", "items": {"properties": {"rules": {"items": {"properties": {"actions": {"allOf": [{"properties": {"route_to": {"type": "string", "description": "The ID of a Set from this Unrouted Orchestration whose rules you also want to use with event that match this rule."}}}, {"type": "object", "properties": {"severity": {"type": "string", "description": "Set the severity of the resulting alert.", "enum": ["info", "error", "warning", "critical"]}, "event_action": {"type": "string", "description": "Set whether the resulting alert status is trigger or resolve.", "enum": ["trigger", "resolve"]}, "variables": {"type": "array", "description": "Populate variables from event payloads and use those variables in other event actions.", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the variable", "example": "server_name"}, "path": {"type": "string", "description": "Path to a field in an event, in dot-notation.", "example": "event.summary"}, "type": {"type": "string", "description": "The type of operation to populate the variable. Currently only Regex-based variable extraction is supported.", "enum": ["regex"]}, "value": {"type": "string", "description": "A RE2 regular expression. If it contains one or more capture groups, their values will be extracted and appended together. If it contains no capture groups, the whole match is used.", "example": "High CPU on (.*) server"}}}}, "extractions": {"type": "array", "description": "Dynamically extract values to set and modify new and existing PD-CEF fields.", "items": {"anyOf": [{"type": "object", "description": "Use a template string & variables", "properties": {"target": {"type": "string", "description": "The PD-CEF field that will be set with the value from the template.", "example": "event.summary"}, "template": {"type": "string", "description": "A value that will be used to populate the target PD-CEF field. You can include variables extracted from the payload by using string interpolation.", "example": "High CPU on {{hostname}} server"}}}, {"type": "object", "description": "Use a regex to extract a value", "properties": {"target": {"type": "string", "description": "The PD-CEF field that will be set with the value from the regex.", "example": "event.custom_details.server"}, "regex": {"type": "string", "description": "A RE2 regular expression. If it contains one or more capture groups, their values will be extracted and appended together. If it contains no capture groups, the whole match is used.", "example": "High CPU on (.*) server"}, "source": {"type": "string", "description": "The path to the event field where the regex will be applied to extract a value.", "example": "event.summary"}}}]}}}}]}}}}}}}, "catch_all": {"properties": {"actions": {"type": "object", "properties": {"severity": {"type": "string", "description": "Set the severity of the resulting alert.", "enum": ["info", "error", "warning", "critical"]}, "event_action": {"type": "string", "description": "Set whether the resulting alert status is trigger or resolve.", "enum": ["trigger", "resolve"]}, "variables": {"type": "array", "description": "Populate variables from event payloads and use those variables in other event actions.", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the variable", "example": "server_name"}, "path": {"type": "string", "description": "Path to a field in an event, in dot-notation.", "example": "event.summary"}, "type": {"type": "string", "description": "The type of operation to populate the variable. Currently only Regex-based variable extraction is supported.", "enum": ["regex"]}, "value": {"type": "string", "description": "A RE2 regular expression. If it contains one or more capture groups, their values will be extracted and appended together. If it contains no capture groups, the whole match is used.", "example": "High CPU on (.*) server"}}}}, "extractions": {"type": "array", "description": "Dynamically extract values to set and modify new and existing PD-CEF fields.", "items": {"anyOf": [{"type": "object", "description": "Use a template string & variables", "properties": {"target": {"type": "string", "description": "The PD-CEF field that will be set with the value from the template.", "example": "event.summary"}, "template": {"type": "string", "description": "A value that will be used to populate the target PD-CEF field. You can include variables extracted from the payload by using string interpolation.", "example": "High CPU on {{hostname}} server"}}}, {"type": "object", "description": "Use a regex to extract a value", "properties": {"target": {"type": "string", "description": "The PD-CEF field that will be set with the value from the regex.", "example": "event.custom_details.server"}, "regex": {"type": "string", "description": "A RE2 regular expression. If it contains one or more capture groups, their values will be extracted and appended together. If it contains no capture groups, the whole match is used.", "example": "High CPU on (.*) server"}, "source": {"type": "string", "description": "The path to the event field where the regex will be applied to extract a value.", "example": "event.summary"}}}]}}}}}}}}}, "example": {"orchestration_path": {"type": "unrouted", "parent": {"id": "b02e973d-9620-4e0a-9edc-00fedf7d4694", "self": "https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694", "type": "event_orchestration_reference"}, "self": "https://api.pagerduty.com/event_orchestrations/b02e973d-9620-4e0a-9edc-00fedf7d4694/router", "sets": [{"id": "start", "rules": [{"label": "Update the summary of un-matched Critical alerts so they\'re easier to spot", "id": "38880ffb", "conditions": [{"expression": "event.severity matches \'critical\'"}], "actions": {"extractions": [{"target": "event.summary", "template": "[Critical Unrouted] {{event.summary}}"}]}}, {"label": "Reduce the severity of all other unrouted events", "id": "3896801e", "conditions": [], "actions": {"severity": "info"}}]}], "catch_all": {"actions": {"suppress": true}}, "created_at": "2021-11-18T16:42:01Z", "created_by": {"id": "P8B9WR8", "self": "https://api.pagerduty.com/users/P8B9WR8", "type": "user_reference"}, "updated_at": "2021-11-18T16:42:01Z", "updated_by": {"id": "P8B9WR8", "self": "https://api.pagerduty.com/users/P8B9WR8", "type": "user_reference"}, "version": "aZO.EEf9zWb9Vg0NYq.Uqad1hOC2Maod"}}}]}',  # noqa: E501
    "UPDATESERVICEORCHESTRATION": '{"allOf": [{"type": "object", "properties": {"orchestration_path": {"type": "object", "properties": {"type": {"type": "string", "default": "service", "readOnly": true}, "parent": {"type": "object", "properties": {"id": {"type": "string", "description": "ID of the object these Orchestration Rules belongs to.", "readOnly": true}, "type": {"type": "string", "description": "A string that determines the schema of the parent object", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the parent object is accessible", "readOnly": true}}, "readOnly": true}, "sets": {"type": "array", "description": "Must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph of rules.", "items": {"type": "object", "description": "A set of rules", "properties": {"id": {"type": "string", "description": "The ID of this set of rules. Rules in other sets can route events into this set using the "route_to" properties.", "default": "start"}, "rules": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "description": "ID of the rule", "readOnly": true}, "label": {"type": "string", "description": "A description of this rule\'s purpose."}, "conditions": {"type": "array", "description": "Each of these conditions is evaluated to check if an event matches this rule. The rule is considered a match if **any** of these conditions match.", "items": {"type": "object", "properties": {"expression": {"type": "string", "description": "A PCL condition string", "example": "event.summary matches part \'my service error\'"}}}}, "actions": {"type": "object", "description": "When an event matches this rule, these are the actions that will be taken to change the resulting alert and incident."}, "disabled": {"type": "boolean", "description": "Indicates whether the rule is disabled and would therefore not be evaluated."}}}}}}}, "catch_all": {"type": "object", "description": "When none of the Rules in a set match an event, we apply the catch_all actions to the event.", "properties": {"actions": {"type": "object", "description": "These are the actions that will be taken to change the resulting alert and incident."}}}, "created_at": {"type": "string", "format": "date-time", "description": "The date/time the object was created.", "readOnly": true}, "created_by": {"type": "object", "description": "Reference to the user that created the object.", "properties": {"id": {"type": "string", "readOnly": true}, "type": {"type": "string", "description": "A 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.", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}, "readOnly": true}, "updated_at": {"type": "string", "format": "date-time", "description": "The date/time the object was last updated.", "readOnly": true}, "updated_by": {"type": "object", "description": "Reference to the user that last updated the object.", "properties": {"id": {"type": "string", "readOnly": true}, "type": {"type": "string", "description": "A 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.", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}, "readOnly": true}, "version": {"type": "string", "description": "Version of these Orchestration Rules", "readOnly": true}}}}, "required": ["orchestration_path"]}, {"type": "object", "properties": {"orchestration_path": {"allOf": [{"type": "object", "properties": {"migrated_at": {"type": "string", "format": "date-time", "description": "The date/time the service\'s Event Rules were converted to this Service Orchestration. This property is only included if the `migrated_metadata` query parameter is provided.", "readOnly": true}, "migrated_by": {"type": "object", "description": "Reference to the user that converted the service\'s Event Rules to this Service Orchestration. This property is only included if the `migrated_metadata` query parameter is provided.", "properties": {"id": {"type": "string", "readOnly": true}, "type": {"type": "string", "description": "A 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.", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}, "readOnly": true}, "migrated_from": {"type": "object", "description": "Reference to the Service Event Rules that were converted to this Service Orchestration. This property is only included if the `migrated_metadata` query parameter is provided.", "properties": {"id": {"type": "string", "readOnly": true}, "type": {"type": "string", "description": "A 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.", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}, "readOnly": true}, "migrated_status": {"type": "string", "description": "The status indicating whether the service\'s Event Rules were successfully converted to this Service Orchestration. This property is only included if the `migrated_metadata` query parameter is provided.", "enum": ["completed"], "readOnly": true}, "migrated_via": {"type": "string", "description": "Indicates whether the conversion was performed via the PagerDuty API or PagerDuty website. This property is only included if the `migrated_metadata` query parameter is provided.", "enum": ["API", "UI"], "readOnly": true}}}, {"type": "object", "properties": {"type": {"description": "Indicates that these are sets of rules belonging to a service.", "default": "service"}, "parent": {"properties": {"id": {"description": "The ID of the Service this Orchestration belongs to."}, "type": {"enum": ["service_reference"]}}}, "sets": {"description": "A Service Orchestration must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph.", "items": {"properties": {"rules": {"items": {"properties": {"actions": {"allOf": [{"properties": {"route_to": {"type": "string", "description": "The ID of a Set from this Service Orchestration whose rules you also want to use with event that match this rule."}}}, {"type": "object", "properties": {"suppress": {"type": "boolean", "description": "If true, the resulting alert is suppressed. Suppressed alerts will not trigger an incident."}, "suspend": {"type": "integer", "description": "The number of seconds to suspend the resulting alert before triggering. This effectively pauses incident notifications. If a resolve event arrives before the alert triggers then PagerDuty won\'t create an incident for this the resulting alert."}}}, {"type": "object", "properties": {"priority": {"type": "string", "description": "The ID of the priority you want to set on resulting incident. You can find the list of priority IDs for your account by calling the priorities endpoint.", "example": "P53ZZH5"}, "escalation_policy": {"type": "string", "description": "The ID of the Escalation Policy you want to assign incidents to. Event rules with this action will override the Escalation Policy already set on a Service\'s settings, with what is configured by this action.", "example": "PQOMK4S"}, "annotate": {"type": "string", "description": "Add this text as a note on the resulting incident. AIOps users can additionally use the {{event}} variable to include elements of the event payload in the note."}}}, {"type": "object", "properties": {"severity": {"type": "string", "description": "Set the severity of the resulting alert.", "enum": ["info", "error", "warning", "critical"]}, "event_action": {"type": "string", "description": "Set whether the resulting alert status is trigger or resolve.", "enum": ["trigger", "resolve"]}, "variables": {"type": "array", "description": "Populate variables from event payloads and use those variables in other event actions.", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the variable", "example": "server_name"}, "path": {"type": "string", "description": "Path to a field in an event, in dot-notation.", "example": "event.summary"}, "type": {"type": "string", "description": "The type of operation to populate the variable. Currently only Regex-based variable extraction is supported.", "enum": ["regex"]}, "value": {"type": "string", "description": "A RE2 regular expression. If it contains one or more capture groups, their values will be extracted and appended together. If it contains no capture groups, the whole match is used.", "example": "High CPU on (.*) server"}}}}, "extractions": {"type": "array", "description": "Dynamically extract values to set and modify new and existing PD-CEF fields.", "items": {"anyOf": [{"type": "object", "description": "Use a template string & variables", "properties": {"target": {"type": "string", "description": "The PD-CEF field that will be set with the value from the template.", "example": "event.summary"}, "template": {"type": "string", "description": "A value that will be used to populate the target PD-CEF field. You can include variables extracted from the payload by using string interpolation.", "example": "High CPU on {{hostname}} server"}}}, {"type": "object", "description": "Use a regex to extract a value", "properties": {"target": {"type": "string", "description": "The PD-CEF field that will be set with the value from the regex.", "example": "event.custom_details.server"}, "regex": {"type": "string", "description": "A RE2 regular expression. If it contains one or more capture groups, their values will be extracted and appended together. If it contains no capture groups, the whole match is used.", "example": "High CPU on (.*) server"}, "source": {"type": "string", "description": "The path to the event field where the regex will be applied to extract a value.", "example": "event.summary"}}}]}}}}, {"type": "object", "properties": {"pagerduty_automation_actions": {"type": "array", "description": "Configure an Automation Action to be run for certain alert states.", "items": {"type": "object", "properties": {"action_id": {"type": "string", "description": "Automation Action ID"}, "trigger_types": {"type": "array", "description": "The Automation Action will be triggered whenever an alert reaches the specified state", "minItems": 1, "maxItems": 1, "uniqueItems": true, "items": {"type": "string", "enum": ["alert_triggered", "alert_suppressed", "alert_suspended"]}}}}}}}, {"type": "object", "properties": {"automation_actions": {"type": "array", "description": "Create a Webhoook associated with the resulting incident.", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the Webhook."}, "url": {"type": "string", "description": "The API endpoint where PagerDuty\'s servers will send the webhook request."}, "auto_send": {"type": "boolean", "description": "When true, PagerDuty\'s servers will automatically send this webhook request as soon as the resulting incident or alert is created. When false, your incident responder will be able to manually trigger the Webhook via the PagerDuty website & mobile app.", "default": false}, "headers": {"type": "array", "description": "Specify custom key/value pairs that\'ll be sent with the webhook request as request headers.", "items": {"type": "object", "properties": {"key": {"type": "string"}, "value": {"type": "string", "description": "AIOps users can additionally use the {{event}} variable to include elements of the event payload in the header value."}}}}, "trigger_types": {"type": "array", "description": "The Webhook will be associated (or automatically triggered, if `auto_send` is `true`) with the incident, whenever an alert reaches the specified state\n\nNote: `auto_send` must be `true` for trigger types of `alert_suppressed` and `alert_suspended`\n", "minItems": 1, "maxItems": 1, "uniqueItems": true, "items": {"type": "string", "enum": ["alert_triggered", "alert_suppressed", "alert_suspended"]}}, "parameters": {"type": "array", "description": "Specify custom key/value pairs that\'ll be included in the webhook request\'s JSON payload.", "items": {"type": "object", "properties": {"key": {"type": "string"}, "value": {"type": "string", "description": "AIOps users can additionally use the {{event}} variable to include elements of the event payload in the parameter value."}}}}}}}}}, {"type": "object", "properties": {"incident_custom_field_updates": {"type": "array", "description": "Configure custom field updates for the incident.", "items": {"type": "object", "properties": {"id": {"type": "string", "description": "Unique identifier for the custom field resource. You can find the list of IDs by calling the List Custom Fields endpoint.", "example": "PEXCK89"}, "value": {"type": "string", "description": "A value that will be used to populate the specified Incident Custom Field. AIOps users can additionally use the {{event}} variable to include elements of the event payload in the custom field value.", "example": "High CPU on server"}}}}}}]}}}}}}}, "catch_all": {"properties": {"actions": {"allOf": [{"type": "object", "properties": {"suppress": {"type": "boolean", "description": "If true, the resulting alert is suppressed. Suppressed alerts will not trigger an incident."}, "suspend": {"type": "integer", "description": "The number of seconds to suspend the resulting alert before triggering. This effectively pauses incident notifications. If a resolve event arrives before the alert triggers then PagerDuty won\'t create an incident for this the resulting alert."}}}, {"type": "object", "properties": {"priority": {"type": "string", "description": "The ID of the priority you want to set on resulting incident. You can find the list of priority IDs for your account by calling the priorities endpoint.", "example": "P53ZZH5"}, "escalation_policy": {"type": "string", "description": "The ID of the Escalation Policy you want to assign incidents to. Event rules with this action will override the Escalation Policy already set on a Service\'s settings, with what is configured by this action.", "example": "PQOMK4S"}, "annotate": {"type": "string", "description": "Add this text as a note on the resulting incident. AIOps users can additionally use the {{event}} variable to include elements of the event payload in the note."}}}, {"type": "object", "properties": {"severity": {"type": "string", "description": "Set the severity of the resulting alert.", "enum": ["info", "error", "warning", "critical"]}, "event_action": {"type": "string", "description": "Set whether the resulting alert status is trigger or resolve.", "enum": ["trigger", "resolve"]}, "variables": {"type": "array", "description": "Populate variables from event payloads and use those variables in other event actions.", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the variable", "example": "server_name"}, "path": {"type": "string", "description": "Path to a field in an event, in dot-notation.", "example": "event.summary"}, "type": {"type": "string", "description": "The type of operation to populate the variable. Currently only Regex-based variable extraction is supported.", "enum": ["regex"]}, "value": {"type": "string", "description": "A RE2 regular expression. If it contains one or more capture groups, their values will be extracted and appended together. If it contains no capture groups, the whole match is used.", "example": "High CPU on (.*) server"}}}}, "extractions": {"type": "array", "description": "Dynamically extract values to set and modify new and existing PD-CEF fields.", "items": {"anyOf": [{"type": "object", "description": "Use a template string & variables", "properties": {"target": {"type": "string", "description": "The PD-CEF field that will be set with the value from the template.", "example": "event.summary"}, "template": {"type": "string", "description": "A value that will be used to populate the target PD-CEF field. You can include variables extracted from the payload by using string interpolation.", "example": "High CPU on {{hostname}} server"}}}, {"type": "object", "description": "Use a regex to extract a value", "properties": {"target": {"type": "string", "description": "The PD-CEF field that will be set with the value from the regex.", "example": "event.custom_details.server"}, "regex": {"type": "string", "description": "A RE2 regular expression. If it contains one or more capture groups, their values will be extracted and appended together. If it contains no capture groups, the whole match is used.", "example": "High CPU on (.*) server"}, "source": {"type": "string", "description": "The path to the event field where the regex will be applied to extract a value.", "example": "event.summary"}}}]}}}}, {"type": "object", "properties": {"pagerduty_automation_actions": {"type": "array", "description": "Configure an Automation Action to be run for certain alert states.", "items": {"type": "object", "properties": {"action_id": {"type": "string", "description": "Automation Action ID"}, "trigger_types": {"type": "array", "description": "The Automation Action will be triggered whenever an alert reaches the specified state", "minItems": 1, "maxItems": 1, "uniqueItems": true, "items": {"type": "string", "enum": ["alert_triggered", "alert_suppressed", "alert_suspended"]}}}}}}}, {"type": "object", "properties": {"automation_actions": {"type": "array", "description": "Create a Webhoook associated with the resulting incident.", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the Webhook."}, "url": {"type": "string", "description": "The API endpoint where PagerDuty\'s servers will send the webhook request."}, "auto_send": {"type": "boolean", "description": "When true, PagerDuty\'s servers will automatically send this webhook request as soon as the resulting incident or alert is created. When false, your incident responder will be able to manually trigger the Webhook via the PagerDuty website & mobile app.", "default": false}, "headers": {"type": "array", "description": "Specify custom key/value pairs that\'ll be sent with the webhook request as request headers.", "items": {"type": "object", "properties": {"key": {"type": "string"}, "value": {"type": "string", "description": "AIOps users can additionally use the {{event}} variable to include elements of the event payload in the header value."}}}}, "trigger_types": {"type": "array", "description": "The Webhook will be associated (or automatically triggered, if `auto_send` is `true`) with the incident, whenever an alert reaches the specified state\n\nNote: `auto_send` must be `true` for trigger types of `alert_suppressed` and `alert_suspended`\n", "minItems": 1, "maxItems": 1, "uniqueItems": true, "items": {"type": "string", "enum": ["alert_triggered", "alert_suppressed", "alert_suspended"]}}, "parameters": {"type": "array", "description": "Specify custom key/value pairs that\'ll be included in the webhook request\'s JSON payload.", "items": {"type": "object", "properties": {"key": {"type": "string"}, "value": {"type": "string", "description": "AIOps users can additionally use the {{event}} variable to include elements of the event payload in the parameter value."}}}}}}}}}, {"type": "object", "properties": {"incident_custom_field_updates": {"type": "array", "description": "Configure custom field updates for the incident.", "items": {"type": "object", "properties": {"id": {"type": "string", "description": "Unique identifier for the custom field resource. You can find the list of IDs by calling the List Custom Fields endpoint.", "example": "PEXCK89"}, "value": {"type": "string", "description": "A value that will be used to populate the specified Incident Custom Field. AIOps users can additionally use the {{event}} variable to include elements of the event payload in the custom field value.", "example": "High CPU on server"}}}}}}]}}}}}]}}, "example": {"orchestration_path": {"type": "service", "parent": {"id": "PC2D9ML", "self": "https://api.pagerduty.com/service/PC2D9ML", "type": "service_reference"}, "self": "https://api.pagerduty.com/event_orchestrations/service/PC2D9ML", "sets": [{"id": "start", "rules": [{"label": "Always apply some consistent event transformations to all events", "id": "c91f72f3", "conditions": [], "actions": {"variables": [{"name": "hostname", "path": "event.component", "value": "hostname: (.*)", "type": "regex"}], "extractions": [{"template": "{{variables.hostname}}", "target": "event.custom_details.hostname"}, {"source": "event.source", "regex": "www (.*) service", "target": "event.source"}], "incident_custom_field_updates": [{"id": "PEXCK89", "value": "#my-team-channel"}, {"id": "PN1C4A2", "value": "{{event.timestamp}}"}], "route_to": "step-two"}}]}, {"id": "step-two", "rules": [{"label": "All critical alerts should be treated as P1 incidents", "id": "7c54529d", "conditions": ["event.severity matches \'critical\'"], "actions": {"annotate": "Please use our P1 runbook: https://docs.test/p1-runbook", "priority": "P0IN2KQ", "suppress": false, "incident_custom_field_updates": [{"id": "PEXCK89", "value": "#p1-incident-response"}]}}, {"label": "If the API endpoints return HTTP 502 run an Automation Action that restarts the service", "id": "8a874630", "conditions": ["event.custom_details.http_status_code equals \'502\'"], "actions": {"pagerduty_automation_actions": [{"action_id": "01CSB5SMOKCKVRI5GN0LJG7SMB", "trigger_types": ["alert_triggered"]}]}}, {"label": "If there\'s something wrong on the canary let the team know about it in our deployments Slack channel", "id": "1f6d9a33", "conditions": ["event.custom_details.hostname matches part \'canary\'"], "actions": {"automation_actions": [{"name": "Canary Slack Notification", "url": "https://our-slack-listerner.test/send-notification", "auto_send": true, "headers": [{"key": "X-Notification-Source", "value": "PagerDuty Incident Webhook"}], "parameters": [{"key": "channel", "value": "#my-team-channel"}, {"key": "message", "value": "Something is wrong with the canary deployment"}], "trigger_types": ["alert_triggered"]}], "incident_custom_field_updates": [{"id": "PEXCK89", "value": "#my-team-channel"}]}}, {"label": "Pause the alert and trigger a reboot action if flaky server receives an error", "id": "c0163dbe", "conditions": [{"expression": "event.custom_details.hostname matches part \'staging\'"}], "actions": {"suspend": 300, "pagerduty_automation_actions": [{"action_id": "01CSBCGJXMG7ABIJZKPD8P9RCL", "trigger_types": ["alert_suspended"]}]}}, {"label": "Never bother the on-call for info-level events outside of work hours", "id": "cd770384", "conditions": ["event.severity matches \'info\' and not (now in Mon,Tue,Wed,Thu,Fri 09:00:00 to 17:00:00 America/Los_Angeles)"], "actions": {"suppress": true}}]}], "catch_all": {"actions": {"suppress": true, "incident_custom_field_updates": [{"id": "PEXCK89", "value": "#general-incident-notifications"}]}}, "created_at": "2021-11-18T16:42:01Z", "created_by": {"id": "P8B9WR8", "self": "https://api.pagerduty.com/users/P8B9WR8", "type": "user_reference"}, "updated_at": "2021-11-18T16:42:01Z", "updated_by": {"id": "P8B9WR8", "self": "https://api.pagerduty.com/users/P8B9WR8", "type": "user_reference"}, "migrated_at": "2023-06-14T13:51:31Z", "migrated_by": {"id": "P8B9WR8", "self": "https://api.pagerduty.com/users/P8B9WR8", "type": "user_reference"}, "migrated_from": {"id": "PC2D9ML", "self": "https://api.pagerduty.com/services/PC2D9ML/rules", "type": "service_event_rules_reference"}, "migrated_status": "completed", "migrated_via": "UI", "version": "rn1Mja13T1HBdmPChqFilSQXUW2fWXM_"}}}]}',  # noqa: E501
    "UPDATESERVICEORCHESTRATIONSTATUS": '{"type": "object", "description": "Schema reference broken: #/components/responses/OrchestrationPathServiceActiveResponse/content/application~1json/schema", "additionalProperties": true, "x-moar-broken-reference": "#/components/responses/OrchestrationPathServiceActiveResponse/content/application~1json/schema"}',  # noqa: E501
    "UPDATEEVENTORCHESTRATIONFEATURES": '{"type": "object", "properties": {"enablement": {"type": "object", "properties": {"feature": {"readOnly": true, "type": "string", "description": "The name of the product addon whose set of features will be enabled or disabled.", "example": "aiops"}, "enabled": {"type": "boolean", "description": "A boolean value indicating whether the specified product addon is enabled or disabled."}, "updated_at": {"readOnly": true, "type": "string", "format": "date-time", "description": "The time the feature enablement was last updated."}, "warnings": {"readOnly": true, "type": "array", "description": "An array of warnings related to this feature enablement. Only present if warning conditions are met.", "items": {"type": "object", "properties": {"message": {"type": "string", "description": "The warning message."}}}}}, "required": ["enabled"]}}, "required": ["enablement"]}',  # noqa: E501
    "CREATESERVICEEXTENSION": '{"type": "object", "properties": {"extension": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the extension."}, "type": {"type": "string", "description": "The type of object being created.", "default": "extension", "enum": ["extension"]}, "endpoint_url": {"type": "string", "format": "url", "description": "The url of the extension."}, "extension_objects": {"type": "array", "description": "The objects for which the extension applies", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["service_reference"]}}}]}}, "extension_schema": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["extension_schema_reference"]}}}]}, "temporarily_disabled": {"type": "boolean", "readOnly": true, "description": "Whether or not this extension is temporarily disabled; for example, a webhook extension that is repeatedly rejected by the server.", "default": false}, "config": {"type": "object", "description": "The object that contains extension configuration values depending on the extension schema specification."}}, "required": ["extension_objects", "extension_schema", "name"], "example": {"id": "PJU23I3", "endpoint_url": "https://example.com/receive_a_pagerduty_webhook", "name": "My Webhook", "summary": "My Webhook", "type": "extension", "extension_schema": {"id": "PJFWPEP", "type": "extension_schema_reference"}, "extension_objects": [{"id": "PIJ90N7", "type": "service_reference"}], "config": {"anykey": "anyvalue"}}}]}}, "required": ["extension"]}',  # noqa: E501
    "UPDATEEXTENSION": '{"type": "object", "properties": {"extension": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the extension."}, "type": {"type": "string", "description": "The type of object being created.", "default": "extension", "enum": ["extension"]}, "endpoint_url": {"type": "string", "format": "url", "description": "The url of the extension."}, "extension_objects": {"type": "array", "description": "The objects for which the extension applies", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["service_reference"]}}}]}}, "extension_schema": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["extension_schema_reference"]}}}]}, "temporarily_disabled": {"type": "boolean", "readOnly": true, "description": "Whether or not this extension is temporarily disabled; for example, a webhook extension that is repeatedly rejected by the server.", "default": false}, "config": {"type": "object", "description": "The object that contains extension configuration values depending on the extension schema specification."}}, "required": ["extension_objects", "extension_schema", "name"], "example": {"id": "PJU23I3", "endpoint_url": "https://example.com/receive_a_pagerduty_webhook", "name": "My Webhook", "summary": "My Webhook", "type": "extension", "extension_schema": {"id": "PJFWPEP", "type": "extension_schema_reference"}, "extension_objects": [{"id": "PIJ90N7", "type": "service_reference"}], "config": {"anykey": "anyvalue"}}}]}}, "required": ["extension"]}',  # noqa: E501
    "CREATEINCIDENTWORKFLOW": '{"type": "object", "properties": {"incident_workflow": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["incident_workflow"]}, "name": {"type": "string", "description": "A descriptive name for the Incident Workflow"}, "description": {"type": "string", "description": "A description of what the Incident Workflow does"}, "created_at": {"type": "string", "format": "date-time", "description": "The timestamp this Incident Workflow was created", "readOnly": true}, "team": {"type": "object", "readOnly": false, "description": "If specified then workflow edit permissions will be scoped to members of this team", "properties": {"type": {"type": "string", "description": "Type of the referenced object", "readOnly": true, "enum": ["team_reference"]}, "id": {"type": "string", "description": "Unique identifier for the resource", "readOnly": true}}}, "is_enabled": {"type": "boolean", "default": true, "description": "Indicates whether the Incident Workflow is enabled or not. Disabled workflows will not be triggered, and\nwill not count toward the account\'s enabled workflow limit.\n"}, "steps": {"type": "array", "description": "The ordered list of steps that execute sequentially as part of the workflow", "items": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["step"]}, "name": {"type": "string", "description": "A descriptive name for the Step"}, "description": {"type": "string", "readOnly": true, "description": "A description of the action performed by the Step"}, "action_configuration": {"description": "Configuration of automated action executed by this Step", "type": "object", "properties": {"action_id": {"type": "string", "description": "The identifier of the Action to execute"}, "description": {"type": "string", "description": "Description of the Action", "readOnly": true}, "inputs": {"type": "array", "description": "An unordered list of standard inputs used to configure the Action to execute", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name for this Input. Input names are unique per action and should be used to find a specific Input."}, "parameter_type": {"type": "string", "description": "The data type of this Input", "readOnly": true}, "value": {"type": "string", "description": "The configured value of the Input"}}, "required": ["name", "value"]}}, "inline_steps_inputs": {"type": "array", "description": "An unordered list of specialized inputs used to configure a workflow-within-a-workflow", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name for this Input. Input names are unique per action and should be used to find a specific Input."}, "value": {"type": "object", "description": "The configured value of the Inline Steps Input", "properties": {"steps": {"type": "array", "items": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["step"]}, "name": {"type": "string", "description": "A descriptive name for the Step"}, "action_configuration": {"description": "Configuration of automated action executed by this Step", "type": "object", "properties": {"action_id": {"type": "string", "description": "The identifier of the Action to execute"}, "description": {"type": "string", "description": "Description of the Action", "readOnly": true}, "inputs": {"type": "array", "description": "An unordered list of standard inputs used to configure the Action to execute", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name for this Input. Input names are unique per action and should be used to find a specific Input."}, "parameter_type": {"type": "string", "description": "The data type of this Input", "readOnly": true}, "value": {"type": "string", "description": "The configured value of the Input"}}, "required": ["name", "value"]}}, "outputs": {"type": "array", "description": "An unordered list of outputs this action produces", "readOnly": true, "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name for this Output. Output names are unique per action and should be used to find a specific Output.", "readOnly": true}, "reference_name": {"type": "string", "description": "The reference name of the Output", "readOnly": true}, "parameter_type": {"type": "string", "description": "The data type produced by this Output", "readOnly": true}}, "required": ["name", "value"]}}}, "required": ["action_id", "inputs"]}}, "required": ["name", "action_configuration"]}]}}}}}, "required": ["name", "value"]}}, "outputs": {"type": "array", "description": "An unordered list of outputs this action produces", "readOnly": true, "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name for this Output. Output names are unique per action and should be used to find a specific Output.", "readOnly": true}, "reference_name": {"type": "string", "description": "The reference name of the Output", "readOnly": true}, "parameter_type": {"type": "string", "description": "The data type produced by this Output", "readOnly": true}}, "required": ["name", "value"]}}}, "required": ["action_id", "inputs"]}}, "required": ["name", "action_configuration"]}]}}}}]}}, "required": ["incident_workflow"]}',  # noqa: E501
    "UPDATEINCIDENTWORKFLOW": '{"type": "object", "properties": {"incident_workflow": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["incident_workflow"]}, "name": {"type": "string", "description": "A descriptive name for the Incident Workflow"}, "description": {"type": "string", "description": "A description of what the Incident Workflow does"}, "created_at": {"type": "string", "format": "date-time", "description": "The timestamp this Incident Workflow was created", "readOnly": true}, "team": {"type": "object", "readOnly": false, "description": "If specified then workflow edit permissions will be scoped to members of this team", "properties": {"type": {"type": "string", "description": "Type of the referenced object", "readOnly": true, "enum": ["team_reference"]}, "id": {"type": "string", "description": "Unique identifier for the resource", "readOnly": true}}}, "is_enabled": {"type": "boolean", "default": true, "description": "Indicates whether the Incident Workflow is enabled or not. Disabled workflows will not be triggered, and\nwill not count toward the account\'s enabled workflow limit.\n"}, "steps": {"type": "array", "description": "The ordered list of steps that execute sequentially as part of the workflow", "items": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["step"]}, "name": {"type": "string", "description": "A descriptive name for the Step"}, "description": {"type": "string", "readOnly": true, "description": "A description of the action performed by the Step"}, "action_configuration": {"description": "Configuration of automated action executed by this Step", "type": "object", "properties": {"action_id": {"type": "string", "description": "The identifier of the Action to execute"}, "description": {"type": "string", "description": "Description of the Action", "readOnly": true}, "inputs": {"type": "array", "description": "An unordered list of standard inputs used to configure the Action to execute", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name for this Input. Input names are unique per action and should be used to find a specific Input."}, "parameter_type": {"type": "string", "description": "The data type of this Input", "readOnly": true}, "value": {"type": "string", "description": "The configured value of the Input"}}, "required": ["name", "value"]}}, "inline_steps_inputs": {"type": "array", "description": "An unordered list of specialized inputs used to configure a workflow-within-a-workflow", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name for this Input. Input names are unique per action and should be used to find a specific Input."}, "value": {"type": "object", "description": "The configured value of the Inline Steps Input", "properties": {"steps": {"type": "array", "items": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["step"]}, "name": {"type": "string", "description": "A descriptive name for the Step"}, "action_configuration": {"description": "Configuration of automated action executed by this Step", "type": "object", "properties": {"action_id": {"type": "string", "description": "The identifier of the Action to execute"}, "description": {"type": "string", "description": "Description of the Action", "readOnly": true}, "inputs": {"type": "array", "description": "An unordered list of standard inputs used to configure the Action to execute", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name for this Input. Input names are unique per action and should be used to find a specific Input."}, "parameter_type": {"type": "string", "description": "The data type of this Input", "readOnly": true}, "value": {"type": "string", "description": "The configured value of the Input"}}, "required": ["name", "value"]}}, "outputs": {"type": "array", "description": "An unordered list of outputs this action produces", "readOnly": true, "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name for this Output. Output names are unique per action and should be used to find a specific Output.", "readOnly": true}, "reference_name": {"type": "string", "description": "The reference name of the Output", "readOnly": true}, "parameter_type": {"type": "string", "description": "The data type produced by this Output", "readOnly": true}}, "required": ["name", "value"]}}}, "required": ["action_id", "inputs"]}}, "required": ["name", "action_configuration"]}]}}}}}, "required": ["name", "value"]}}, "outputs": {"type": "array", "description": "An unordered list of outputs this action produces", "readOnly": true, "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name for this Output. Output names are unique per action and should be used to find a specific Output.", "readOnly": true}, "reference_name": {"type": "string", "description": "The reference name of the Output", "readOnly": true}, "parameter_type": {"type": "string", "description": "The data type produced by this Output", "readOnly": true}}, "required": ["name", "value"]}}}, "required": ["action_id", "inputs"]}}, "required": ["name", "action_configuration"]}]}}}}]}}, "required": ["incident_workflow"]}',  # noqa: E501
    "STARTINCIDENTWORKFLOW": '{"type": "object", "properties": {"incident_workflow_instance": {"type": "object", "properties": {"id": {"type": "string", "description": "An identifier to help differentiate between workflow executions.", "example": "P3SNKQS"}, "incident": {"type": "object", "properties": {"id": {"type": "string", "example": "Q1R2DLCB21K7NP"}, "type": {"type": "string", "enum": ["incident_reference"]}}, "required": ["id"]}}}}, "required": ["incident_workflow_instance"]}',  # noqa: E501
    "CREATEINCIDENTWORKFLOWTRIGGER": '{"type": "object", "properties": {"trigger": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["workflow_trigger"]}, "trigger_type": {"type": "string", "enum": ["conditional", "manual", "incident_type"]}, "condition": {"type": "string", "description": "A PCL condition string.\n\nIf specified, the trigger will execute when the condition is met on an incident.\n\nIf unspecified, the trigger will execute on incident creation.\n\nRequired if trigger_type is \u201cconditional\u201d, not allowed for other trigger types.\n"}, "trigger_url": {"type": "string", "format": "url"}, "incident_types": {"type": "array", "description": "An optional array of Incident Types associated with the trigger when it is of type `incident_type`.", "items": {"type": "string"}}, "workflow": {"type": "object", "description": "Workflow to start when this trigger is invoked", "properties": {"id": {"type": "string"}}}, "services": {"type": "array", "description": "An optional array of Services associated with this workflow. Incidents in any of the listed Services are eligible to fire this Trigger", "items": {"type": "object", "properties": {"id": {"type": "string"}}}}, "is_subscribed_to_all_services": {"type": "boolean", "description": "Indicates that the Trigger should be associated with All Services"}, "permissions": {"description": "An object detailing who can start this Trigger. Applicable only to manual Triggers.", "type": "object", "properties": {"restricted": {"type": "boolean", "description": "If true, indicates that the Trigger can only be started by authorized Users. If false, any user can start this Trigger. Applicable only to manual Triggers."}, "team_id": {"type": "string", "description": "The ID of the team whose members can manually start this Trigger. Required and allowed if and only if permissions.restricted is true."}}}, "is_disabled": {"type": "boolean", "description": "Indicates whether the Trigger is disabled or not. A previous API version allowed callers to set this\nproperty independently. This behavior is deprecated. This property\'s value will be set based on the \n"is_enabled" property of the workflow to which this trigger belongs.\n", "deprecated": true}}}]}}, "required": ["trigger"]}',  # noqa: E501
    "UPDATEINCIDENTWORKFLOWTRIGGER": '{"type": "object", "properties": {"trigger": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["workflow_trigger"]}, "trigger_type_name": {"type": "string", "readOnly": true, "description": "Human readable name for the trigger type"}, "condition": {"type": "string", "description": "A PCL condition string.\n\nIf specified, the trigger will execute when the condition is met on an incident.\n\nIf unspecified, the trigger will execute on incident creation.\n\nRequired if trigger_type is \u201cconditional\u201d, not allowed for other trigger types.\n"}, "services": {"type": "array", "description": "An optional array of Services associated with this workflow. Incidents in any of the listed Services are eligible to fire this Trigger", "items": {"type": "object", "properties": {"id": {"type": "string"}}}}, "is_subscribed_to_all_services": {"type": "boolean", "description": "Indicates that the Trigger should be associated with All Services"}, "permissions": {"description": "An object detailing who can start this Trigger. Applicable only to manual Triggers.", "type": "object", "properties": {"restricted": {"type": "boolean", "description": "If true, indicates that the Trigger can only be started by authorized Users. If false, any user can start this Trigger. Applicable only to manual Triggers."}, "team_id": {"type": "string", "description": "The ID of the team whose members can manually start this Trigger. Required and allowed if and only if permissions.restricted is true."}}}, "is_disabled": {"type": "boolean", "description": "Indicates whether the Trigger is disabled or not. A previous API version allowed callers to update this\nproperty independently. This behavior is deprecated. To update this property set "is_enabled" on the workflow\nto which this trigger belongs.\n", "deprecated": true}, "incident_types": {"type": "array", "description": "An optional array of Incident Types associated with the trigger when it is of type `incident_type`.", "items": {"type": "string"}}}}]}}, "required": ["trigger"]}',  # noqa: E501
    "ASSOCIATESERVICETOINCIDENTWORKFLOWTRIGGER": '{"type": "object", "properties": {"service": {"type": "object", "properties": {"id": {"type": "string"}}}}, "required": ["service"]}',  # noqa: E501
    "UPDATEINCIDENTS": '{"type": "object", "properties": {"incidents": {"type": "array", "description": "An array of incidents, including the parameters to update.", "items": {"properties": {"id": {"type": "string", "description": "The id of the incident to update."}, "type": {"type": "string", "description": "The incident type.", "enum": ["incident", "incident_reference"]}, "status": {"type": "string", "description": "The new status of the incident. If the incident is currently resolved, setting the status to "triggered" or "acknowledged" will reopen it. When reopening an incident to the "triggered" status, it will be assigned based on the assignees or escalation_policy fields in the request, otherwise it will be assigned to the current Escalation Policy. When reopening an incident to the "acknowledged" status, it will be assigned to the current user.", "enum": ["resolved", "acknowledged", "triggered"]}, "resolution": {"type": "string", "description": "The resolution for this incident. This field is used only when setting the incident status to resolved.\nThe value provided here is added to the incident\u2019s \'Resolve\' log entry as a note and will not be displayed directly in the UI.\n"}, "title": {"type": "string", "description": "A succinct description of the nature, symptoms, cause, or effect of the incident."}, "priority": {"description": "The priority of the incident. Can be provided as a priority object or a string matching a priority name. If a string is provided, the highest priority with a matching name will be used.", "oneOf": [{"type": "object", "properties": {"id": {"type": "string", "description": "The ID of the priority."}, "name": {"type": "string", "description": "The user-provided short name of the priority."}, "type": {"type": "string", "description": "The type of the reference.", "enum": ["priority", "priority_reference"]}}, "required": ["id", "type"]}, {"type": "string", "description": "A string matching the name of a priority. If provided, the highest priority with a matching name will be used."}]}, "escalation_level": {"type": "integer", "description": "Escalate the incident to this level in the escalation policy."}, "assignments": {"type": "array", "description": "Assign the incident to these assignees.", "items": {"properties": {"assignee": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}}}}, "incident_type": {"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "name": {"type": "string", "description": "The name of the Incident Type."}}}, "escalation_policy": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["escalation_policy_reference"]}}}]}, "urgency": {"type": "string", "description": "The urgency of the incident.", "enum": ["high", "low"]}, "conference_bridge": {"type": "object", "properties": {"conference_number": {"type": "string", "description": "The phone number of the conference call for the conference bridge. Phone numbers should be formatted like +1 415-555-1212,,,,1234#, where a comma (,) represents a one-second wait and pound (#) completes access code input."}, "conference_url": {"type": "string", "format": "url", "description": "An URL for the conference bridge. This could be a link to a web conference or Slack channel."}}}}, "required": ["id", "type"]}}}, "required": ["incidents"]}',  # noqa: E501
    "CREATEINCIDENT": '{"type": "object", "properties": {"incident": {"type": "object", "description": "Details of the incident to be created.", "properties": {"type": {"type": "string", "enum": ["incident"]}, "title": {"type": "string", "description": "A succinct description of the nature, symptoms, cause, or effect of the incident."}, "service": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["service_reference"]}}}]}, "priority": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["priority_reference"]}}}]}, "urgency": {"type": "string", "description": "The urgency of the incident", "enum": ["high", "low"]}, "body": {"type": "object", "properties": {"details": {"type": "object", "description": "Additional incident details."}}, "required": ["type"]}, "incident_key": {"type": "string", "description": "A string which identifies the incident. Sending subsequent requests referencing the same service and with the same incident_key will result in those requests being rejected if an open incident matches that incident_key."}, "assignments": {"type": "array", "description": "Assign the incident to these assignees. Cannot be specified if an escalation policy is given.", "items": {"properties": {"assignee": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}}}}, "incident_type": {"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "name": {"type": "string", "description": "The name of the Incident Type."}}}, "escalation_policy": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["escalation_policy_reference"]}}}]}, "conference_bridge": {"type": "object", "properties": {"conference_number": {"type": "string", "description": "The phone number of the conference call for the conference bridge. Phone numbers should be formatted like +1 415-555-1212,,,,1234#, where a comma (,) represents a one-second wait and pound (#) completes access code input."}, "conference_url": {"type": "string", "format": "url", "description": "An URL for the conference bridge. This could be a link to a web conference or Slack channel."}}}}, "required": ["type", "title", "service"]}}, "required": ["incident"]}',  # noqa: E501
    "MANAGEINCIDENTSTATUS": '{"type": "object", "properties": {"incident": {"type": "object", "description": "The parameters of the incident to update.", "properties": {"type": {"type": "string", "description": "The incident type.", "enum": ["incident", "incident_reference"]}, "status": {"type": "string", "description": "The new status of the incident. If the incident is currently resolved, setting the status to "triggered" or "acknowledged" will reopen it. When reopening an incident to the "triggered" status, it will be assigned based on the assignees or escalation_policy fields in the request, otherwise it will be assigned to the current Escalation Policy. When reopening an incident to the "acknowledged" status, it will be assigned to the current user.", "enum": ["resolved", "acknowledged", "triggered"]}, "priority": {"description": "The priority of the incident. Can be provided as a priority object or a string matching a priority name. If a string is provided, the highest priority with a matching name will be used.", "oneOf": [{"type": "object", "properties": {"id": {"type": "string", "description": "The ID of the priority."}, "name": {"type": "string", "description": "The user-provided short name of the priority."}, "type": {"type": "string", "description": "The type of the reference.", "enum": ["priority", "priority_reference"]}}, "required": ["id", "type"]}, {"type": "string", "description": "A string matching the name of a priority. If provided, the highest priority with a matching name will be used."}]}, "resolution": {"type": "string", "description": "The resolution for this incident. This field is used only when setting the incident status to resolved.\nThe value provided here is added to the incident\u2019s \'Resolve\' log entry as a note and will not be displayed directly in the UI.\n"}, "title": {"type": "string", "description": "The new title of the incident."}, "escalation_level": {"type": "integer", "description": "Escalate the incident to this level in the escalation policy."}, "assignments": {"type": "array", "description": "Assign the incident to these assignees.", "items": {"properties": {"assignee": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}}}}, "incident_type": {"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "name": {"type": "string", "description": "The name of the Incident Type."}}}, "escalation_policy": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["escalation_policy_reference"]}}}]}, "urgency": {"type": "string", "description": "The urgency of the incident.", "enum": ["high", "low"]}, "conference_bridge": {"type": "object", "properties": {"conference_number": {"type": "string", "description": "The phone number of the conference call for the conference bridge. Phone numbers should be formatted like +1 415-555-1212,,,,1234#, where a comma (,) represents a one-second wait and pound (#) completes access code input."}, "conference_url": {"type": "string", "format": "url", "description": "An URL for the conference bridge. This could be a link to a web conference or Slack channel."}}}, "service": {"type": "object", "description": "Assign the incident to this service.", "properties": {"id": {"type": "string", "description": "The ID of the service."}, "type": {"type": "string", "description": "The type of the reference.", "enum": ["service_reference"]}}, "required": ["id", "type"]}}, "required": ["type"]}}, "required": ["incident"]}',  # noqa: E501
    "RESOLVEORREASSOCIATEINCIDENTALERTS": '{"type": "object", "properties": {"alerts": {"type": "array", "description": "An array of alerts, including the parameters to update for each alert.", "items": {"type": "object", "x-examples": {"Example 1": {"status": "resolved", "incident": {"id": "string", "type": "incident_reference"}}}, "properties": {"status": {"type": "string", "enum": ["resolved", "triggered"]}, "incident": {"type": "object", "x-examples": {"Example 1": {"id": "string", "type": "incident_reference"}}, "properties": {"id": {"type": "string"}, "type": {"type": "string", "enum": ["incident_reference"]}}, "required": ["id"]}}}}}, "required": ["alerts"]}',  # noqa: E501
    "RESOLVEORUPDATEINCIDENTALERT": '{"type": "object", "properties": {"alert": {"type": "object", "x-examples": {"Example 1": {"status": "resolved", "incident": {"id": "string", "type": "incident_reference"}}}, "properties": {"status": {"type": "string", "enum": ["resolved", "triggered"]}, "incident": {"type": "object", "x-examples": {"Example 1": {"id": "string", "type": "incident_reference"}}, "properties": {"id": {"type": "string"}, "type": {"type": "string", "enum": ["incident_reference"]}}, "required": ["id"]}}}}, "required": ["alert"]}',  # noqa: E501
    "UPDATEINCIDENTSERVICEIMPACT": '{"description": "", "type": "object", "properties": {"relation": {"type": "string", "enum": ["impacted", "not_impacted"]}}, "required": ["relation"]}',  # noqa: E501
    "UPDATEINCIDENTCUSTOMFIELDS": '{"type": "object", "properties": {"custom_fields": {"type": "array", "title": "Array of Custom Field Values", "items": {"title": "Custom Field Value", "oneOf": [{"type": "object", "title": "Value by Field Name", "properties": {"name": {"type": "string", "title": "Field Name", "description": "The name of the field. May include ASCII characters, specifically lowercase letters, digits, and underescores. The `name` for a Field must be unique and cannot be changed once created.", "maxLength": 50}, "value": {"oneOf": [{"type": "object", "title": "Boolean", "properties": {"value": {"type": "boolean", "nullable": true}}}, {"type": "object", "title": "Float", "properties": {"value": {"type": "number", "nullable": true}}}, {"type": "object", "title": "Integer", "properties": {"value": {"type": "integer", "nullable": true}}}, {"type": "object", "title": "String", "properties": {"value": {"oneOf": [{"type": "string", "maxLength": 200, "nullable": true}, {"type": "array", "items": {"type": "string", "maxLength": 200}, "maxItems": 10, "uniqueItems": true, "nullable": true}]}}}, {"type": "object", "title": "Datetime", "properties": {"value": {"type": "string", "nullable": true, "format": "date-time"}}}, {"type": "object", "title": "Url", "properties": {"value": {"type": "string", "format": "uri", "maxLength": 200, "nullable": true}}}]}}}, {"type": "object", "title": "Value by Field ID", "properties": {"id": {"type": "string", "description": "The ID of the Field."}, "value": {"oneOf": [{"type": "object", "title": "Boolean", "properties": {"value": {"type": "boolean", "nullable": true}}}, {"type": "object", "title": "Float", "properties": {"value": {"type": "number", "nullable": true}}}, {"type": "object", "title": "Integer", "properties": {"value": {"type": "integer", "nullable": true}}}, {"type": "object", "title": "String", "properties": {"value": {"oneOf": [{"type": "string", "maxLength": 200, "nullable": true}, {"type": "array", "items": {"type": "string", "maxLength": 200}, "maxItems": 10, "uniqueItems": true, "nullable": true}]}}}, {"type": "object", "title": "Datetime", "properties": {"value": {"type": "string", "nullable": true, "format": "date-time"}}}, {"type": "object", "title": "Url", "properties": {"value": {"type": "string", "format": "uri", "maxLength": 200, "nullable": true}}}]}}}]}}}, "required": ["custom_fields"]}',  # noqa: E501
    "MERGEINCIDENTS": '{"type": "object", "properties": {"source_incidents": {"type": "array", "description": "The source incidents that will be merged into the target incident and resolved.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["incident_reference"]}}}]}}}, "required": ["source_incidents"]}',  # noqa: E501
    "ADDINCIDENTNOTE": '{"type": "object", "properties": {"note": {"type": "object", "properties": {"content": {"type": "string", "description": "The note content"}}, "required": ["content"]}}, "required": ["note"]}',  # noqa: E501
    "CREATEINCIDENTRESPONDERREQUEST": '{"type": "object", "properties": {"requester_id": {"type": "string", "description": "The user id of the requester."}, "message": {"type": "string", "description": "The message sent with the responder request."}, "responder_request_targets": {"description": "The array of targets the responder request is sent to.", "items": {"type": "object", "properties": {"type": {"type": "string", "description": "The type of target (either a user or an escalation policy)"}, "id": {"type": "string", "description": "The id of the user or escalation policy"}, "summary": {"type": "string"}, "incident_responders": {"type": "array", "description": "An array of responders associated with the specified incident", "items": {"type": "object", "properties": {"state": {"type": "string", "description": "The status of the responder being added to the incident", "example": "pending"}, "user": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}, "incident": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["incident_reference"]}}}]}, "updated_at": {"type": "string"}, "message": {"type": "string", "description": "The message sent with the responder request"}, "requester": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}, "requested_at": {"type": "string"}}}}}}}}, "required": ["requester_id", "message", "responder_request_targets"]}',  # noqa: E501
    "SNOOZEINCIDENT": '{"type": "object", "properties": {"duration": {"type": "integer", "description": "The number of seconds to snooze the incident for. After this number of seconds has elapsed, the incident will return to the "triggered" state.", "minimum": 1, "maximum": 604800}}, "required": ["duration"]}',  # noqa: E501
    "UPDATEINCIDENTSTATUS": '{"type": "object", "properties": {"message": {"type": "string", "description": "The message to be posted as a status update."}, "subject": {"type": "string", "description": "The subject to be sent for the custom html email status update. Required if sending custom html email."}, "html_message": {"type": "string", "description": "The html content to be sent for the custom html email status update. Required if sending custom html email."}}, "required": ["message"]}',  # noqa: E501
    "SUBSCRIBEINCIDENTNOTIFICATIONS": '{"type": "object", "properties": {"subscribers": {"type": "array", "uniqueItems": true, "minItems": 1, "items": {"title": "NotificationSubscriber", "description": "A reference of a subscriber entity.", "type": "object", "properties": {"subscriber_id": {"type": "string", "description": "The ID of the entity being subscribed"}, "subscriber_type": {"type": "string", "description": "The type of the entity being subscribed", "enum": ["user", "team"]}}, "example": {"subscriber_id": "PD1234", "subscriber_type": "user"}}}}, "required": ["subscribers"]}',  # noqa: E501
    "UNSUBSCRIBEINCIDENTNOTIFICATION": '{"type": "object", "properties": {"subscribers": {"type": "array", "uniqueItems": true, "minItems": 1, "items": {"title": "NotificationSubscriber", "description": "A reference of a subscriber entity.", "type": "object", "properties": {"subscriber_id": {"type": "string", "description": "The ID of the entity being subscribed"}, "subscriber_type": {"type": "string", "description": "The type of the entity being subscribed", "enum": ["user", "team"]}}, "example": {"subscriber_id": "PD1234", "subscriber_type": "user"}}}}, "required": ["subscribers"]}',  # noqa: E501
    "CREATEINCIDENTTYPE": '{"type": "object", "properties": {"incident_type": {"type": "object", "description": "Details of the incident type to be created.", "properties": {"name": {"type": "string", "description": "The name of the Incident Type. Usage of the suffix `_default` is prohibited. This cannot be changed once the incident type has been created.", "maxLength": 50}, "display_name": {"type": "string", "description": "The display name of the Incident Type. Usage of the prefix `PD`, `PagerDuty`, `Default` is prohibited.", "maxLength": 50}, "parent_type": {"type": "string", "description": "The parent type of the Incident Type. Either name or id of the parent type can be used."}, "enabled": {"type": "boolean", "description": "Whether the Incident Type is enabled. Defaults to true if not provided."}, "description": {"type": "string", "description": "The description of the Incident Type.", "maxLength": 1000}}, "required": ["name", "display_name", "parent_type"]}}, "required": ["incident_type"]}',  # noqa: E501
    "UPDATEINCIDENTTYPE": '{"type": "object", "properties": {"incident_type": {"type": "object", "description": "Details of the incident type to be created.", "properties": {"display_name": {"type": "string", "description": "The display name of the Incident Type.", "maxLength": 50}, "enabled": {"type": "boolean", "description": "Whether the Incident Type is enabled. Defaults to true if not provided."}, "description": {"type": "string", "description": "The description of the Incident Type.", "maxLength": 1000}}}}, "required": ["incident_type"]}',  # noqa: E501
    "CREATEINCIDENTTYPECUSTOMFIELD": '{"type": "object", "properties": {"field": {"type": "object", "description": "Details of the custom field to be created.", "properties": {"name": {"type": "string", "description": "The name of the custom field.", "maxLength": 50}, "display_name": {"type": "string", "description": "The display name of the Incident Type.", "maxLength": 50}, "data_type": {"type": "string", "description": "The data type of the custom field."}, "field_type": {"type": "string", "description": "The field type of the custom field.", "enum": ["single_value", "single_value_fixed", "multi_value", "multi_value_fixed"]}, "description": {"type": "string", "description": "The description of the custom field.", "maxLength": 1000}, "enabled": {"type": "boolean", "description": "Whether the custom field is enabled."}, "default_value": {"type": "string", "description": "The default value of the custom field."}, "field_options": {"type": "array", "items": {"allOf": [{"type": "object", "properties": {"data": {"oneOf": [{"type": "object", "properties": {"data_type": {"type": "string", "description": "The kind of data represented by this option. Must match the Field\'s `data_type`.", "enum": ["string"]}, "value": {"type": "string", "maxLength": 200}}, "required": ["data_type", "value"]}], "discriminator": {"propertyName": "data_type", "mapping": {"string": "#/paths/~1incidents~1custom_fields/get/responses/200/content/application~1json/schema/allOf/0/properties/fields/items/allOf/0/properties/field_options/items/allOf/0/properties/data/oneOf/0"}}}, "id": {"type": "string", "readOnly": true, "description": "The ID of the resource."}, "type": {"type": "string", "enum": ["field_option"], "readOnly": true}, "updated_at": {"type": "string", "format": "date-time", "description": "The date/time the object was last updated.", "readOnly": true}, "created_at": {"type": "string", "format": "date-time", "description": "The date/time the object was created at.", "readOnly": true}}, "required": ["id", "type", "created_at", "updated_at"], "description": ""}, {"type": "object", "required": ["id", "data", "created_at", "updated_at"]}]}, "description": "The options for the custom field. Can only be applied to fields with a `field_type` of `single_value_fixed` or `multi_value_fixed`. When creating a fixed-value custom field, this property is required, as the field must be created with at least one field option."}}, "required": ["name", "display_name", "data_type", "field_type"]}}, "required": ["field"]}',  # noqa: E501
    "UPDATEINCIDENTCUSTOMFIELD": '{"type": "object", "properties": {"field": {"type": "object", "description": "Details of the custom field to be updated.", "properties": {"display_name": {"type": "string", "description": "The display name of the Incident Type.", "maxLength": 50}, "enabled": {"type": "boolean", "description": "Whether the Incident Type is enabled."}, "default_value": {"type": "string", "description": "The default value of the custom field."}, "description": {"type": "string", "description": "The description of the custom field.", "maxLength": 1000}, "field_options": {"type": "array", "items": {"allOf": [{"type": "object", "properties": {"data": {"oneOf": [{"type": "object", "properties": {"data_type": {"type": "string", "description": "The kind of data represented by this option. Must match the Field\'s `data_type`.", "enum": ["string"]}, "value": {"type": "string", "maxLength": 200}}, "required": ["data_type", "value"]}], "discriminator": {"propertyName": "data_type", "mapping": {"string": "#/paths/~1incidents~1custom_fields/get/responses/200/content/application~1json/schema/allOf/0/properties/fields/items/allOf/0/properties/field_options/items/allOf/0/properties/data/oneOf/0"}}}, "id": {"type": "string", "readOnly": true, "description": "The ID of the resource."}, "type": {"type": "string", "enum": ["field_option"], "readOnly": true}, "updated_at": {"type": "string", "format": "date-time", "description": "The date/time the object was last updated.", "readOnly": true}, "created_at": {"type": "string", "format": "date-time", "description": "The date/time the object was created at.", "readOnly": true}}, "required": ["id", "type", "created_at", "updated_at"], "description": ""}, {"type": "object", "required": ["id", "data", "created_at", "updated_at"]}]}, "description": "List of options to upsert on the custom field. Can only be applied to fields with a `field_type` of `single_value_fixed` or `multi_value_fixed`. When an `id` property is included, this will update the value of the specified field option. Without an `id` property, that field option will be added to the field. Any existing field options not included in the upsert list will be deleted (unless the current default value refers to a field option to be deleted)."}}}}, "required": ["field"]}',  # noqa: E501
    "CREATECUSTOMFIELDOPTION": '{"type": "object", "properties": {"field_option": {"type": "object", "description": "Details of the field option to be created.", "properties": {"data": {"type": "object", "properties": {"data_type": {"type": "string", "description": "The data type of the Field Option for the Custom Field."}, "value": {"type": "string", "description": "The value of the Field Option for the Custom Field."}}, "required": ["data_type", "value"]}}, "required": ["data"]}}, "required": ["field_option"]}',  # noqa: E501
    "UPDATECUSTOMFIELDOPTION": '{"type": "object", "properties": {"field_option": {"type": "object", "description": "Details of the field option on a custom field to be updated.", "properties": {"data": {"type": "object", "properties": {"data_type": {"type": "string", "description": "The data type of the Field Option on the Custom Field."}, "value": {"type": "string", "description": "The value of the Field Option on the Custom Field."}}, "required": ["data_type", "value"]}}, "required": ["data"]}}, "required": ["field_option"]}',  # noqa: E501
    "UPDATEINCIDENTLOGENTRY": '{"type": "object", "properties": {"channel": {"type": "object", "description": "The parameters to update.", "properties": {"details": {"type": "string", "description": "New channel details"}, "type": {"type": "string", "description": "Channel type. Cannot be changed and must match the present value.", "enum": ["web_trigger", "mobile"]}}, "required": ["type", "details"]}}, "required": ["channel"]}',  # noqa: E501
    "CREATEMAINTENANCEWINDOW": '{"type": "object", "properties": {"maintenance_window": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "description": "The type of object being created.", "default": "maintenance_window", "enum": ["maintenance_window"]}, "sequence_number": {"type": "integer", "readOnly": true, "description": "The order in which the maintenance window was created."}, "start_time": {"type": "string", "format": "date-time", "description": "This maintenance window\'s start time. This is when the services will stop creating incidents. If this date is in the past, it will be updated to be the current time."}, "end_time": {"type": "string", "format": "date-time", "description": "This maintenance window\'s end time. This is when the services will start creating incidents again. This date must be in the future and after the `start_time`."}, "description": {"type": "string", "description": "A description for this maintenance window."}, "created_by": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}, "services": {"type": "array", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["service_reference"]}}}]}}, "teams": {"type": "array", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["team_reference"]}}}]}, "readOnly": true}}, "required": ["start_time", "end_time", "services", "type"], "example": {"id": "PIJ89JD", "type": "maintenance_window", "start_time": "2015-11-09T20:00:00-05:00", "end_time": "2015-11-09T22:00:00-05:00", "description": "Immanentizing the eschaton", "services": [{"id": "PIJ90N7", "type": "service_reference"}]}}]}}, "required": ["maintenance_window"]}',  # noqa: E501
    "UPDATEMAINTENANCEWINDOW": '{"type": "object", "properties": {"maintenance_window": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "description": "The type of object being created.", "default": "maintenance_window", "enum": ["maintenance_window"]}, "sequence_number": {"type": "integer", "readOnly": true, "description": "The order in which the maintenance window was created."}, "start_time": {"type": "string", "format": "date-time", "description": "This maintenance window\'s start time. This is when the services will stop creating incidents. If this date is in the past, it will be updated to be the current time."}, "end_time": {"type": "string", "format": "date-time", "description": "This maintenance window\'s end time. This is when the services will start creating incidents again. This date must be in the future and after the `start_time`."}, "description": {"type": "string", "description": "A description for this maintenance window."}, "created_by": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}, "services": {"type": "array", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["service_reference"]}}}]}}, "teams": {"type": "array", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["team_reference"]}}}]}, "readOnly": true}}, "required": ["start_time", "end_time", "services", "type"], "example": {"id": "PIJ89JD", "type": "maintenance_window", "start_time": "2015-11-09T20:00:00-05:00", "end_time": "2015-11-09T22:00:00-05:00", "description": "Immanentizing the eschaton", "services": [{"id": "PIJ90N7", "type": "service_reference"}]}}]}}, "required": ["maintenance_window"]}',  # noqa: E501
    "CREATERULESET": '{"type": "object", "properties": {"ruleset": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true, "description": "ID of the Ruleset."}, "self": {"type": "string", "format": "url", "description": "the API show URL at which the object is accessible", "readOnly": true}, "type": {"type": "string", "readOnly": true, "enum": ["global", "default_global"]}, "name": {"type": "string", "description": "Name of the Ruleset."}, "routing_keys": {"type": "array", "readOnly": true, "description": "Routing keys routed to this Ruleset.", "items": {"type": "string"}}, "created_at": {"type": "string", "format": "date-time", "readOnly": true, "description": "The date the Ruleset was created at."}, "creator": {"type": "object", "readOnly": true, "description": "Reference to the user that has created the Ruleset.", "properties": {"id": {"type": "string", "readOnly": true}, "type": {"type": "string", "description": "A string that determines the schema of the object", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}}, "updated_at": {"type": "string", "format": "date-time", "readOnly": true, "description": "The date the Ruleset was last updated."}, "updater": {"type": "object", "readOnly": true, "description": "Reference to the user that has updated the Ruleset last.", "properties": {"id": {"type": "string", "readOnly": true}, "type": {"type": "string", "description": "A string that determines the schema of the object", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}}, "team": {"type": "object", "description": "Reference to the team that owns the Ruleset. If none is specified, only admins have access.", "properties": {"id": {"type": "string"}, "type": {"type": "string", "description": "A string that determines the schema of the object", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}, "required": ["id", "type"]}}, "example": {"id": "0e84de00-9511-4380-9f4f-a7b568bb49a0", "name": "MySQL Clusters", "type": "global", "routing_keys": ["R0212P1QXGEIQE2NMTQ7L7WXD00DWHIN"], "self": "https://api.pagerduty.com/rulesets/0e84de00-9511-4380-9f4f-a7b568bb49a0", "created_at": "2019-12-24T21:18:52Z", "creator": {"type": "user_reference", "self": "https://api.pagerduty.com/users/PABO808", "id": "PABO808"}, "updated_at": "2019-12-25T14:54:23Z", "updater": {"type": "user_reference", "self": "https://api.pagerduty.com/users/PABO808", "id": "PABO808"}, "team": {"type": "team_reference", "self": "https://api.pagerduty.com/teams/P3ZQXDF", "id": "P3ZQXDF"}}}, {"type": "object", "required": ["name"]}]}}, "required": ["ruleset"]}',  # noqa: E501
    "UPDATERULESET": '{"type": "object", "properties": {"ruleset": {"type": "object", "properties": {"id": {"type": "string", "readOnly": true, "description": "ID of the Ruleset."}, "self": {"type": "string", "format": "url", "description": "the API show URL at which the object is accessible", "readOnly": true}, "type": {"type": "string", "readOnly": true, "enum": ["global", "default_global"]}, "name": {"type": "string", "description": "Name of the Ruleset."}, "routing_keys": {"type": "array", "readOnly": true, "description": "Routing keys routed to this Ruleset.", "items": {"type": "string"}}, "created_at": {"type": "string", "format": "date-time", "readOnly": true, "description": "The date the Ruleset was created at."}, "creator": {"type": "object", "readOnly": true, "description": "Reference to the user that has created the Ruleset.", "properties": {"id": {"type": "string", "readOnly": true}, "type": {"type": "string", "description": "A string that determines the schema of the object", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}}, "updated_at": {"type": "string", "format": "date-time", "readOnly": true, "description": "The date the Ruleset was last updated."}, "updater": {"type": "object", "readOnly": true, "description": "Reference to the user that has updated the Ruleset last.", "properties": {"id": {"type": "string", "readOnly": true}, "type": {"type": "string", "description": "A string that determines the schema of the object", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}}, "team": {"type": "object", "description": "Reference to the team that owns the Ruleset. If none is specified, only admins have access.", "properties": {"id": {"type": "string"}, "type": {"type": "string", "description": "A string that determines the schema of the object", "readOnly": true}, "self": {"type": "string", "format": "url", "description": "The API show URL at which the object is accessible", "readOnly": true}}, "required": ["id", "type"]}}, "example": {"id": "0e84de00-9511-4380-9f4f-a7b568bb49a0", "name": "MySQL Clusters", "type": "global", "routing_keys": ["R0212P1QXGEIQE2NMTQ7L7WXD00DWHIN"], "self": "https://api.pagerduty.com/rulesets/0e84de00-9511-4380-9f4f-a7b568bb49a0", "created_at": "2019-12-24T21:18:52Z", "creator": {"type": "user_reference", "self": "https://api.pagerduty.com/users/PABO808", "id": "PABO808"}, "updated_at": "2019-12-25T14:54:23Z", "updater": {"type": "user_reference", "self": "https://api.pagerduty.com/users/PABO808", "id": "PABO808"}, "team": {"type": "team_reference", "self": "https://api.pagerduty.com/teams/P3ZQXDF", "id": "P3ZQXDF"}}}}, "required": ["ruleset"]}',  # noqa: E501
    "CREATEEVENTRULE": '{"type": "object", "properties": {"rule": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true, "description": "ID of the Event Rule."}, "self": {"type": "string", "format": "url", "description": "the API show URL at which the object is accessible.", "readOnly": true}, "disabled": {"type": "boolean", "description": "Indicates whether the Event Rule is disabled and would therefore not be evaluated."}, "conditions": {"type": "object", "description": "Conditions evaluated to check if an event matches this Event Rule. Is always empty for the catch_all rule, though.", "properties": {"operator": {"type": "string", "description": "Operator to combine sub-conditions.", "enum": ["and", "or"]}, "subconditions": {"type": "array", "description": "Array of sub-conditions.", "items": {"type": "object", "properties": {"operator": {"type": "string", "description": "The type of operator to apply.", "enum": ["exists", "nexists", "equals", "nequals", "contains", "ncontains", "matches", "nmatches"]}, "parameters": {"type": "object", "properties": {"path": {"type": "string", "description": "Path to a field in an event, in dot-notation.  For Event Rules on a serivce, this will have to be a PD-CEF field."}, "value": {"type": "string", "description": "Value to apply to the operator."}, "options": {"type": "object", "description": "Options to configure the operator."}}, "required": ["value", "path"]}}, "required": ["operator", "parameters"]}}}, "required": ["operator", "subconditions"]}, "time_frame": {"description": "Time-based conditions for limiting when the rule is active.", "type": "object", "properties": {"active_between": {"type": "object", "required": ["start_time", "end_time"], "description": "A fixed window of time during which the rule is active.", "properties": {"start_time": {"type": "integer", "description": "The start time in milliseconds."}, "end_time": {"type": "integer", "description": "End time in milliseconds."}}}, "scheduled_weekly": {"type": "object", "required": ["start_time", "duration", "timezone", "weekdays"], "description": "A reccuring window of time based on the day of the week, during which the rule is active.", "properties": {"start_time": {"type": "integer", "description": "The amount of milliseconds into the day at which the window starts."}, "duration": {"type": "integer", "description": "The duration of the window in milliseconds."}, "timezone": {"type": "string", "description": "The timezone."}, "weekdays": {"type": "array", "description": "An array of day values. Ex [1, 3, 5] is Monday, Wednesday, Friday.", "items": {"type": "integer"}}}}}}, "variables": {"type": "array", "description": "[Early Access] Populate variables from event payloads and use those variables in other event actions.", "items": {"type": "object", "properties": {"type": {"type": "string", "description": "The type of operation to populate the variable.", "enum": ["regex"]}, "name": {"type": "string", "description": "The name of the variable."}, "parameters": {"type": "object", "description": "The parameters for performing the operation to populate the", "properties": {"value": {"type": "string", "description": "The value for the operation. For example, an RE2 regular expression for regex-type variables."}, "path": {"type": "string", "description": "Path to a field in an event, in dot-notation. For Event Rules on a Service, this will have to be a PD-CEF field."}}, "required": ["value", "path"]}}, "required": ["type", "name", "parameters"]}}}}, {"type": "object", "properties": {"position": {"type": "integer", "description": "Position/index of the Event Rule in the Ruleset.  Starting from position 0 (the first rule), rules are evaluated one-by-one until a matching rule is found."}, "catch_all": {"type": "boolean", "readOnly": true, "description": "Indicates whether the Event Rule is the last Event Rule of the Ruleset that serves as a catch-all. It has limited functionality compared to other rules and always matches."}, "actions": {"description": "When an event matches this rule, the actions that will be taken to change the resulting alert and incident.", "allOf": [{"type": "object", "description": "When an event matches this Event Rule, the actions that will be taken to change the resulting Alert and Incident.", "properties": {"annotate": {"description": "Set a note on the resulting incident.", "type": "object", "nullable": true, "required": ["value"], "properties": {"value": {"type": "string", "description": "The content of the note."}}}, "event_action": {"description": "Set whether the resulting alert status is trigger or resolve.", "type": "object", "required": ["value"], "nullable": true, "properties": {"value": {"type": "string", "enum": ["trigger", "resolve"]}}}, "extractions": {"type": "array", "description": "Dynamically extract values to set and modify new and existing PD-CEF fields.", "items": {"oneOf": [{"type": "object", "required": ["target", "source", "regex"], "properties": {"target": {"type": "string", "description": "The PD-CEF field that will be set with the value from the regex."}, "source": {"type": "string", "description": "The path to the event field where the regex will be applied to extract a value."}, "regex": {"type": "string", "description": "A RE2 regular expression.  If it contains one or more capture groups, their values will be extracted and appended together.  If it contains no capture groups, the whole match is used."}}}, {"type": "object", "required": ["target", "template"], "properties": {"target": {"type": "string", "description": "The PD-CEF field that will be set with the value from the regex."}, "template": {"type": "string", "description": "A value that will be used to populate the target PD-CEF field.  You can include variables extracted from the payload by using string interpolation.", "example": "Error number {{count}} on host {{host}}"}}}]}}, "priority": {"description": "Set the priority ID for the resulting incident. You can find the priority you want by calling the priorities endpoint.", "type": "object", "required": ["value"], "nullable": true, "properties": {"value": {"type": "string", "description": "The priority ID."}}}, "severity": {"description": "Set the severity of the resulting alert.", "type": "object", "required": ["value"], "nullable": true, "properties": {"value": {"type": "string", "enum": ["info", "warning", "error", "critical"]}}}, "suppress": {"description": "Set whether the resulting alert is suppressed. Can optionally be used with a threshold where resulting alerts will be suppressed until the threshold is met in a window of time. If using a threshold the rule must also set a route action.", "type": "object", "required": ["value"], "properties": {"value": {"type": "boolean"}, "threshold_value": {"type": "integer", "description": "The number of occurences needed during the window of time to trigger the theshold."}, "threshold_time_unit": {"type": "string", "description": "The time unit for the window of time.", "enum": ["seconds", "minutes", "hours"]}, "threshold_time_amount": {"type": "integer", "description": "The amount of time units for the window of time."}}}, "suspend": {"description": "Set the length of time to suspend the resulting alert before triggering. Rules with a suspend action must also set a route action, and cannot have a suppress with threshold action", "type": "object", "required": ["value"], "nullable": true, "properties": {"value": {"type": "integer", "description": "The amount of time to suspend the alert in seconds."}}}}}, {"type": "object", "properties": {"route": {"description": "Set the service ID of the target service for the resulting alert. You can find the service you want to route to by calling the services endpoint.", "type": "object", "required": ["value"], "nullable": true, "properties": {"value": {"type": "string", "description": "The target service\'s ID."}}}}}]}}}]}}, "required": ["rule"]}',  # noqa: E501
    "UPDATEEVENTRULE": '{"type": "object", "properties": {"rule": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true, "description": "ID of the Event Rule."}, "self": {"type": "string", "format": "url", "description": "the API show URL at which the object is accessible.", "readOnly": true}, "disabled": {"type": "boolean", "description": "Indicates whether the Event Rule is disabled and would therefore not be evaluated."}, "conditions": {"type": "object", "description": "Conditions evaluated to check if an event matches this Event Rule. Is always empty for the catch_all rule, though.", "properties": {"operator": {"type": "string", "description": "Operator to combine sub-conditions.", "enum": ["and", "or"]}, "subconditions": {"type": "array", "description": "Array of sub-conditions.", "items": {"type": "object", "properties": {"operator": {"type": "string", "description": "The type of operator to apply.", "enum": ["exists", "nexists", "equals", "nequals", "contains", "ncontains", "matches", "nmatches"]}, "parameters": {"type": "object", "properties": {"path": {"type": "string", "description": "Path to a field in an event, in dot-notation.  For Event Rules on a serivce, this will have to be a PD-CEF field."}, "value": {"type": "string", "description": "Value to apply to the operator."}, "options": {"type": "object", "description": "Options to configure the operator."}}, "required": ["value", "path"]}}, "required": ["operator", "parameters"]}}}, "required": ["operator", "subconditions"]}, "time_frame": {"description": "Time-based conditions for limiting when the rule is active.", "type": "object", "properties": {"active_between": {"type": "object", "required": ["start_time", "end_time"], "description": "A fixed window of time during which the rule is active.", "properties": {"start_time": {"type": "integer", "description": "The start time in milliseconds."}, "end_time": {"type": "integer", "description": "End time in milliseconds."}}}, "scheduled_weekly": {"type": "object", "required": ["start_time", "duration", "timezone", "weekdays"], "description": "A reccuring window of time based on the day of the week, during which the rule is active.", "properties": {"start_time": {"type": "integer", "description": "The amount of milliseconds into the day at which the window starts."}, "duration": {"type": "integer", "description": "The duration of the window in milliseconds."}, "timezone": {"type": "string", "description": "The timezone."}, "weekdays": {"type": "array", "description": "An array of day values. Ex [1, 3, 5] is Monday, Wednesday, Friday.", "items": {"type": "integer"}}}}}}, "variables": {"type": "array", "description": "[Early Access] Populate variables from event payloads and use those variables in other event actions.", "items": {"type": "object", "properties": {"type": {"type": "string", "description": "The type of operation to populate the variable.", "enum": ["regex"]}, "name": {"type": "string", "description": "The name of the variable."}, "parameters": {"type": "object", "description": "The parameters for performing the operation to populate the", "properties": {"value": {"type": "string", "description": "The value for the operation. For example, an RE2 regular expression for regex-type variables."}, "path": {"type": "string", "description": "Path to a field in an event, in dot-notation. For Event Rules on a Service, this will have to be a PD-CEF field."}}, "required": ["value", "path"]}}, "required": ["type", "name", "parameters"]}}}}, {"type": "object", "properties": {"position": {"type": "integer", "description": "Position/index of the Event Rule in the Ruleset.  Starting from position 0 (the first rule), rules are evaluated one-by-one until a matching rule is found."}, "catch_all": {"type": "boolean", "readOnly": true, "description": "Indicates whether the Event Rule is the last Event Rule of the Ruleset that serves as a catch-all. It has limited functionality compared to other rules and always matches."}, "actions": {"description": "When an event matches this rule, the actions that will be taken to change the resulting alert and incident.", "allOf": [{"type": "object", "description": "When an event matches this Event Rule, the actions that will be taken to change the resulting Alert and Incident.", "properties": {"annotate": {"description": "Set a note on the resulting incident.", "type": "object", "nullable": true, "required": ["value"], "properties": {"value": {"type": "string", "description": "The content of the note."}}}, "event_action": {"description": "Set whether the resulting alert status is trigger or resolve.", "type": "object", "required": ["value"], "nullable": true, "properties": {"value": {"type": "string", "enum": ["trigger", "resolve"]}}}, "extractions": {"type": "array", "description": "Dynamically extract values to set and modify new and existing PD-CEF fields.", "items": {"oneOf": [{"type": "object", "required": ["target", "source", "regex"], "properties": {"target": {"type": "string", "description": "The PD-CEF field that will be set with the value from the regex."}, "source": {"type": "string", "description": "The path to the event field where the regex will be applied to extract a value."}, "regex": {"type": "string", "description": "A RE2 regular expression.  If it contains one or more capture groups, their values will be extracted and appended together.  If it contains no capture groups, the whole match is used."}}}, {"type": "object", "required": ["target", "template"], "properties": {"target": {"type": "string", "description": "The PD-CEF field that will be set with the value from the regex."}, "template": {"type": "string", "description": "A value that will be used to populate the target PD-CEF field.  You can include variables extracted from the payload by using string interpolation.", "example": "Error number {{count}} on host {{host}}"}}}]}}, "priority": {"description": "Set the priority ID for the resulting incident. You can find the priority you want by calling the priorities endpoint.", "type": "object", "required": ["value"], "nullable": true, "properties": {"value": {"type": "string", "description": "The priority ID."}}}, "severity": {"description": "Set the severity of the resulting alert.", "type": "object", "required": ["value"], "nullable": true, "properties": {"value": {"type": "string", "enum": ["info", "warning", "error", "critical"]}}}, "suppress": {"description": "Set whether the resulting alert is suppressed. Can optionally be used with a threshold where resulting alerts will be suppressed until the threshold is met in a window of time. If using a threshold the rule must also set a route action.", "type": "object", "required": ["value"], "properties": {"value": {"type": "boolean"}, "threshold_value": {"type": "integer", "description": "The number of occurences needed during the window of time to trigger the theshold."}, "threshold_time_unit": {"type": "string", "description": "The time unit for the window of time.", "enum": ["seconds", "minutes", "hours"]}, "threshold_time_amount": {"type": "integer", "description": "The amount of time units for the window of time."}}}, "suspend": {"description": "Set the length of time to suspend the resulting alert before triggering. Rules with a suspend action must also set a route action, and cannot have a suppress with threshold action", "type": "object", "required": ["value"], "nullable": true, "properties": {"value": {"type": "integer", "description": "The amount of time to suspend the alert in seconds."}}}}}, {"type": "object", "properties": {"route": {"description": "Set the service ID of the target service for the resulting alert. You can find the service you want to route to by calling the services endpoint.", "type": "object", "required": ["value"], "nullable": true, "properties": {"value": {"type": "string", "description": "The target service\'s ID."}}}}}]}}}]}, "rule_id": {"description": "The id of the Event Rule to update.", "type": "string"}}, "required": ["rule_id"]}',  # noqa: E501
    "CREATEONCALLSCHEDULE": '{"type": "object", "properties": {"schedule": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "description": "The type of object being created.", "default": "schedule", "enum": ["schedule"]}, "schedule_layers": {"type": "array", "description": "A list of schedule layers.", "items": {"type": "object", "properties": {"id": {"type": "string"}, "start": {"type": "string", "format": "date-time", "description": "The start time of this layer."}, "end": {"type": "string", "format": "date-time", "description": "The end time of this layer. If `null`, the layer does not end."}, "users": {"type": "array", "description": "The ordered list of users on this layer. The position of the user on the list determines their order in the layer.", "items": {"type": "object", "properties": {"user": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}}, "required": ["user"]}}, "restrictions": {"type": "array", "description": "An array of restrictions for the layer. A restriction is a limit on which period of the day or week the schedule layer can accept assignments. Restrictions respect the `time_zone` parameter of the request.", "items": {"type": "object", "properties": {"type": {"type": "string", "description": "Specify the types of `restriction`.", "enum": ["daily_restriction", "weekly_restriction"]}, "duration_seconds": {"type": "integer", "description": "The duration of the restriction in seconds."}, "start_time_of_day": {"type": "string", "format": "partial-time", "description": "The start time in HH:mm:ss format."}, "start_day_of_week": {"type": "integer", "description": "Only required for use with a `weekly_restriction` restriction type. The first day of the weekly rotation schedule as [ISO 8601 day](https://en.wikipedia.org/wiki/ISO_week_date) (1 is Monday, etc.)", "minimum": 1, "maximum": 7}}, "discriminator": {"propertyName": "type"}, "required": ["type", "duration_seconds", "start_time_of_day"]}}, "rotation_virtual_start": {"type": "string", "format": "date-time", "description": "The effective start time of the layer. This can be before the start time of the schedule."}, "rotation_turn_length_seconds": {"type": "integer", "description": "The duration of each on-call shift in seconds."}, "name": {"type": "string", "description": "The name of the schedule layer."}, "rendered_schedule_entries": {"type": "array", "readOnly": true, "description": "This is a list of entries on the computed layer for the current time range. Since or until must be set in order for this field to be populated.", "items": {"type": "object", "properties": {"user": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}, "start": {"type": "string", "format": "date-time", "readOnly": true, "description": "The start time of this entry."}, "end": {"type": "string", "format": "date-time", "readOnly": true, "description": "The end time of this entry. If null, the entry does not end."}}, "required": ["start", "end"]}}, "rendered_coverage_percentage": {"type": "number", "readOnly": true, "description": "The percentage of the time range covered by this layer. Returns null unless since or until are set."}}, "required": ["start", "users", "rotation_virtual_start", "rotation_turn_length_seconds"]}}, "time_zone": {"type": "string", "format": "activesupport-time-zone", "description": "The time zone of the schedule."}, "name": {"type": "string", "description": "The name of the schedule"}, "description": {"type": "string", "description": "The description of the schedule"}, "final_schedule": {"type": "object", "properties": {"name": {"type": "string", "readOnly": true, "description": "The name of the subschedule", "enum": ["Final Schedule", "Overrides"]}, "rendered_schedule_entries": {"type": "array", "readOnly": true, "description": "This is a list of entries on the computed layer for the current time range. Since or until must be set in order for this field to be populated.", "items": {"type": "object", "properties": {"user": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}, "start": {"type": "string", "format": "date-time", "readOnly": true, "description": "The start time of this entry."}, "end": {"type": "string", "format": "date-time", "readOnly": true, "description": "The end time of this entry. If null, the entry does not end."}}, "required": ["start", "end"]}}, "rendered_coverage_percentage": {"type": "number", "readOnly": true, "description": "The percentage of the time range covered by this layer. Returns null unless since or until are set."}}, "required": ["name"]}, "overrides_subschedule": {"type": "object", "properties": {"name": {"type": "string", "readOnly": true, "description": "The name of the subschedule", "enum": ["Final Schedule", "Overrides"]}, "rendered_schedule_entries": {"type": "array", "readOnly": true, "description": "This is a list of entries on the computed layer for the current time range. Since or until must be set in order for this field to be populated.", "items": {"type": "object", "properties": {"user": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}, "start": {"type": "string", "format": "date-time", "readOnly": true, "description": "The start time of this entry."}, "end": {"type": "string", "format": "date-time", "readOnly": true, "description": "The end time of this entry. If null, the entry does not end."}}, "required": ["start", "end"]}}, "rendered_coverage_percentage": {"type": "number", "readOnly": true, "description": "The percentage of the time range covered by this layer. Returns null unless since or until are set."}}, "required": ["name"]}, "escalation_policies": {"type": "array", "readOnly": true, "description": "An array of all of the escalation policies that uses this schedule.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["escalation_policy_reference"]}}}]}}, "users": {"type": "array", "readOnly": true, "description": "An array of all of the users on the schedule.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}}, "teams": {"type": "array", "readOnly": true, "description": "An array of all of the teams on the schedule.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["team_reference"]}}}]}}, "next_oncall_for_user": {"type": "object", "properties": {"start": {"type": "string", "readOnly": true, "description": "The start date for the User shift"}, "end": {"type": "string", "readOnly": true, "description": "The end date for the User shift"}, "user": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}}}}, "required": ["time_zone", "type"], "example": {"name": "Daily Engineering Rotation", "type": "schedule", "time_zone": "America/New_York", "description": "Rotation schedule for engineering", "schedule_layers": [{"name": "Night Shift", "start": "2015-11-06T20:00:00-05:00", "end": "2016-11-06T20:00:00-05:00", "rotation_virtual_start": "2015-11-06T20:00:00-05:00", "rotation_turn_length_seconds": 86400, "users": [{"user": {"id": "PXPGF42", "type": "user_reference"}}], "restrictions": [{"type": "daily_restriction", "start_time_of_day": "08:00:00", "duration_seconds": 32400}]}]}}]}}, "required": ["schedule"]}',  # noqa: E501
    "UPDATEONCALLSCHEDULE": '{"type": "object", "properties": {"schedule": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "description": "The type of object being created.", "default": "schedule", "enum": ["schedule"]}, "schedule_layers": {"type": "array", "description": "A list of schedule layers.", "items": {"type": "object", "properties": {"id": {"type": "string"}, "start": {"type": "string", "format": "date-time", "description": "The start time of this layer."}, "end": {"type": "string", "format": "date-time", "description": "The end time of this layer. If `null`, the layer does not end."}, "users": {"type": "array", "description": "The ordered list of users on this layer. The position of the user on the list determines their order in the layer.", "items": {"type": "object", "properties": {"user": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}}, "required": ["user"]}}, "restrictions": {"type": "array", "description": "An array of restrictions for the layer. A restriction is a limit on which period of the day or week the schedule layer can accept assignments. Restrictions respect the `time_zone` parameter of the request.", "items": {"type": "object", "properties": {"type": {"type": "string", "description": "Specify the types of `restriction`.", "enum": ["daily_restriction", "weekly_restriction"]}, "duration_seconds": {"type": "integer", "description": "The duration of the restriction in seconds."}, "start_time_of_day": {"type": "string", "format": "partial-time", "description": "The start time in HH:mm:ss format."}, "start_day_of_week": {"type": "integer", "description": "Only required for use with a `weekly_restriction` restriction type. The first day of the weekly rotation schedule as [ISO 8601 day](https://en.wikipedia.org/wiki/ISO_week_date) (1 is Monday, etc.)", "minimum": 1, "maximum": 7}}, "discriminator": {"propertyName": "type"}, "required": ["type", "duration_seconds", "start_time_of_day"]}}, "rotation_virtual_start": {"type": "string", "format": "date-time", "description": "The effective start time of the layer. This can be before the start time of the schedule."}, "rotation_turn_length_seconds": {"type": "integer", "description": "The duration of each on-call shift in seconds."}, "name": {"type": "string", "description": "The name of the schedule layer."}, "rendered_schedule_entries": {"type": "array", "readOnly": true, "description": "This is a list of entries on the computed layer for the current time range. Since or until must be set in order for this field to be populated.", "items": {"type": "object", "properties": {"user": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}, "start": {"type": "string", "format": "date-time", "readOnly": true, "description": "The start time of this entry."}, "end": {"type": "string", "format": "date-time", "readOnly": true, "description": "The end time of this entry. If null, the entry does not end."}}, "required": ["start", "end"]}}, "rendered_coverage_percentage": {"type": "number", "readOnly": true, "description": "The percentage of the time range covered by this layer. Returns null unless since or until are set."}}, "required": ["start", "users", "rotation_virtual_start", "rotation_turn_length_seconds"]}}, "time_zone": {"type": "string", "format": "activesupport-time-zone", "description": "The time zone of the schedule."}, "name": {"type": "string", "description": "The name of the schedule"}, "description": {"type": "string", "description": "The description of the schedule"}, "final_schedule": {"type": "object", "properties": {"name": {"type": "string", "readOnly": true, "description": "The name of the subschedule", "enum": ["Final Schedule", "Overrides"]}, "rendered_schedule_entries": {"type": "array", "readOnly": true, "description": "This is a list of entries on the computed layer for the current time range. Since or until must be set in order for this field to be populated.", "items": {"type": "object", "properties": {"user": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}, "start": {"type": "string", "format": "date-time", "readOnly": true, "description": "The start time of this entry."}, "end": {"type": "string", "format": "date-time", "readOnly": true, "description": "The end time of this entry. If null, the entry does not end."}}, "required": ["start", "end"]}}, "rendered_coverage_percentage": {"type": "number", "readOnly": true, "description": "The percentage of the time range covered by this layer. Returns null unless since or until are set."}}, "required": ["name"]}, "overrides_subschedule": {"type": "object", "properties": {"name": {"type": "string", "readOnly": true, "description": "The name of the subschedule", "enum": ["Final Schedule", "Overrides"]}, "rendered_schedule_entries": {"type": "array", "readOnly": true, "description": "This is a list of entries on the computed layer for the current time range. Since or until must be set in order for this field to be populated.", "items": {"type": "object", "properties": {"user": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}, "start": {"type": "string", "format": "date-time", "readOnly": true, "description": "The start time of this entry."}, "end": {"type": "string", "format": "date-time", "readOnly": true, "description": "The end time of this entry. If null, the entry does not end."}}, "required": ["start", "end"]}}, "rendered_coverage_percentage": {"type": "number", "readOnly": true, "description": "The percentage of the time range covered by this layer. Returns null unless since or until are set."}}, "required": ["name"]}, "escalation_policies": {"type": "array", "readOnly": true, "description": "An array of all of the escalation policies that uses this schedule.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["escalation_policy_reference"]}}}]}}, "users": {"type": "array", "readOnly": true, "description": "An array of all of the users on the schedule.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}}, "teams": {"type": "array", "readOnly": true, "description": "An array of all of the teams on the schedule.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["team_reference"]}}}]}}, "next_oncall_for_user": {"type": "object", "properties": {"start": {"type": "string", "readOnly": true, "description": "The start date for the User shift"}, "end": {"type": "string", "readOnly": true, "description": "The end date for the User shift"}, "user": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}}}}, "required": ["time_zone", "type"], "example": {"name": "Daily Engineering Rotation", "type": "schedule", "time_zone": "America/New_York", "description": "Rotation schedule for engineering", "schedule_layers": [{"name": "Night Shift", "start": "2015-11-06T20:00:00-05:00", "end": "2016-11-06T20:00:00-05:00", "rotation_virtual_start": "2015-11-06T20:00:00-05:00", "rotation_turn_length_seconds": 86400, "users": [{"user": {"id": "PXPGF42", "type": "user_reference"}}], "restrictions": [{"type": "daily_restriction", "start_time_of_day": "08:00:00", "duration_seconds": 32400}]}]}}]}}, "required": ["schedule"]}',  # noqa: E501
    "CREATESCHEDULEOVERRIDE": '{"description": "", "type": "object", "properties": {"overrides": {"type": "array", "items": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "start": {"description": "The start date and time for the override.", "type": "string", "format": "date-time"}, "end": {"description": "The end date and time for the override.", "type": "string", "format": "date-time"}, "user": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}}, "required": ["start", "end", "user"], "example": {"start": "2012-07-01T00:00:00-04:00", "end": "2012-07-02T00:00:00-04:00", "user": {"id": "PEYSGVF", "type": "user_reference"}}}]}}}}',  # noqa: E501
    "PREVIEWONCALLSCHEDULE": '{"type": "object", "properties": {"schedule": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "description": "The type of object being created.", "default": "schedule", "enum": ["schedule"]}, "schedule_layers": {"type": "array", "description": "A list of schedule layers.", "items": {"type": "object", "properties": {"id": {"type": "string"}, "start": {"type": "string", "format": "date-time", "description": "The start time of this layer."}, "end": {"type": "string", "format": "date-time", "description": "The end time of this layer. If `null`, the layer does not end."}, "users": {"type": "array", "description": "The ordered list of users on this layer. The position of the user on the list determines their order in the layer.", "items": {"type": "object", "properties": {"user": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}}, "required": ["user"]}}, "restrictions": {"type": "array", "description": "An array of restrictions for the layer. A restriction is a limit on which period of the day or week the schedule layer can accept assignments. Restrictions respect the `time_zone` parameter of the request.", "items": {"type": "object", "properties": {"type": {"type": "string", "description": "Specify the types of `restriction`.", "enum": ["daily_restriction", "weekly_restriction"]}, "duration_seconds": {"type": "integer", "description": "The duration of the restriction in seconds."}, "start_time_of_day": {"type": "string", "format": "partial-time", "description": "The start time in HH:mm:ss format."}, "start_day_of_week": {"type": "integer", "description": "Only required for use with a `weekly_restriction` restriction type. The first day of the weekly rotation schedule as [ISO 8601 day](https://en.wikipedia.org/wiki/ISO_week_date) (1 is Monday, etc.)", "minimum": 1, "maximum": 7}}, "discriminator": {"propertyName": "type"}, "required": ["type", "duration_seconds", "start_time_of_day"]}}, "rotation_virtual_start": {"type": "string", "format": "date-time", "description": "The effective start time of the layer. This can be before the start time of the schedule."}, "rotation_turn_length_seconds": {"type": "integer", "description": "The duration of each on-call shift in seconds."}, "name": {"type": "string", "description": "The name of the schedule layer."}, "rendered_schedule_entries": {"type": "array", "readOnly": true, "description": "This is a list of entries on the computed layer for the current time range. Since or until must be set in order for this field to be populated.", "items": {"type": "object", "properties": {"user": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}, "start": {"type": "string", "format": "date-time", "readOnly": true, "description": "The start time of this entry."}, "end": {"type": "string", "format": "date-time", "readOnly": true, "description": "The end time of this entry. If null, the entry does not end."}}, "required": ["start", "end"]}}, "rendered_coverage_percentage": {"type": "number", "readOnly": true, "description": "The percentage of the time range covered by this layer. Returns null unless since or until are set."}}, "required": ["start", "users", "rotation_virtual_start", "rotation_turn_length_seconds"]}}, "time_zone": {"type": "string", "format": "activesupport-time-zone", "description": "The time zone of the schedule."}, "name": {"type": "string", "description": "The name of the schedule"}, "description": {"type": "string", "description": "The description of the schedule"}, "final_schedule": {"type": "object", "properties": {"name": {"type": "string", "readOnly": true, "description": "The name of the subschedule", "enum": ["Final Schedule", "Overrides"]}, "rendered_schedule_entries": {"type": "array", "readOnly": true, "description": "This is a list of entries on the computed layer for the current time range. Since or until must be set in order for this field to be populated.", "items": {"type": "object", "properties": {"user": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}, "start": {"type": "string", "format": "date-time", "readOnly": true, "description": "The start time of this entry."}, "end": {"type": "string", "format": "date-time", "readOnly": true, "description": "The end time of this entry. If null, the entry does not end."}}, "required": ["start", "end"]}}, "rendered_coverage_percentage": {"type": "number", "readOnly": true, "description": "The percentage of the time range covered by this layer. Returns null unless since or until are set."}}, "required": ["name"]}, "overrides_subschedule": {"type": "object", "properties": {"name": {"type": "string", "readOnly": true, "description": "The name of the subschedule", "enum": ["Final Schedule", "Overrides"]}, "rendered_schedule_entries": {"type": "array", "readOnly": true, "description": "This is a list of entries on the computed layer for the current time range. Since or until must be set in order for this field to be populated.", "items": {"type": "object", "properties": {"user": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}, "start": {"type": "string", "format": "date-time", "readOnly": true, "description": "The start time of this entry."}, "end": {"type": "string", "format": "date-time", "readOnly": true, "description": "The end time of this entry. If null, the entry does not end."}}, "required": ["start", "end"]}}, "rendered_coverage_percentage": {"type": "number", "readOnly": true, "description": "The percentage of the time range covered by this layer. Returns null unless since or until are set."}}, "required": ["name"]}, "escalation_policies": {"type": "array", "readOnly": true, "description": "An array of all of the escalation policies that uses this schedule.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["escalation_policy_reference"]}}}]}}, "users": {"type": "array", "readOnly": true, "description": "An array of all of the users on the schedule.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["user_reference"]}}}]}}, "teams": {"type": "array", "readOnly": true, "description": "An array of all of the teams on the schedule.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["team_reference"]}}}]}}, "next_oncall_for_user": {"type": "object", "properties": {"start": {"type": "string", "readOnly": true, "description": "The start date for the User shift"}, "end": {"type": "string", "readOnly": true, "description": "The end date for the User shift"}, "user": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}}}}, "required": ["time_zone", "type"], "example": {"name": "Daily Engineering Rotation", "type": "schedule", "time_zone": "America/New_York", "description": "Rotation schedule for engineering", "schedule_layers": [{"name": "Night Shift", "start": "2015-11-06T20:00:00-05:00", "end": "2016-11-06T20:00:00-05:00", "rotation_virtual_start": "2015-11-06T20:00:00-05:00", "rotation_turn_length_seconds": 86400, "users": [{"user": {"id": "PXPGF42", "type": "user_reference"}}], "restrictions": [{"type": "daily_restriction", "start_time_of_day": "08:00:00", "duration_seconds": 32400}]}]}}]}}, "required": ["schedule"]}',  # noqa: E501
    "CREATESERVICEDEPENDENCY": '{"type": "object", "properties": {"relationships": {"type": "array", "description": "List of all service dependencies to be created.", "items": {"type": "object", "properties": {"supporting_service": {"type": "object", "description": "The reference to the service that supports the dependent service.", "properties": {"id": {"type": "string"}, "type": {"type": "string"}}}, "dependent_service": {"type": "object", "description": "The reference to the service that is dependent on the supporting service.", "properties": {"id": {"type": "string"}, "type": {"type": "string"}}}}}}}}',  # noqa: E501
    "REMOVESERVICEDEPENDENCY": '{"type": "object", "properties": {"relationships": {"type": "array", "description": "List of all service dependencies to be deleted.", "items": {"type": "object", "properties": {"supporting_service": {"type": "object", "description": "The reference to the service that supports the dependent service.", "properties": {"id": {"type": "string"}, "type": {"type": "string"}}}, "dependent_service": {"type": "object", "description": "The reference to the service that is dependent on the supporting service.", "properties": {"id": {"type": "string"}, "type": {"type": "string"}}}}}}}}',  # noqa: E501
    "CREATENEWSERVICE": '{"type": "object", "properties": {"service": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "description": "The type of object being created.", "default": "service", "enum": ["service"]}, "name": {"type": "string", "description": "The name of the service."}, "description": {"type": "string", "description": "The user-provided description of the service."}, "auto_resolve_timeout": {"type": "integer", "description": "Time in seconds that an incident is automatically resolved if left open for that long. Value is `null` if the feature is disabled. Value must not be negative. Setting this field to `0`, `null` (or unset in POST request) will disable the feature.", "default": 14400}, "acknowledgement_timeout": {"type": "integer", "description": "Time in seconds that an incident changes to the Triggered State after being Acknowledged. Value is `null` if the feature is disabled. Value must not be negative. Setting this field to `0`, `null` (or unset in POST request) will disable the feature.", "default": 1800}, "created_at": {"type": "string", "format": "date-time", "description": "The date/time when this service was created", "readOnly": true}, "status": {"type": "string", "description": "The current state of the Service. Valid statuses are:\n\n\n- `active`: The service is enabled and has no open incidents. This is the only status a service can be created with.\n- `warning`: The service is enabled and has one or more acknowledged incidents.\n- `critical`: The service is enabled and has one or more triggered incidents.\n- `maintenance`: The service is under maintenance, no new incidents will be triggered during maintenance mode.\n- `disabled`: The service is disabled and will not have any new triggered incidents.\n", "enum": ["active", "warning", "critical", "maintenance", "disabled"], "default": "active"}, "last_incident_timestamp": {"type": "string", "format": "date-time", "description": "The date/time when the most recent incident was created for this service.", "readOnly": true}, "escalation_policy": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["escalation_policy_reference"]}}}]}, "response_play": {"deprecated": true, "description": "Response plays associated with this service."}, "teams": {"type": "array", "description": "The set of teams associated with this service.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["team_reference"]}}}]}, "readOnly": true}, "integrations": {"type": "array", "description": "An array containing Integration objects that belong to this service. If `integrations` is passed as an argument, these are full objects - otherwise, these are references.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["aws_cloudwatch_inbound_integration_reference", "cloudkick_inbound_integration_reference", "event_transformer_api_inbound_integration_reference", "generic_email_inbound_integration_reference", "generic_events_api_inbound_integration_reference", "keynote_inbound_integration_reference", "nagios_inbound_integration_reference", "pingdom_inbound_integration_reference", "sql_monitor_inbound_integration_reference", "events_api_v2_inbound_integration_reference", "inbound_integration_reference"]}}}]}, "readOnly": true}, "incident_urgency_rule": {"allOf": [{"type": "object", "properties": {"type": {"type": "string", "description": "The type of incident urgency: whether it\'s constant, or it\'s dependent on the support hours.", "default": "constant", "enum": ["constant", "use_support_hours"]}, "urgency": {"type": "string", "description": "The incidents\' urgency, if type is constant.", "default": "high", "enum": ["low", "high", "severity_based"]}}}, {"type": "object", "properties": {"during_support_hours": {"type": "object", "properties": {"type": {"type": "string", "description": "The type of incident urgency: whether it\'s constant, or it\'s dependent on the support hours.", "default": "constant", "enum": ["constant", "use_support_hours"]}, "urgency": {"type": "string", "description": "The incidents\' urgency, if type is constant.", "default": "high", "enum": ["low", "high", "severity_based"]}}}, "outside_support_hours": {"type": "object", "properties": {"type": {"type": "string", "description": "The type of incident urgency: whether it\'s constant, or it\'s dependent on the support hours.", "default": "constant", "enum": ["constant", "use_support_hours"]}, "urgency": {"type": "string", "description": "The incidents\' urgency, if type is constant.", "default": "high", "enum": ["low", "high", "severity_based"]}}}}}]}, "support_hours": {"type": "object", "properties": {"type": {"type": "string", "description": "The type of support hours", "default": "fixed_time_per_day", "enum": ["fixed_time_per_day"]}, "time_zone": {"type": "string", "format": "activesupport-time-zone", "description": "The time zone for the support hours"}, "days_of_week": {"type": "array", "readOnly": true, "items": {"type": "integer", "readOnly": true, "description": "The days of the week (1 through 7, for Monday through Sunday)"}}, "start_time": {"type": "string", "format": "time", "description": "The support hours\' starting time of day (date portion is ignored)"}, "end_time": {"type": "string", "format": "time", "description": "The support hours\' ending time of day (date portion is ignored)"}}}, "scheduled_actions": {"type": "array", "description": "An array containing scheduled actions for the service.", "items": {"type": "object", "properties": {"type": {"type": "string", "description": "The type of schedule action. Must be set to urgency_change.", "enum": ["urgency_change"]}, "at": {"type": "object", "description": "Represents when scheduled action will occur.", "properties": {"type": {"type": "string", "description": "Must be set to named_time.", "enum": ["named_time"]}, "name": {"type": "string", "description": "Designates either the start or the end of support hours.", "enum": ["support_hours_start", "support_hours_end"]}}, "required": ["type", "name"]}, "to_urgency": {"type": "string", "description": "Urgency level. Must be set to high.", "enum": ["high"]}}, "required": ["type", "at", "to_urgency"]}}, "addons": {"type": "array", "description": "The array of Add-ons associated with this service.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"src": {"type": "string", "format": "url", "description": "The URL source of the Addon"}, "name": {"type": "string", "description": "The user entered name of the Addon."}, "type": {"type": "string", "enum": ["full_page_addon_reference", "incident_show_addon_reference"]}}}]}, "readOnly": true}, "alert_creation": {"type": "string", "deprecated": true, "description": "Whether a service creates only incidents, or both alerts and incidents. A service must create alerts in order to enable incident merging.\n* "create_incidents" - The service will create one incident and zero alerts for each incoming event.\n* "create_alerts_and_incidents" - The service will create one incident and one associated alert for each incoming event.\nThis attribute has been deprecated as all services will be migrated to use alerts and incidents. Afterward, the incident only service setting will no longer be available. For details, please refer to the knowledge base: https://support.pagerduty.com/docs/alerts#enable-and-disable-alerts-on-a-service.\n", "enum": ["create_incidents", "create_alerts_and_incidents"], "default": "create_alerts_and_incidents"}, "alert_grouping_parameters": {"description": "Alert Grouping Parameters", "deprecated": true, "oneOf": [{"type": "object", "title": "Alert Grouping Parameters", "deprecated": true, "description": "Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. To turn grouping off set the type to null.\nThis attribute has been deprecated and configuration via [Alert Grouping Settings](https://developer.pagerduty.com/api-reference/587edbc8ff416-create-an-alert-grouping-setting) resource is encouraged.\n", "properties": {"type": {"type": "string", "nullable": true, "enum": ["time", "intelligent", "content_based", null]}, "config": {"oneOf": [{"type": "object", "title": "Intelligent Alert Grouping", "description": "The configuration for Intelligent Alert Grouping. Note that this configuration is only available for certain plans.", "properties": {"time_window": {"type": "integer", "minimum": 300, "maximum": 3600, "description": "The maximum amount of time allowed between Alerts. Any Alerts arriving greater than `time_window` seconds apart will not be grouped together. This is a rolling time window and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours. To use the "recommended_time_window," set the value to 0, otherwise the value must be between 300 and 3600."}, "recommended_time_window": {"readOnly": true, "type": "integer", "description": "In order to ensure your Service has the optimal grouping window, we use data science to calculate your Service`s average Alert inter-arrival time. We encourage customer`s to use this value, please set `time_window` to 0 to use the `recommended_time_window`."}}}, {"type": "object", "title": "Time Grouping", "description": "The configuration for Time Based Alert Grouping", "properties": {"timeout": {"type": "integer", "minimum": 1, "maximum": 1440, "description": "The duration in minutes within which to automatically group incoming Alerts. To continue grouping Alerts until the Incident is resolved, set this value to 0."}}}, {"type": "object", "title": "Content Only Grouping", "description": "The configuration for Content Based Alert Grouping", "properties": {"aggregate": {"type": "string", "description": "Whether Alerts should be grouped if `all` or `any` specified fields match. If `all` is selected, an exact match on every specified field name must occur for Alerts to be grouped. If `any` is selected, Alerts will be grouped when there is an exact match on at least one of the specified fields.", "enum": ["all, any"]}, "fields": {"type": "array", "description": "An array of strings which represent the fields with which to group against. Depending on the aggregate, Alerts will group if some or all the fields match.", "items": {"type": "string"}}, "time_window": {"type": "integer", "minimum": 300, "maximum": 86400, "description": "The maximum amount of time allowed between Alerts. Any Alerts arriving greater than `time_window` seconds apart will not be grouped together. This is a rolling time window up to 24 hours and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours (24 hours only applies to single-service settings). To use the "recommended_time_window," set the value to 0, otherwise the value must be between 300 <= time_window <= 3600 or 86400(i.e. 24 hours)."}, "recommended_time_window": {"readOnly": true, "type": "integer", "description": "In order to ensure your Service has the optimal grouping window, we use data science to calculate your Service\'s average Alert inter-arrival time. We encourage customer\'s to use this value, please set `time_window` to 0 to use the `recommended_time_window`."}}}]}}}, {"type": "object", "title": "Alert Grouping Settings Reference", "deprecated": true, "description": "When a service uses alert grouping configuration that is unsupported via the services api, and can only be configured via the [Alert Grouping Settings API](https://developer.pagerduty.com/api-reference/587edbc8ff416-create-an-alert-grouping-setting). The reference object includes the new location details for the service\'s Alert Grouping Setting. When an `alert_grouping_settings_reference` is included in a create or update request it will be ignored and no changes are applied to the service.", "properties": {"id": {"type": "string", "readOnly": true, "description": "id of the related alert grouping setting"}, "type": {"readOnly": true, "type": "string", "description": "type of reference eg. alert_grouping_setting_reference"}, "summary": {"readOnly": true, "type": "string", "description": "an explanation of this reference"}, "self": {"readOnly": true, "type": "string", "description": "link to api endpoint for this setting"}, "html_url": {"readOnly": true, "type": "string", "description": "link to the ui page to edit the setting"}}}]}, "alert_grouping": {"type": "string", "deprecated": true, "description": "Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. There are three available options:\n* null - No alert grouping on the service. Each alert will create a separate incident;\n* "time" - All alerts within a specified duration will be grouped into the same incident. This duration is set in the `alert_grouping_timeout` setting (described below). Available on Standard, Enterprise, and Event Intelligence plans;\n* "intelligent" - Alerts will be intelligently grouped based on a machine learning model that looks at the alert summary, timing, and the history of grouped alerts. Available on Enterprise and Event Intelligence plans\n\nThis attribute has been deprecated and configuration via [Alert Grouping Settings](https://developer.pagerduty.com/api-reference/587edbc8ff416-create-an-alert-grouping-setting) resource is encouraged.\n", "enum": ["time", "intelligent"]}, "alert_grouping_timeout": {"type": "integer", "deprecated": true, "description": "The duration in minutes within which to automatically group incoming alerts. This setting applies only when `alert_grouping` is set to `time`. To continue grouping alerts until the Incident is resolved, set this value to `0`.\n\nThis attribute has been deprecated and configuration via [Alert Grouping Settings](https://developer.pagerduty.com/api-reference/587edbc8ff416-create-an-alert-grouping-setting) resource is encouraged.\n"}, "auto_pause_notifications_parameters": {"title": "AutoPauseNotificationsParameters", "type": "object", "description": "Defines how alerts on this service are automatically suspended for a period of time before triggering, when identified as likely being transient. Note that automatically pausing notifications is only available on certain plans.", "properties": {"enabled": {"type": "boolean", "default": false, "description": "Indicates whether alerts should be automatically suspended when identified as transient"}, "timeout": {"type": "integer", "enum": [0, 120, 180, 300, 600, 900], "description": "Indicates in seconds how long alerts should be suspended before triggering. To automatically select the recommended timeout for a service, set this value to `0`."}, "recommended_timeout": {"type": "integer", "enum": [120, 180, 300, 600, 900], "description": "The recommended timeout setting for this service based on prior alert patterns."}}, "example": {"enabled": true, "timeout": 300}}}, "required": ["type", "escalation_policy"], "example": {"id": "PSI2I2O", "summary": "string", "type": "service", "self": "string", "html_url": "string", "name": "My Web App", "description": "My cool web application that does things.", "auto_resolve_timeout": 14400, "acknowledgement_timeout": 600, "status": "active", "escalation_policy": {"id": "PWIP6CQ", "type": "escalation_policy_reference"}, "incident_urgency_rule": {"type": "use_support_hours", "during_support_hours": {"type": "constant", "urgency": "high"}, "outside_support_hours": {"type": "constant", "urgency": "low"}}, "support_hours": {"type": "fixed_time_per_day", "time_zone": "America/Lima", "start_time": "09:00:00", "end_time": "17:00:00", "days_of_week": [1, 2, 3, 4, 5]}, "scheduled_actions": [{"type": "urgency_change", "at": {"type": "named_time", "name": "support_hours_start"}, "to_urgency": "high"}], "alert_creation": "create_alerts_and_incidents", "auto_pause_notifications_parameters": {"enabled": true, "timeout": 300}}}]}}, "required": ["service"]}',  # noqa: E501
    "UPDATESERVICEDETAILS": '{"type": "object", "properties": {"service": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "description": "The type of object being created.", "default": "service", "enum": ["service"]}, "name": {"type": "string", "description": "The name of the service."}, "description": {"type": "string", "description": "The user-provided description of the service."}, "auto_resolve_timeout": {"type": "integer", "description": "Time in seconds that an incident is automatically resolved if left open for that long. Value is `null` if the feature is disabled. Value must not be negative. Setting this field to `0`, `null` (or unset in POST request) will disable the feature.", "default": 14400}, "acknowledgement_timeout": {"type": "integer", "description": "Time in seconds that an incident changes to the Triggered State after being Acknowledged. Value is `null` if the feature is disabled. Value must not be negative. Setting this field to `0`, `null` (or unset in POST request) will disable the feature.", "default": 1800}, "created_at": {"type": "string", "format": "date-time", "description": "The date/time when this service was created", "readOnly": true}, "status": {"type": "string", "description": "The current state of the Service. Valid statuses are:\n\n\n- `active`: The service is enabled and has no open incidents. This is the only status a service can be created with.\n- `warning`: The service is enabled and has one or more acknowledged incidents.\n- `critical`: The service is enabled and has one or more triggered incidents.\n- `maintenance`: The service is under maintenance, no new incidents will be triggered during maintenance mode.\n- `disabled`: The service is disabled and will not have any new triggered incidents.\n", "enum": ["active", "warning", "critical", "maintenance", "disabled"], "default": "active"}, "last_incident_timestamp": {"type": "string", "format": "date-time", "description": "The date/time when the most recent incident was created for this service.", "readOnly": true}, "escalation_policy": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["escalation_policy_reference"]}}}]}, "response_play": {"deprecated": true, "description": "Response plays associated with this service."}, "teams": {"type": "array", "description": "The set of teams associated with this service.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["team_reference"]}}}]}, "readOnly": true}, "integrations": {"type": "array", "description": "An array containing Integration objects that belong to this service. If `integrations` is passed as an argument, these are full objects - otherwise, these are references.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["aws_cloudwatch_inbound_integration_reference", "cloudkick_inbound_integration_reference", "event_transformer_api_inbound_integration_reference", "generic_email_inbound_integration_reference", "generic_events_api_inbound_integration_reference", "keynote_inbound_integration_reference", "nagios_inbound_integration_reference", "pingdom_inbound_integration_reference", "sql_monitor_inbound_integration_reference", "events_api_v2_inbound_integration_reference", "inbound_integration_reference"]}}}]}, "readOnly": true}, "incident_urgency_rule": {"allOf": [{"type": "object", "properties": {"type": {"type": "string", "description": "The type of incident urgency: whether it\'s constant, or it\'s dependent on the support hours.", "default": "constant", "enum": ["constant", "use_support_hours"]}, "urgency": {"type": "string", "description": "The incidents\' urgency, if type is constant.", "default": "high", "enum": ["low", "high", "severity_based"]}}}, {"type": "object", "properties": {"during_support_hours": {"type": "object", "properties": {"type": {"type": "string", "description": "The type of incident urgency: whether it\'s constant, or it\'s dependent on the support hours.", "default": "constant", "enum": ["constant", "use_support_hours"]}, "urgency": {"type": "string", "description": "The incidents\' urgency, if type is constant.", "default": "high", "enum": ["low", "high", "severity_based"]}}}, "outside_support_hours": {"type": "object", "properties": {"type": {"type": "string", "description": "The type of incident urgency: whether it\'s constant, or it\'s dependent on the support hours.", "default": "constant", "enum": ["constant", "use_support_hours"]}, "urgency": {"type": "string", "description": "The incidents\' urgency, if type is constant.", "default": "high", "enum": ["low", "high", "severity_based"]}}}}}]}, "support_hours": {"type": "object", "properties": {"type": {"type": "string", "description": "The type of support hours", "default": "fixed_time_per_day", "enum": ["fixed_time_per_day"]}, "time_zone": {"type": "string", "format": "activesupport-time-zone", "description": "The time zone for the support hours"}, "days_of_week": {"type": "array", "readOnly": true, "items": {"type": "integer", "readOnly": true, "description": "The days of the week (1 through 7, for Monday through Sunday)"}}, "start_time": {"type": "string", "format": "time", "description": "The support hours\' starting time of day (date portion is ignored)"}, "end_time": {"type": "string", "format": "time", "description": "The support hours\' ending time of day (date portion is ignored)"}}}, "scheduled_actions": {"type": "array", "description": "An array containing scheduled actions for the service.", "items": {"type": "object", "properties": {"type": {"type": "string", "description": "The type of schedule action. Must be set to urgency_change.", "enum": ["urgency_change"]}, "at": {"type": "object", "description": "Represents when scheduled action will occur.", "properties": {"type": {"type": "string", "description": "Must be set to named_time.", "enum": ["named_time"]}, "name": {"type": "string", "description": "Designates either the start or the end of support hours.", "enum": ["support_hours_start", "support_hours_end"]}}, "required": ["type", "name"]}, "to_urgency": {"type": "string", "description": "Urgency level. Must be set to high.", "enum": ["high"]}}, "required": ["type", "at", "to_urgency"]}}, "addons": {"type": "array", "description": "The array of Add-ons associated with this service.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"src": {"type": "string", "format": "url", "description": "The URL source of the Addon"}, "name": {"type": "string", "description": "The user entered name of the Addon."}, "type": {"type": "string", "enum": ["full_page_addon_reference", "incident_show_addon_reference"]}}}]}, "readOnly": true}, "alert_creation": {"type": "string", "deprecated": true, "description": "Whether a service creates only incidents, or both alerts and incidents. A service must create alerts in order to enable incident merging.\n* "create_incidents" - The service will create one incident and zero alerts for each incoming event.\n* "create_alerts_and_incidents" - The service will create one incident and one associated alert for each incoming event.\nThis attribute has been deprecated as all services will be migrated to use alerts and incidents. Afterward, the incident only service setting will no longer be available. For details, please refer to the knowledge base: https://support.pagerduty.com/docs/alerts#enable-and-disable-alerts-on-a-service.\n", "enum": ["create_incidents", "create_alerts_and_incidents"], "default": "create_alerts_and_incidents"}, "alert_grouping_parameters": {"description": "Alert Grouping Parameters", "deprecated": true, "oneOf": [{"type": "object", "title": "Alert Grouping Parameters", "deprecated": true, "description": "Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. To turn grouping off set the type to null.\nThis attribute has been deprecated and configuration via [Alert Grouping Settings](https://developer.pagerduty.com/api-reference/587edbc8ff416-create-an-alert-grouping-setting) resource is encouraged.\n", "properties": {"type": {"type": "string", "nullable": true, "enum": ["time", "intelligent", "content_based", null]}, "config": {"oneOf": [{"type": "object", "title": "Intelligent Alert Grouping", "description": "The configuration for Intelligent Alert Grouping. Note that this configuration is only available for certain plans.", "properties": {"time_window": {"type": "integer", "minimum": 300, "maximum": 3600, "description": "The maximum amount of time allowed between Alerts. Any Alerts arriving greater than `time_window` seconds apart will not be grouped together. This is a rolling time window and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours. To use the "recommended_time_window," set the value to 0, otherwise the value must be between 300 and 3600."}, "recommended_time_window": {"readOnly": true, "type": "integer", "description": "In order to ensure your Service has the optimal grouping window, we use data science to calculate your Service`s average Alert inter-arrival time. We encourage customer`s to use this value, please set `time_window` to 0 to use the `recommended_time_window`."}}}, {"type": "object", "title": "Time Grouping", "description": "The configuration for Time Based Alert Grouping", "properties": {"timeout": {"type": "integer", "minimum": 1, "maximum": 1440, "description": "The duration in minutes within which to automatically group incoming Alerts. To continue grouping Alerts until the Incident is resolved, set this value to 0."}}}, {"type": "object", "title": "Content Only Grouping", "description": "The configuration for Content Based Alert Grouping", "properties": {"aggregate": {"type": "string", "description": "Whether Alerts should be grouped if `all` or `any` specified fields match. If `all` is selected, an exact match on every specified field name must occur for Alerts to be grouped. If `any` is selected, Alerts will be grouped when there is an exact match on at least one of the specified fields.", "enum": ["all, any"]}, "fields": {"type": "array", "description": "An array of strings which represent the fields with which to group against. Depending on the aggregate, Alerts will group if some or all the fields match.", "items": {"type": "string"}}, "time_window": {"type": "integer", "minimum": 300, "maximum": 86400, "description": "The maximum amount of time allowed between Alerts. Any Alerts arriving greater than `time_window` seconds apart will not be grouped together. This is a rolling time window up to 24 hours and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours (24 hours only applies to single-service settings). To use the "recommended_time_window," set the value to 0, otherwise the value must be between 300 <= time_window <= 3600 or 86400(i.e. 24 hours)."}, "recommended_time_window": {"readOnly": true, "type": "integer", "description": "In order to ensure your Service has the optimal grouping window, we use data science to calculate your Service\'s average Alert inter-arrival time. We encourage customer\'s to use this value, please set `time_window` to 0 to use the `recommended_time_window`."}}}]}}}, {"type": "object", "title": "Alert Grouping Settings Reference", "deprecated": true, "description": "When a service uses alert grouping configuration that is unsupported via the services api, and can only be configured via the [Alert Grouping Settings API](https://developer.pagerduty.com/api-reference/587edbc8ff416-create-an-alert-grouping-setting). The reference object includes the new location details for the service\'s Alert Grouping Setting. When an `alert_grouping_settings_reference` is included in a create or update request it will be ignored and no changes are applied to the service.", "properties": {"id": {"type": "string", "readOnly": true, "description": "id of the related alert grouping setting"}, "type": {"readOnly": true, "type": "string", "description": "type of reference eg. alert_grouping_setting_reference"}, "summary": {"readOnly": true, "type": "string", "description": "an explanation of this reference"}, "self": {"readOnly": true, "type": "string", "description": "link to api endpoint for this setting"}, "html_url": {"readOnly": true, "type": "string", "description": "link to the ui page to edit the setting"}}}]}, "alert_grouping": {"type": "string", "deprecated": true, "description": "Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. There are three available options:\n* null - No alert grouping on the service. Each alert will create a separate incident;\n* "time" - All alerts within a specified duration will be grouped into the same incident. This duration is set in the `alert_grouping_timeout` setting (described below). Available on Standard, Enterprise, and Event Intelligence plans;\n* "intelligent" - Alerts will be intelligently grouped based on a machine learning model that looks at the alert summary, timing, and the history of grouped alerts. Available on Enterprise and Event Intelligence plans\n\nThis attribute has been deprecated and configuration via [Alert Grouping Settings](https://developer.pagerduty.com/api-reference/587edbc8ff416-create-an-alert-grouping-setting) resource is encouraged.\n", "enum": ["time", "intelligent"]}, "alert_grouping_timeout": {"type": "integer", "deprecated": true, "description": "The duration in minutes within which to automatically group incoming alerts. This setting applies only when `alert_grouping` is set to `time`. To continue grouping alerts until the Incident is resolved, set this value to `0`.\n\nThis attribute has been deprecated and configuration via [Alert Grouping Settings](https://developer.pagerduty.com/api-reference/587edbc8ff416-create-an-alert-grouping-setting) resource is encouraged.\n"}, "auto_pause_notifications_parameters": {"title": "AutoPauseNotificationsParameters", "type": "object", "description": "Defines how alerts on this service are automatically suspended for a period of time before triggering, when identified as likely being transient. Note that automatically pausing notifications is only available on certain plans.", "properties": {"enabled": {"type": "boolean", "default": false, "description": "Indicates whether alerts should be automatically suspended when identified as transient"}, "timeout": {"type": "integer", "enum": [0, 120, 180, 300, 600, 900], "description": "Indicates in seconds how long alerts should be suspended before triggering. To automatically select the recommended timeout for a service, set this value to `0`."}, "recommended_timeout": {"type": "integer", "enum": [120, 180, 300, 600, 900], "description": "The recommended timeout setting for this service based on prior alert patterns."}}, "example": {"enabled": true, "timeout": 300}}}, "required": ["type", "escalation_policy"], "example": {"id": "PSI2I2O", "summary": "string", "type": "service", "self": "string", "html_url": "string", "name": "My Web App", "description": "My cool web application that does things.", "auto_resolve_timeout": 14400, "acknowledgement_timeout": 600, "status": "active", "escalation_policy": {"id": "PWIP6CQ", "type": "escalation_policy_reference"}, "incident_urgency_rule": {"type": "use_support_hours", "during_support_hours": {"type": "constant", "urgency": "high"}, "outside_support_hours": {"type": "constant", "urgency": "low"}}, "support_hours": {"type": "fixed_time_per_day", "time_zone": "America/Lima", "start_time": "09:00:00", "end_time": "17:00:00", "days_of_week": [1, 2, 3, 4, 5]}, "scheduled_actions": [{"type": "urgency_change", "at": {"type": "named_time", "name": "support_hours_start"}, "to_urgency": "high"}], "alert_creation": "create_alerts_and_incidents", "auto_pause_notifications_parameters": {"enabled": true, "timeout": 300}}}]}}, "required": ["service"]}',  # noqa: E501
    "CREATESERVICEINTEGRATION": '{"type": "object", "properties": {"integration": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["aws_cloudwatch_inbound_integration", "cloudkick_inbound_integration", "event_transformer_api_inbound_integration", "generic_email_inbound_integration", "generic_events_api_inbound_integration", "keynote_inbound_integration", "nagios_inbound_integration", "pingdom_inbound_integration", "sql_monitor_inbound_integration", "events_api_v2_inbound_integration"]}, "name": {"type": "string", "description": "The name of this integration."}, "service": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["service_reference"]}}}]}, "created_at": {"type": "string", "format": "date-time", "description": "The date/time when this integration was created.", "readOnly": true}, "vendor": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["vendor_reference"]}}}]}, "integration_email": {"type": "string", "description": "Specify for generic_email_inbound_integration. Must be set to an email address @your-subdomain.pagerduty.com"}, "email_incident_creation": {"type": "string", "description": "Specify for generic_email_inbound_integration", "enum": ["on_new_email", "on_new_email_subject", "only_if_no_open_incidents", "use_rules"]}, "email_filter_mode": {"type": "string", "description": "Specify for generic_email_inbound_integration. May override email_incident_creation", "enum": ["all-email", "or-rules-email", "and-rules-email"]}, "email_parsers": {"type": "array", "description": "Specify for generic_email_inbound_integration.", "uniqueItems": true, "minItems": 1, "items": {"type": "object", "properties": {"action": {"type": "string", "enum": ["trigger", "resolve"]}, "match_predicate": {"type": "object", "properties": {"type": {"type": "string", "enum": ["all", "any", "not", "contains", "exactly", "regex"]}, "matcher": {"type": "string", "description": "Required if the type is `contains`, `exactly` or `regex`.", "minLength": 1}, "part": {"type": "string", "description": "The email field that will attempt to use the matcher expression. Required if the type is `contains`, `exactly` or `regex`.", "enum": ["body", "subject", "from_addresses"]}, "children": {"type": "array", "description": "Additional matchers to be run. Must be not empty if the type is `all`, `any`, or `not`.", "items": {"$ref": "#/components/schemas/MatchPredicate", "has_circular_reference": true}}}, "required": ["type", "part", "children"]}, "value_extractors": {"type": "array", "description": "Additional values that will be pulled in to the Incident object. Exactly one value extractor must have a `value_name` of `incident_key`.", "uniqueItems": true, "minItems": 1, "items": {"type": "object", "properties": {"type": {"type": "string", "enum": ["entire", "regex", "between"]}, "part": {"type": "string", "enum": ["body", "subject", "from_addresses"]}, "value_name": {"type": "string", "minLength": 1, "description": "The field name to set in the Incident object. Exactly one must use the `value_name` of `incident_key`"}, "regex": {"type": "string"}, "starts_after": {"type": "string"}, "ends_with": {"type": "string"}}, "required": ["type", "part", "value_name"]}}}, "required": ["action", "match_predicate"]}}, "email_parsing_fallback": {"type": "string", "description": "Specify for generic_email_inbound_integration.", "enum": ["open_new_incident", "discard"]}, "email_filters": {"type": "array", "description": "Specify for generic_email_inbound_integration.", "uniqueItems": true, "minItems": 1, "items": {"type": "object", "properties": {"subject_mode": {"type": "string", "enum": ["match", "no-match", "always"]}, "subject_regex": {"type": "string", "description": "Specify if subject_mode is set to match or no-match"}, "body_mode": {"type": "string", "enum": ["match", "no-match", "always"]}, "body_regex": {"type": "string", "description": "Specify if body_mode is set to match or no-match"}, "from_email_mode": {"type": "string", "enum": ["match", "no-match", "always"]}, "from_email_regex": {"type": "string", "description": "Specify if from_email_mode is set to match or no-match"}}, "required": ["subject_mode", "body_mode", "from_email_mode"]}, "required": ["type", "name"]}}}]}}, "required": ["integration"]}',  # noqa: E501
    "UPDATESERVICEINTEGRATION": '{"type": "object", "properties": {"integration": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["aws_cloudwatch_inbound_integration", "cloudkick_inbound_integration", "event_transformer_api_inbound_integration", "generic_email_inbound_integration", "generic_events_api_inbound_integration", "keynote_inbound_integration", "nagios_inbound_integration", "pingdom_inbound_integration", "sql_monitor_inbound_integration", "events_api_v2_inbound_integration"]}, "name": {"type": "string", "description": "The name of this integration."}, "service": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["service_reference"]}}}]}, "created_at": {"type": "string", "format": "date-time", "description": "The date/time when this integration was created.", "readOnly": true}, "vendor": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["vendor_reference"]}}}]}, "integration_email": {"type": "string", "description": "Specify for generic_email_inbound_integration. Must be set to an email address @your-subdomain.pagerduty.com"}, "email_incident_creation": {"type": "string", "description": "Specify for generic_email_inbound_integration", "enum": ["on_new_email", "on_new_email_subject", "only_if_no_open_incidents", "use_rules"]}, "email_filter_mode": {"type": "string", "description": "Specify for generic_email_inbound_integration. May override email_incident_creation", "enum": ["all-email", "or-rules-email", "and-rules-email"]}, "email_parsers": {"type": "array", "description": "Specify for generic_email_inbound_integration.", "uniqueItems": true, "minItems": 1, "items": {"type": "object", "properties": {"action": {"type": "string", "enum": ["trigger", "resolve"]}, "match_predicate": {"type": "object", "properties": {"type": {"type": "string", "enum": ["all", "any", "not", "contains", "exactly", "regex"]}, "matcher": {"type": "string", "description": "Required if the type is `contains`, `exactly` or `regex`.", "minLength": 1}, "part": {"type": "string", "description": "The email field that will attempt to use the matcher expression. Required if the type is `contains`, `exactly` or `regex`.", "enum": ["body", "subject", "from_addresses"]}, "children": {"type": "array", "description": "Additional matchers to be run. Must be not empty if the type is `all`, `any`, or `not`.", "items": {"$ref": "#/components/schemas/MatchPredicate", "has_circular_reference": true}}}, "required": ["type", "part", "children"]}, "value_extractors": {"type": "array", "description": "Additional values that will be pulled in to the Incident object. Exactly one value extractor must have a `value_name` of `incident_key`.", "uniqueItems": true, "minItems": 1, "items": {"type": "object", "properties": {"type": {"type": "string", "enum": ["entire", "regex", "between"]}, "part": {"type": "string", "enum": ["body", "subject", "from_addresses"]}, "value_name": {"type": "string", "minLength": 1, "description": "The field name to set in the Incident object. Exactly one must use the `value_name` of `incident_key`"}, "regex": {"type": "string"}, "starts_after": {"type": "string"}, "ends_with": {"type": "string"}}, "required": ["type", "part", "value_name"]}}}, "required": ["action", "match_predicate"]}}, "email_parsing_fallback": {"type": "string", "description": "Specify for generic_email_inbound_integration.", "enum": ["open_new_incident", "discard"]}, "email_filters": {"type": "array", "description": "Specify for generic_email_inbound_integration.", "uniqueItems": true, "minItems": 1, "items": {"type": "object", "properties": {"subject_mode": {"type": "string", "enum": ["match", "no-match", "always"]}, "subject_regex": {"type": "string", "description": "Specify if subject_mode is set to match or no-match"}, "body_mode": {"type": "string", "enum": ["match", "no-match", "always"]}, "body_regex": {"type": "string", "description": "Specify if body_mode is set to match or no-match"}, "from_email_mode": {"type": "string", "enum": ["match", "no-match", "always"]}, "from_email_regex": {"type": "string", "description": "Specify if from_email_mode is set to match or no-match"}}, "required": ["subject_mode", "body_mode", "from_email_mode"]}, "required": ["type", "name"]}}}]}}, "required": ["integration"]}',  # noqa: E501
    "CREATESERVICEEVENTRULE": '{"type": "object", "properties": {"rule": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true, "description": "ID of the Event Rule."}, "self": {"type": "string", "format": "url", "description": "the API show URL at which the object is accessible.", "readOnly": true}, "disabled": {"type": "boolean", "description": "Indicates whether the Event Rule is disabled and would therefore not be evaluated."}, "conditions": {"type": "object", "description": "Conditions evaluated to check if an event matches this Event Rule. Is always empty for the catch_all rule, though.", "properties": {"operator": {"type": "string", "description": "Operator to combine sub-conditions.", "enum": ["and", "or"]}, "subconditions": {"type": "array", "description": "Array of sub-conditions.", "items": {"type": "object", "properties": {"operator": {"type": "string", "description": "The type of operator to apply.", "enum": ["exists", "nexists", "equals", "nequals", "contains", "ncontains", "matches", "nmatches"]}, "parameters": {"type": "object", "properties": {"path": {"type": "string", "description": "Path to a field in an event, in dot-notation.  For Event Rules on a serivce, this will have to be a PD-CEF field."}, "value": {"type": "string", "description": "Value to apply to the operator."}, "options": {"type": "object", "description": "Options to configure the operator."}}, "required": ["value", "path"]}}, "required": ["operator", "parameters"]}}}, "required": ["operator", "subconditions"]}, "time_frame": {"description": "Time-based conditions for limiting when the rule is active.", "type": "object", "properties": {"active_between": {"type": "object", "required": ["start_time", "end_time"], "description": "A fixed window of time during which the rule is active.", "properties": {"start_time": {"type": "integer", "description": "The start time in milliseconds."}, "end_time": {"type": "integer", "description": "End time in milliseconds."}}}, "scheduled_weekly": {"type": "object", "required": ["start_time", "duration", "timezone", "weekdays"], "description": "A reccuring window of time based on the day of the week, during which the rule is active.", "properties": {"start_time": {"type": "integer", "description": "The amount of milliseconds into the day at which the window starts."}, "duration": {"type": "integer", "description": "The duration of the window in milliseconds."}, "timezone": {"type": "string", "description": "The timezone."}, "weekdays": {"type": "array", "description": "An array of day values. Ex [1, 3, 5] is Monday, Wednesday, Friday.", "items": {"type": "integer"}}}}}}, "variables": {"type": "array", "description": "[Early Access] Populate variables from event payloads and use those variables in other event actions.", "items": {"type": "object", "properties": {"type": {"type": "string", "description": "The type of operation to populate the variable.", "enum": ["regex"]}, "name": {"type": "string", "description": "The name of the variable."}, "parameters": {"type": "object", "description": "The parameters for performing the operation to populate the", "properties": {"value": {"type": "string", "description": "The value for the operation. For example, an RE2 regular expression for regex-type variables."}, "path": {"type": "string", "description": "Path to a field in an event, in dot-notation. For Event Rules on a Service, this will have to be a PD-CEF field."}}, "required": ["value", "path"]}}, "required": ["type", "name", "parameters"]}}}}, {"type": "object", "properties": {"position": {"type": "integer", "description": "Position/index of the Event Rule on the Service.  Starting from position 0 (the first rule), rules are evaluated one-by-one until a matching Event Rule is found or the end of the list is reached."}, "actions": {"type": "object", "description": "When an event matches this Event Rule, the actions that will be taken to change the resulting Alert and Incident.", "properties": {"annotate": {"description": "Set a note on the resulting incident.", "type": "object", "nullable": true, "required": ["value"], "properties": {"value": {"type": "string", "description": "The content of the note."}}}, "event_action": {"description": "Set whether the resulting alert status is trigger or resolve.", "type": "object", "required": ["value"], "nullable": true, "properties": {"value": {"type": "string", "enum": ["trigger", "resolve"]}}}, "extractions": {"type": "array", "description": "Dynamically extract values to set and modify new and existing PD-CEF fields.", "items": {"oneOf": [{"type": "object", "required": ["target", "source", "regex"], "properties": {"target": {"type": "string", "description": "The PD-CEF field that will be set with the value from the regex."}, "source": {"type": "string", "description": "The path to the event field where the regex will be applied to extract a value."}, "regex": {"type": "string", "description": "A RE2 regular expression.  If it contains one or more capture groups, their values will be extracted and appended together.  If it contains no capture groups, the whole match is used."}}}, {"type": "object", "required": ["target", "template"], "properties": {"target": {"type": "string", "description": "The PD-CEF field that will be set with the value from the regex."}, "template": {"type": "string", "description": "A value that will be used to populate the target PD-CEF field.  You can include variables extracted from the payload by using string interpolation.", "example": "Error number {{count}} on host {{host}}"}}}]}}, "priority": {"description": "Set the priority ID for the resulting incident. You can find the priority you want by calling the priorities endpoint.", "type": "object", "required": ["value"], "nullable": true, "properties": {"value": {"type": "string", "description": "The priority ID."}}}, "severity": {"description": "Set the severity of the resulting alert.", "type": "object", "required": ["value"], "nullable": true, "properties": {"value": {"type": "string", "enum": ["info", "warning", "error", "critical"]}}}, "suppress": {"description": "Set whether the resulting alert is suppressed. Can optionally be used with a threshold where resulting alerts will be suppressed until the threshold is met in a window of time. If using a threshold the rule must also set a route action.", "type": "object", "required": ["value"], "properties": {"value": {"type": "boolean"}, "threshold_value": {"type": "integer", "description": "The number of occurences needed during the window of time to trigger the theshold."}, "threshold_time_unit": {"type": "string", "description": "The time unit for the window of time.", "enum": ["seconds", "minutes", "hours"]}, "threshold_time_amount": {"type": "integer", "description": "The amount of time units for the window of time."}}}, "suspend": {"description": "Set the length of time to suspend the resulting alert before triggering. Rules with a suspend action must also set a route action, and cannot have a suppress with threshold action", "type": "object", "required": ["value"], "nullable": true, "properties": {"value": {"type": "integer", "description": "The amount of time to suspend the alert in seconds."}}}}}}}]}}, "required": ["rule"]}',  # noqa: E501
    "UPDATESERVICEEVENTRULE": '{"type": "object", "properties": {"rule": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true, "description": "ID of the Event Rule."}, "self": {"type": "string", "format": "url", "description": "the API show URL at which the object is accessible.", "readOnly": true}, "disabled": {"type": "boolean", "description": "Indicates whether the Event Rule is disabled and would therefore not be evaluated."}, "conditions": {"type": "object", "description": "Conditions evaluated to check if an event matches this Event Rule. Is always empty for the catch_all rule, though.", "properties": {"operator": {"type": "string", "description": "Operator to combine sub-conditions.", "enum": ["and", "or"]}, "subconditions": {"type": "array", "description": "Array of sub-conditions.", "items": {"type": "object", "properties": {"operator": {"type": "string", "description": "The type of operator to apply.", "enum": ["exists", "nexists", "equals", "nequals", "contains", "ncontains", "matches", "nmatches"]}, "parameters": {"type": "object", "properties": {"path": {"type": "string", "description": "Path to a field in an event, in dot-notation.  For Event Rules on a serivce, this will have to be a PD-CEF field."}, "value": {"type": "string", "description": "Value to apply to the operator."}, "options": {"type": "object", "description": "Options to configure the operator."}}, "required": ["value", "path"]}}, "required": ["operator", "parameters"]}}}, "required": ["operator", "subconditions"]}, "time_frame": {"description": "Time-based conditions for limiting when the rule is active.", "type": "object", "properties": {"active_between": {"type": "object", "required": ["start_time", "end_time"], "description": "A fixed window of time during which the rule is active.", "properties": {"start_time": {"type": "integer", "description": "The start time in milliseconds."}, "end_time": {"type": "integer", "description": "End time in milliseconds."}}}, "scheduled_weekly": {"type": "object", "required": ["start_time", "duration", "timezone", "weekdays"], "description": "A reccuring window of time based on the day of the week, during which the rule is active.", "properties": {"start_time": {"type": "integer", "description": "The amount of milliseconds into the day at which the window starts."}, "duration": {"type": "integer", "description": "The duration of the window in milliseconds."}, "timezone": {"type": "string", "description": "The timezone."}, "weekdays": {"type": "array", "description": "An array of day values. Ex [1, 3, 5] is Monday, Wednesday, Friday.", "items": {"type": "integer"}}}}}}, "variables": {"type": "array", "description": "[Early Access] Populate variables from event payloads and use those variables in other event actions.", "items": {"type": "object", "properties": {"type": {"type": "string", "description": "The type of operation to populate the variable.", "enum": ["regex"]}, "name": {"type": "string", "description": "The name of the variable."}, "parameters": {"type": "object", "description": "The parameters for performing the operation to populate the", "properties": {"value": {"type": "string", "description": "The value for the operation. For example, an RE2 regular expression for regex-type variables."}, "path": {"type": "string", "description": "Path to a field in an event, in dot-notation. For Event Rules on a Service, this will have to be a PD-CEF field."}}, "required": ["value", "path"]}}, "required": ["type", "name", "parameters"]}}}}, {"type": "object", "properties": {"position": {"type": "integer", "description": "Position/index of the Event Rule on the Service.  Starting from position 0 (the first rule), rules are evaluated one-by-one until a matching Event Rule is found or the end of the list is reached."}, "actions": {"type": "object", "description": "When an event matches this Event Rule, the actions that will be taken to change the resulting Alert and Incident.", "properties": {"annotate": {"description": "Set a note on the resulting incident.", "type": "object", "nullable": true, "required": ["value"], "properties": {"value": {"type": "string", "description": "The content of the note."}}}, "event_action": {"description": "Set whether the resulting alert status is trigger or resolve.", "type": "object", "required": ["value"], "nullable": true, "properties": {"value": {"type": "string", "enum": ["trigger", "resolve"]}}}, "extractions": {"type": "array", "description": "Dynamically extract values to set and modify new and existing PD-CEF fields.", "items": {"oneOf": [{"type": "object", "required": ["target", "source", "regex"], "properties": {"target": {"type": "string", "description": "The PD-CEF field that will be set with the value from the regex."}, "source": {"type": "string", "description": "The path to the event field where the regex will be applied to extract a value."}, "regex": {"type": "string", "description": "A RE2 regular expression.  If it contains one or more capture groups, their values will be extracted and appended together.  If it contains no capture groups, the whole match is used."}}}, {"type": "object", "required": ["target", "template"], "properties": {"target": {"type": "string", "description": "The PD-CEF field that will be set with the value from the regex."}, "template": {"type": "string", "description": "A value that will be used to populate the target PD-CEF field.  You can include variables extracted from the payload by using string interpolation.", "example": "Error number {{count}} on host {{host}}"}}}]}}, "priority": {"description": "Set the priority ID for the resulting incident. You can find the priority you want by calling the priorities endpoint.", "type": "object", "required": ["value"], "nullable": true, "properties": {"value": {"type": "string", "description": "The priority ID."}}}, "severity": {"description": "Set the severity of the resulting alert.", "type": "object", "required": ["value"], "nullable": true, "properties": {"value": {"type": "string", "enum": ["info", "warning", "error", "critical"]}}}, "suppress": {"description": "Set whether the resulting alert is suppressed. Can optionally be used with a threshold where resulting alerts will be suppressed until the threshold is met in a window of time. If using a threshold the rule must also set a route action.", "type": "object", "required": ["value"], "properties": {"value": {"type": "boolean"}, "threshold_value": {"type": "integer", "description": "The number of occurences needed during the window of time to trigger the theshold."}, "threshold_time_unit": {"type": "string", "description": "The time unit for the window of time.", "enum": ["seconds", "minutes", "hours"]}, "threshold_time_amount": {"type": "integer", "description": "The amount of time units for the window of time."}}}, "suspend": {"description": "Set the length of time to suspend the resulting alert before triggering. Rules with a suspend action must also set a route action, and cannot have a suppress with threshold action", "type": "object", "required": ["value"], "nullable": true, "properties": {"value": {"type": "integer", "description": "The amount of time to suspend the alert in seconds."}}}}}}}]}, "rule_id": {"description": "The id of the Event Rule to update on the Service.", "type": "string"}}, "required": ["rule_id"]}',  # noqa: E501
    "CREATESERVICECUSTOMFIELD": '{"type": "object", "properties": {"field": {"type": "object", "description": "Details of the custom field to be created.", "properties": {"data_type": {"type": "string", "description": "The kind of data the custom field is allowed to contain.", "enum": ["boolean", "integer", "float", "string", "datetime", "url"]}, "description": {"type": "string", "nullable": true, "description": "A description of the data this field contains.", "maxLength": 1000}, "display_name": {"type": "string", "description": "The human-readable name of the field. This must be unique across an account.", "maxLength": 50}, "enabled": {"type": "boolean", "description": "Whether the field is enabled.", "enum": [true, false]}, "field_options": {"type": "array", "items": {"type": "object", "description": "An option for a custom field. Can only be applied to fields with a `field_type` of `single_value_fixed` or `multi_value_fixed`.", "properties": {"data": {"type": "object", "description": "The data content of the field option.", "properties": {"data_type": {"type": "string", "description": "The kind of data represented by this option. Must match the Field\'s `data_type`.", "enum": ["string"]}, "value": {"type": "string", "description": "The value of the field option. Must be unique within the field.", "maxLength": 200}}, "required": ["data_type", "value"]}}, "required": ["data"]}}, "field_type": {"type": "string", "description": "The type of data this field contains. In combination with the `data_type` field.", "enum": ["single_value", "single_value_fixed", "multi_value", "multi_value_fixed"]}, "name": {"type": "string", "title": "Field Name", "description": "The name of the field. May include ASCII characters, specifically lowercase letters, digits, and underescores. The `name` for a Field must be unique and cannot be changed once created.", "maxLength": 50}}, "required": ["data_type", "display_name", "field_type", "name"]}}, "required": ["field"]}',  # noqa: E501
    "UPDATESERVICECUSTOMFIELD": '{"type": "object", "properties": {"field": {"type": "object", "description": "Details of the custom field to be updated.", "properties": {"description": {"type": "string", "nullable": true, "description": "A description of the data this field contains.", "maxLength": 1000}, "display_name": {"type": "string", "description": "The human-readable name of the field. This must be unique across an account.", "maxLength": 50}, "enabled": {"type": "boolean", "description": "Whether the field is enabled.", "enum": [true, false]}, "field_options": {"type": "array", "items": {"allOf": [{"type": "object", "description": "An option for a custom field. Can only be applied to fields with a `field_type` of `single_value_fixed` or `multi_value_fixed`.", "properties": {"data": {"type": "object", "description": "The data content of the field option.", "properties": {"data_type": {"type": "string", "description": "The kind of data represented by this option. Must match the Field\'s `data_type`.", "enum": ["string"]}, "value": {"type": "string", "description": "The value of the field option. Must be unique within the field.", "maxLength": 200}}, "required": ["data_type", "value"]}}, "required": ["data"]}, {"type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the field option. How this field is used determines the behavior:\n  - When included with a valid `id`: Updates the corresponding existing field option\n  - When omitted or null: Creates a new field option\n"}}}]}, "description": "List of field options to update, insert or delete. This field supports several behaviors:\n  - Empty array: Deletes all field options\n  - Omitting the `field_options` array entirely: Preserves all existing options\n  - Not listing an existing option: Deletes that option (unless it\'s the current default value)\n"}}}}, "required": ["field"]}',  # noqa: E501
    "ADDSERVICEFIELDOPTION": '{"type": "object", "properties": {"field_option": {"type": "object", "description": "An option for a custom field. Can only be applied to fields with a `field_type` of `single_value_fixed` or `multi_value_fixed`.", "properties": {"data": {"type": "object", "description": "The data content of the field option.", "properties": {"data_type": {"type": "string", "description": "The kind of data represented by this option. Must match the Field\'s `data_type`.", "enum": ["string"]}, "value": {"type": "string", "description": "The value of the field option. Must be unique within the field.", "maxLength": 200}}, "required": ["data_type", "value"]}}, "required": ["data"]}}, "required": ["field_option"]}',  # noqa: E501
    "UPDATESERVICECUSTOMFIELDOPTION": '{"type": "object", "properties": {"field_option": {"type": "object", "description": "An option for a custom field. Can only be applied to fields with a `field_type` of `single_value_fixed` or `multi_value_fixed`.", "properties": {"data": {"type": "object", "description": "The data content of the field option.", "properties": {"data_type": {"type": "string", "description": "The kind of data represented by this option. Must match the Field\'s `data_type`.", "enum": ["string"]}, "value": {"type": "string", "description": "The value of the field option. Must be unique within the field.", "maxLength": 200}}, "required": ["data_type", "value"]}}, "required": ["data"]}}, "required": ["field_option"]}',  # noqa: E501
    "SETSERVICECUSTOMFIELDVALUES": '{"type": "object", "properties": {"custom_fields": {"type": "array", "items": {"title": "Custom Field Value", "description": "During updates:\n- Omitted fields remain unchanged\n- Null values reset fields\n- Provided values update fields\n\nNote: All updates succeed or none are applied.\n", "oneOf": [{"type": "object", "title": "Value by Field ID", "properties": {"id": {"type": "string", "description": "The ID of the resource."}, "value": {"oneOf": [{"type": "object", "title": "Boolean", "properties": {"value": {"type": "boolean", "nullable": true}}}, {"type": "object", "title": "Datetime", "properties": {"value": {"type": "string", "nullable": true, "format": "date-time"}}}, {"type": "object", "title": "Float", "properties": {"value": {"type": "number", "nullable": true}}}, {"type": "object", "title": "Integer", "properties": {"value": {"type": "integer", "nullable": true}}}, {"type": "object", "title": "String", "properties": {"value": {"oneOf": [{"type": "string", "maxLength": 200, "nullable": true}, {"type": "array", "items": {"type": "string", "maxLength": 200}, "maxItems": 10, "uniqueItems": true, "nullable": true}]}}}, {"type": "object", "title": "Url", "properties": {"value": {"type": "string", "format": "uri", "maxLength": 200, "nullable": true}}}]}}, "required": ["id", "value"]}, {"type": "object", "title": "Value by Field Name", "properties": {"name": {"type": "string", "title": "Field Name", "description": "The name of the field. May include ASCII characters, specifically lowercase letters, digits, and underescores. The `name` for a Field must be unique and cannot be changed once created.", "maxLength": 50}, "value": {"oneOf": [{"type": "object", "title": "Boolean", "properties": {"value": {"type": "boolean", "nullable": true}}}, {"type": "object", "title": "Datetime", "properties": {"value": {"type": "string", "nullable": true, "format": "date-time"}}}, {"type": "object", "title": "Float", "properties": {"value": {"type": "number", "nullable": true}}}, {"type": "object", "title": "Integer", "properties": {"value": {"type": "integer", "nullable": true}}}, {"type": "object", "title": "String", "properties": {"value": {"oneOf": [{"type": "string", "maxLength": 200, "nullable": true}, {"type": "array", "items": {"type": "string", "maxLength": 200}, "maxItems": 10, "uniqueItems": true, "nullable": true}]}}}, {"type": "object", "title": "Url", "properties": {"value": {"type": "string", "format": "uri", "maxLength": 200, "nullable": true}}}]}}, "required": ["name", "value"]}]}}}, "required": ["custom_fields"]}',  # noqa: E501
    "UPDATESERVICEFEATUREENABLEMENT": '{"type": "object", "properties": {"enablement": {"type": "object", "properties": {"feature": {"readOnly": true, "type": "string", "description": "The name of the product addon whose set of features will be enabled or disabled.", "example": "aiops"}, "enabled": {"type": "boolean", "description": "A boolean value indicating whether the specified product addon is enabled or disabled."}, "updated_at": {"readOnly": true, "type": "string", "format": "date-time", "description": "The time the feature enablement was last updated."}, "warnings": {"readOnly": true, "type": "array", "description": "An array of warnings related to this feature enablement. Only present if warning conditions are met.", "items": {"type": "object", "properties": {"message": {"type": "string", "description": "The warning message."}}}}}, "required": ["enabled"]}}, "required": ["enablement"]}',  # noqa: E501
    "UPDATESTANDARD": '{"allOf": [{"type": "object", "properties": {"active": {"type": "boolean"}, "values": {"type": "object", "properties": {"regex": {"type": "string"}}}, "description": {"type": "string"}, "inclusions": {"type": "array", "items": {"title": "StandardInclusionExclusion", "type": "object", "properties": {"type": {"type": "string", "enum": ["technical_service_reference"]}, "id": {"type": "string"}}}}, "exclusions": {"type": "array", "items": {"title": "StandardInclusionExclusion", "type": "object", "properties": {"type": {"type": "string", "enum": ["technical_service_reference"]}, "id": {"type": "string"}}}}}}]}',  # noqa: E501
    "CREATESTATUSPAGEPOST": '{"type": "object", "properties": {"post": {"type": "object", "title": "StatusPagePostRequest", "description": "Request schema for creating/updating a given Status Page Post resource.", "properties": {"type": {"type": "string", "description": "The type of the object returned by the API - in this case, a Status Page Post.", "nullable": false, "enum": ["status_page_post"]}, "title": {"type": "string", "description": "The title given to a Post.", "nullable": false, "minLength": 1, "maxLength": 128}, "post_type": {"type": "string", "description": "The type of the Post.", "nullable": false, "enum": ["incident", "maintenance"]}, "starts_at": {"type": "string", "description": "The date and time the Post intent becomes effective - only for maintenance post type.", "nullable": true, "format": "date-time"}, "ends_at": {"type": "string", "description": "The date and time the Post intent is concluded - only for maintenance post type.", "nullable": true, "format": "date-time"}, "updates": {"type": "array", "description": "Post Updates to be associated with a Post", "items": {"type": "object", "title": "StatusPagePostUpdateRequest", "description": "Attributes for Post Update creation/update", "properties": {"self": {"type": "string", "description": "The path to which the Post Update resource is accessible.", "nullable": false, "readOnly": true}, "post": {"description": "Status Page Post", "nullable": false, "properties": {"id": {"description": "Status page post unique identifier", "type": "string"}, "type": {"description": "A string that determines the schema of the object.", "type": "string"}}, "required": ["id"], "type": "object"}, "message": {"type": "string", "description": "The message of the Post Update.", "nullable": false}, "status": {"description": "Status Page Status", "nullable": false, "properties": {"id": {"description": "Status page Status unique identifier", "type": "string"}, "type": {"description": "A string that determines the schema of the object.", "type": "string"}}, "required": ["id"], "type": "object"}, "severity": {"description": "Status Page Severity", "nullable": false, "properties": {"id": {"description": "Status page Severity unique identifier", "type": "string"}, "type": {"description": "A string that determines the schema of the object.", "type": "string"}}, "required": ["id"], "type": "object"}, "impacted_services": {"type": "array", "description": "Impacted services represent the status page services affected by a post update, and its impact.", "items": {"type": "object", "title": "StatusPagePostUpdateImpact", "description": "Status Page Post Update Impact", "properties": {"service": {"description": "Status Page Service", "nullable": false, "properties": {"id": {"type": "string", "description": "An unique identifier within Status Page scope that defines a Service entry.", "nullable": false, "readOnly": true}, "type": {"type": "string", "description": "The type of the object returned by the API - in this case, a Status Page Service."}}}, "impact": {"description": "Status Page Impact", "nullable": false, "properties": {"id": {"type": "string", "description": "An unique identifier within Status Page scope that defines a Status Page Impact entry.", "nullable": false, "readOnly": true}, "type": {"type": "string", "description": "The type of the object returned by the API - in this case, a Status Page Impact."}}}}}, "minItems": 0}, "update_frequency_ms": {"type": "integer", "description": "The frequency of the next Post Update in milliseconds.", "nullable": true}, "notify_subscribers": {"type": "boolean", "description": "Determines if the subscribers should be notified of the Post Update.", "nullable": false}, "reported_at": {"type": "string", "description": "The date and time the Post Update was reported.", "nullable": true, "format": "date-time"}, "type": {"type": "string", "description": "The type of the object returned by the API - in this case, a Status Page Post Update."}}, "required": ["type", "message", "status", "severity", "update_frequency_ms", "notify_subscribers", "impacted_services", "post"]}, "nullable": false, "minItems": 1, "maxItems": 50}, "status_page": {"description": "Status Page", "nullable": false, "properties": {"id": {"description": "Status page unique identifier", "type": "string"}, "type": {"description": "A string that determines the schema of the object.", "type": "string"}}, "required": ["id"], "type": "object"}}, "required": ["type", "title", "post_type", "starts_at", "ends_at", "updates", "status_page"]}}, "required": ["post"]}',  # noqa: E501
    "UPDATESTATUSPAGEPOST": '{"type": "object", "properties": {"post": {"type": "object", "title": "StatusPagePostPutRequest", "description": "Request schema for creating a given Status Page Post resource.", "properties": {"type": {"type": "string", "description": "The type of the object returned by the API - in this case, a Status Page Post.", "nullable": false, "enum": ["status_page_post"]}, "title": {"type": "string", "description": "The title given to a Post.", "nullable": false, "minLength": 1, "maxLength": 128}, "post_type": {"type": "string", "description": "The type of the Post.", "nullable": false, "enum": ["incident", "maintenance"]}, "starts_at": {"type": "string", "description": "The date and time the Post intent becomes effective - only for maintenance post type.", "nullable": true, "format": "date-time"}, "ends_at": {"type": "string", "description": "The date and time the Post intent is concluded - only for maintenance post type.", "nullable": true, "format": "date-time"}, "status_page": {"description": "Status Page", "nullable": false, "properties": {"id": {"description": "Status page unique identifier", "type": "string"}, "type": {"description": "A string that determines the schema of the object.", "type": "string"}}, "required": ["id"], "type": "object"}}, "required": ["type", "title", "post_type", "starts_at", "ends_at", "status_page"]}}, "required": ["post"]}',  # noqa: E501
    "CREATESTATUSPAGEPOSTUPDATE": '{"type": "object", "properties": {"post_update": {"type": "object", "title": "StatusPagePostUpdateRequest", "description": "Attributes for Post Update creation/update", "properties": {"self": {"type": "string", "description": "The path to which the Post Update resource is accessible.", "nullable": false, "readOnly": true}, "post": {"description": "Status Page Post", "nullable": false, "properties": {"id": {"description": "Status page post unique identifier", "type": "string"}, "type": {"description": "A string that determines the schema of the object.", "type": "string"}}, "required": ["id"], "type": "object"}, "message": {"type": "string", "description": "The message of the Post Update.", "nullable": false}, "status": {"description": "Status Page Status", "nullable": false, "properties": {"id": {"description": "Status page Status unique identifier", "type": "string"}, "type": {"description": "A string that determines the schema of the object.", "type": "string"}}, "required": ["id"], "type": "object"}, "severity": {"description": "Status Page Severity", "nullable": false, "properties": {"id": {"description": "Status page Severity unique identifier", "type": "string"}, "type": {"description": "A string that determines the schema of the object.", "type": "string"}}, "required": ["id"], "type": "object"}, "impacted_services": {"type": "array", "description": "Impacted services represent the status page services affected by a post update, and its impact.", "items": {"type": "object", "title": "StatusPagePostUpdateImpact", "description": "Status Page Post Update Impact", "properties": {"service": {"description": "Status Page Service", "nullable": false, "properties": {"id": {"type": "string", "description": "An unique identifier within Status Page scope that defines a Service entry.", "nullable": false, "readOnly": true}, "type": {"type": "string", "description": "The type of the object returned by the API - in this case, a Status Page Service."}}}, "impact": {"description": "Status Page Impact", "nullable": false, "properties": {"id": {"type": "string", "description": "An unique identifier within Status Page scope that defines a Status Page Impact entry.", "nullable": false, "readOnly": true}, "type": {"type": "string", "description": "The type of the object returned by the API - in this case, a Status Page Impact."}}}}}, "minItems": 0}, "update_frequency_ms": {"type": "integer", "description": "The frequency of the next Post Update in milliseconds.", "nullable": true}, "notify_subscribers": {"type": "boolean", "description": "Determines if the subscribers should be notified of the Post Update.", "nullable": false}, "reported_at": {"type": "string", "description": "The date and time the Post Update was reported.", "nullable": true, "format": "date-time"}, "type": {"type": "string", "description": "The type of the object returned by the API - in this case, a Status Page Post Update."}}, "required": ["type", "message", "status", "severity", "update_frequency_ms", "notify_subscribers", "impacted_services", "post"]}}, "required": ["post_update"]}',  # noqa: E501
    "MODIFYSTATUSPAGEPOSTUPDATE": '{"type": "object", "properties": {"post_update": {"type": "object", "title": "StatusPagePostUpdateRequest", "description": "Attributes for Post Update creation/update", "properties": {"self": {"type": "string", "description": "The path to which the Post Update resource is accessible.", "nullable": false, "readOnly": true}, "post": {"description": "Status Page Post", "nullable": false, "properties": {"id": {"description": "Status page post unique identifier", "type": "string"}, "type": {"description": "A string that determines the schema of the object.", "type": "string"}}, "required": ["id"], "type": "object"}, "message": {"type": "string", "description": "The message of the Post Update.", "nullable": false}, "status": {"description": "Status Page Status", "nullable": false, "properties": {"id": {"description": "Status page Status unique identifier", "type": "string"}, "type": {"description": "A string that determines the schema of the object.", "type": "string"}}, "required": ["id"], "type": "object"}, "severity": {"description": "Status Page Severity", "nullable": false, "properties": {"id": {"description": "Status page Severity unique identifier", "type": "string"}, "type": {"description": "A string that determines the schema of the object.", "type": "string"}}, "required": ["id"], "type": "object"}, "impacted_services": {"type": "array", "description": "Impacted services represent the status page services affected by a post update, and its impact.", "items": {"type": "object", "title": "StatusPagePostUpdateImpact", "description": "Status Page Post Update Impact", "properties": {"service": {"description": "Status Page Service", "nullable": false, "properties": {"id": {"type": "string", "description": "An unique identifier within Status Page scope that defines a Service entry.", "nullable": false, "readOnly": true}, "type": {"type": "string", "description": "The type of the object returned by the API - in this case, a Status Page Service."}}}, "impact": {"description": "Status Page Impact", "nullable": false, "properties": {"id": {"type": "string", "description": "An unique identifier within Status Page scope that defines a Status Page Impact entry.", "nullable": false, "readOnly": true}, "type": {"type": "string", "description": "The type of the object returned by the API - in this case, a Status Page Impact."}}}}}, "minItems": 0}, "update_frequency_ms": {"type": "integer", "description": "The frequency of the next Post Update in milliseconds.", "nullable": true}, "notify_subscribers": {"type": "boolean", "description": "Determines if the subscribers should be notified of the Post Update.", "nullable": false}, "reported_at": {"type": "string", "description": "The date and time the Post Update was reported.", "nullable": true, "format": "date-time"}, "type": {"type": "string", "description": "The type of the object returned by the API - in this case, a Status Page Post Update."}}, "required": ["type", "message", "status", "severity", "update_frequency_ms", "notify_subscribers", "impacted_services", "post"]}}, "required": ["post_update"]}',  # noqa: E501
    "CREATESTATUSPAGEPOSTMORTEM": '{"type": "object", "properties": {"postmortem": {"type": "object", "title": "PostmortemRequest", "description": "Request to create/update a given Postmortem resource.", "properties": {"type": {"type": "string", "description": "The type of the object returned by the API - in this case, a Status Page Post Postmortem.", "nullable": false, "readOnly": true, "enum": ["status_page_post_postmortem"], "default": "status_page_post_postmortem"}, "post": {"description": "Status Page Post", "nullable": false, "properties": {"id": {"description": "Status page post unique identifier", "type": "string"}, "type": {"description": "A string that determines the schema of the object.", "type": "string"}}, "required": ["id"], "type": "object"}, "message": {"type": "string", "description": "The message of the Postmortem (supports Rich-Text).", "nullable": false, "maxLength": 10000}, "notify_subscribers": {"type": "boolean", "description": "Whether or not subscribers of the Status Page should be notified about the Postmortem.", "nullable": false}}, "required": ["type", "message", "post", "notify_subscribers"]}}, "required": ["post_update"]}',  # noqa: E501
    "UPDATESTATUSPAGEPOSTMORTEM": '{"type": "object", "properties": {"postmortem": {"type": "object", "title": "PostmortemRequest", "description": "Request to create/update a given Postmortem resource.", "properties": {"type": {"type": "string", "description": "The type of the object returned by the API - in this case, a Status Page Post Postmortem.", "nullable": false, "readOnly": true, "enum": ["status_page_post_postmortem"], "default": "status_page_post_postmortem"}, "post": {"description": "Status Page Post", "nullable": false, "properties": {"id": {"description": "Status page post unique identifier", "type": "string"}, "type": {"description": "A string that determines the schema of the object.", "type": "string"}}, "required": ["id"], "type": "object"}, "message": {"type": "string", "description": "The message of the Postmortem (supports Rich-Text).", "nullable": false, "maxLength": 10000}, "notify_subscribers": {"type": "boolean", "description": "Whether or not subscribers of the Status Page should be notified about the Postmortem.", "nullable": false}}, "required": ["type", "message", "post", "notify_subscribers"]}}, "required": ["postmortem"]}',  # noqa: E501
    "CREATESTATUSPAGESUBSCRIPTION": '{"type": "object", "properties": {"subscription": {"type": "object", "title": "StatusPageSubscriptionRequest", "description": "Request schema for creating a StatusPageSubscription.", "properties": {"channel": {"description": "The channel of the Subscription.", "enum": ["webhook", "email"], "nullable": false, "title": "SubscriptionChannel", "type": "string"}, "contact": {"description": "The subscriber\'s contact - email address or webhook URL.", "type": "string", "nullable": false}, "status_page": {"description": "Status Page", "nullable": false, "properties": {"id": {"description": "The id of the status page.", "type": "string"}, "type": {"description": "A string that determines the schema of the object.", "type": "string"}}, "required": ["id"], "type": "object"}, "subscribable_object": {"type": "object", "title": "SubscribableObject", "description": "The subscribed entity for a given subscription.", "properties": {"id": {"description": "The ID of the subscribed entity for a given subscription.", "type": "string", "nullable": false}, "type": {"description": "The type of the subscribed entity for a given subscription.", "enum": ["status_page", "status_page_service", "status_page_post"], "type": "string", "nullable": false}}}, "type": {"description": "A string that determines the schema of the object.", "type": "string"}}, "required": ["channel", "contact", "subscribable_object", "status_page", "type"]}}, "required": ["subscription"]}',  # noqa: E501
    "CREATETAG": '{"type": "object", "properties": {"tag": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "description": "The type of object being created.", "default": "tag", "enum": ["tag"]}, "label": {"type": "string", "description": "The label of the tag.", "maxLength": 191}}, "required": ["label", "type"], "example": {"type": "tag", "label": "Batman"}}]}}, "required": ["tag"]}',  # noqa: E501
    "CREATENEWTEAM": '{"type": "object", "properties": {"team": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "description": "The type of object being created.", "default": "team", "enum": ["team"]}, "name": {"type": "string", "description": "The name of the team.", "maxLength": 100}, "description": {"type": "string", "description": "The description of the team.", "maxLength": 1024}, "default_role": {"type": "string", "description": "The team is private if the value is "none", or public if it is "manager" (the default permissions for a non-member of the team are either "none", or their base role up until "manager").", "default": "manager", "enum": ["manager", "none"]}}, "required": ["name", "type"], "example": {"type": "team", "name": "Engineering", "description": "The engineering team"}}]}}, "required": ["team"]}',  # noqa: E501
    "UPDATETEAM": '{"type": "object", "properties": {"team": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"type": {"type": "string", "description": "The type of object being created.", "default": "team", "enum": ["team"]}, "name": {"type": "string", "description": "The name of the team.", "maxLength": 100}, "description": {"type": "string", "description": "The description of the team.", "maxLength": 1024}, "default_role": {"type": "string", "description": "The team is private if the value is "none", or public if it is "manager" (the default permissions for a non-member of the team are either "none", or their base role up until "manager").", "default": "manager", "enum": ["manager", "none"]}}, "required": ["name", "type"], "example": {"type": "team", "name": "Engineering", "description": "The engineering team"}}]}}, "required": ["team"]}',  # noqa: E501
    "CREATETEAMNOTIFICATIONSUBSCRIPTIONS": '{"type": "object", "properties": {"subscribables": {"type": "array", "uniqueItems": true, "minItems": 1, "items": {"title": "NotificationSubscribable", "description": "A reference of a subscribable entity.", "type": "object", "properties": {"subscribable_id": {"type": "string", "description": "The ID of the entity to subscribe to"}, "subscribable_type": {"type": "string", "description": "The type of the entity being subscribed to", "enum": ["incident", "business_service"]}}, "example": {"subscribable_id": "PD1234", "subscribable_type": "incident"}}}}, "required": ["subscribables"]}',  # noqa: E501
    "UNSUBSCRIBETEAMNOTIFICATIONS": '{"type": "object", "properties": {"subscribables": {"type": "array", "uniqueItems": true, "minItems": 1, "items": {"title": "NotificationSubscribable", "description": "A reference of a subscribable entity.", "type": "object", "properties": {"subscribable_id": {"type": "string", "description": "The ID of the entity to subscribe to"}, "subscribable_type": {"type": "string", "description": "The type of the entity being subscribed to", "enum": ["incident", "business_service"]}}, "example": {"subscribable_id": "PD1234", "subscribable_type": "incident"}}}}, "required": ["subscribables"]}',  # noqa: E501
    "RENDERSTATUSUPDATETEMPLATE": '{"oneOf": [{"type": "object", "properties": {"incident_id": {"type": "string", "description": "The incident id to render the template for"}, "status_update": {"type": "object", "properties": {"message": {"type": "string", "description": "An optional status update message that will be sent to the template"}}}, "external": {"description": "An optional object collection that can be referenced in the template."}}}]}',  # noqa: E501
    "CREATEPAGERDUTYUSER": '{"type": "object", "properties": {"user": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the user.", "maxLength": 100}, "type": {"type": "string", "description": "The type of object being created.", "default": "user", "enum": ["user"]}, "email": {"type": "string", "format": "email", "description": "The user\'s email address.", "minLength": 6, "maxLength": 100}, "time_zone": {"type": "string", "format": "tzinfo", "description": "The preferred time zone name. If null, the account\'s time zone will be used."}, "color": {"type": "string", "description": "The schedule color."}, "role": {"description": "The user role. Account must have the `read_only_users` ability to set a user as a `read_only_user` or a `read_only_limited_user`, and must have advanced permissions abilities to set a user as `observer` or `restricted_access`.", "type": "string", "enum": ["admin", "limited_user", "observer", "owner", "read_only_user", "restricted_access", "read_only_limited_user", "user"]}, "avatar_url": {"type": "string", "format": "url", "description": "The URL of the user\'s avatar.", "readOnly": true}, "description": {"type": "string", "description": "The user\'s bio.", "nullable": true}, "invitation_sent": {"type": "boolean", "readOnly": true, "description": "If true, the user has an outstanding invitation."}, "job_title": {"type": "string", "description": "The user\'s title.", "maxLength": 100}, "created_via_sso": {"type": "boolean", "readOnly": true, "description": "If true, the user was created via Single Sign-On (SSO)."}, "teams": {"type": "array", "readOnly": true, "description": "The list of teams to which the user belongs. Account must have the `teams` ability to set this.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["team_reference"]}}}]}}, "contact_methods": {"type": "array", "readOnly": true, "description": "The list of contact methods for the user.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["email_contact_method_reference", "phone_contact_method_reference", "push_notification_contact_method_reference", "sms_contact_method_reference"]}}}]}}, "notification_rules": {"readOnly": true, "type": "array", "description": "The list of notification rules for the user.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["assignment_notification_rule_reference"]}}}]}}}, "required": ["name", "email", "type"], "example": {"type": "user", "name": "Earline Greenholt", "email": "125.greenholt.earline@graham.name", "time_zone": "America/Lima", "color": "green", "role": "admin", "job_title": "Director of Engineering", "created_via_sso": false, "avatar_url": "https://secure.gravatar.com/avatar/1d1a39d4635208d5664082a6c654a73f.png?d=mm&r=PG", "description": "I\'m the boss"}}]}, {"properties": {"license": {"allOf": [{"description": "The License assigned to the User"}, {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["license_reference"]}}}]}]}}}]}}, "required": ["user"]}',  # noqa: E501
    "UPDATEPAGERDUTYUSER": '{"type": "object", "properties": {"user": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the user.", "maxLength": 100}, "type": {"type": "string", "description": "The type of object being created.", "default": "user", "enum": ["user"]}, "email": {"type": "string", "format": "email", "description": "The user\'s email address.", "minLength": 6, "maxLength": 100}, "time_zone": {"type": "string", "format": "tzinfo", "description": "The preferred time zone name. If null, the account\'s time zone will be used."}, "color": {"type": "string", "description": "The schedule color."}, "role": {"description": "The user role. Account must have the `read_only_users` ability to set a user as a `read_only_user` or a `read_only_limited_user`, and must have advanced permissions abilities to set a user as `observer` or `restricted_access`.", "type": "string", "enum": ["admin", "limited_user", "observer", "owner", "read_only_user", "restricted_access", "read_only_limited_user", "user"]}, "avatar_url": {"type": "string", "format": "url", "description": "The URL of the user\'s avatar.", "readOnly": true}, "description": {"type": "string", "description": "The user\'s bio.", "nullable": true}, "invitation_sent": {"type": "boolean", "readOnly": true, "description": "If true, the user has an outstanding invitation."}, "job_title": {"type": "string", "description": "The user\'s title.", "maxLength": 100}, "created_via_sso": {"type": "boolean", "readOnly": true, "description": "If true, the user was created via Single Sign-On (SSO)."}, "teams": {"type": "array", "readOnly": true, "description": "The list of teams to which the user belongs. Account must have the `teams` ability to set this.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["team_reference"]}}}]}}, "contact_methods": {"type": "array", "readOnly": true, "description": "The list of contact methods for the user.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["email_contact_method_reference", "phone_contact_method_reference", "push_notification_contact_method_reference", "sms_contact_method_reference"]}}}]}}, "notification_rules": {"readOnly": true, "type": "array", "description": "The list of notification rules for the user.", "items": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["assignment_notification_rule_reference"]}}}]}}}, "required": ["name", "email", "type"], "example": {"type": "user", "name": "Earline Greenholt", "email": "125.greenholt.earline@graham.name", "time_zone": "America/Lima", "color": "green", "role": "admin", "job_title": "Director of Engineering", "created_via_sso": false, "avatar_url": "https://secure.gravatar.com/avatar/1d1a39d4635208d5664082a6c654a73f.png?d=mm&r=PG", "description": "I\'m the boss"}}]}, {"properties": {"license": {"allOf": [{"description": "The License assigned to the User"}, {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["license_reference"]}}}]}]}}}]}}, "required": ["user"]}',  # noqa: E501
    "CREATEUSERCONTACTMETHOD": '{"type": "object", "properties": {"contact_method": {"oneOf": [{"description": "The Phone Contact Method of the User, used for Voice or SMS.", "allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "description": "The method to contact a user.", "properties": {"type": {"type": "string", "description": "The type of contact method being created.", "enum": ["email_contact_method", "phone_contact_method", "push_notification_contact_method", "sms_contact_method"]}, "label": {"type": "string", "description": "The label (e.g., "Work", "Mobile", etc.)."}, "address": {"type": "string", "description": "The "address" to deliver to: email, phone number, etc., depending on the type."}}, "discriminator": {"propertyName": "type"}, "required": ["type", "label", "address"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["phone_contact_method", "sms_contact_method"]}, "country_code": {"type": "integer", "description": "The 1-to-3 digit country calling code.", "minimum": 1, "maximum": 1999}, "enabled": {"type": "boolean", "description": "If true, this phone is capable of receiving SMS messages.", "readOnly": true}, "blacklisted": {"type": "boolean", "description": "If true, this phone has been blacklisted by PagerDuty and no messages will be sent to it.", "readOnly": true}}, "required": ["country_code"], "example": {"type": "phone_contact_method", "label": "work", "country_code": 123, "address": "1234567"}}]}, {"description": "The Push Contact Method of the User.", "allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "description": "The method to contact a user.", "properties": {"type": {"type": "string", "description": "The type of contact method being created.", "enum": ["email_contact_method", "phone_contact_method", "push_notification_contact_method", "sms_contact_method"]}, "label": {"type": "string", "description": "The label (e.g., "Work", "Mobile", etc.)."}, "address": {"type": "string", "description": "The "address" to deliver to: email, phone number, etc., depending on the type."}}, "discriminator": {"propertyName": "type"}, "required": ["type", "label", "address"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["push_notification_contact_method"]}, "device_type": {"type": "string", "description": "The type of device.", "enum": ["android", "ios"], "readOnly": true}, "sounds": {"type": "array", "items": {"type": "object", "properties": {"type": {"type": "string", "description": "The type of sound.", "enum": ["alert_high_urgency", "alert_low_urgency"]}, "file": {"type": "string", "description": "The sound file name."}}}}, "created_at": {"type": "string", "format": "date-time", "description": "Time at which the contact method was created."}, "blacklisted": {"type": "boolean", "description": "If true, this phone has been blacklisted by PagerDuty and no messages will be sent to it.", "readOnly": true}}, "required": ["device_type"], "example": {"type": "push_notification_contact_method", "label": "work", "device_type": "android", "address": "12341234"}}]}, {"description": "The Email Contact Method of the User.", "allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "description": "The method to contact a user.", "properties": {"type": {"type": "string", "description": "The type of contact method being created.", "enum": ["email_contact_method", "phone_contact_method", "push_notification_contact_method", "sms_contact_method"]}, "label": {"type": "string", "description": "The label (e.g., "Work", "Mobile", etc.)."}, "address": {"type": "string", "description": "The "address" to deliver to: email, phone number, etc., depending on the type."}}, "discriminator": {"propertyName": "type"}, "required": ["type", "label", "address"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["email_contact_method"]}, "send_short_email": {"type": "boolean", "description": "Send an abbreviated email message instead of the standard email output. Useful for email-to-SMS gateways and email based pagers.", "default": false}}, "example": {"type": "email_contact_method", "label": "work", "address": "grady.haylie.126@hickle.net", "send_short_email": false}}]}]}}, "required": ["contact_method"]}',  # noqa: E501
    "UPDATEUSERCONTACTMETHOD": '{"type": "object", "properties": {"contact_method": {"oneOf": [{"description": "The Phone Contact Method of the User, used for Voice or SMS.", "allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "description": "The method to contact a user.", "properties": {"type": {"type": "string", "description": "The type of contact method being created.", "enum": ["email_contact_method", "phone_contact_method", "push_notification_contact_method", "sms_contact_method"]}, "label": {"type": "string", "description": "The label (e.g., "Work", "Mobile", etc.)."}, "address": {"type": "string", "description": "The "address" to deliver to: email, phone number, etc., depending on the type."}}, "discriminator": {"propertyName": "type"}, "required": ["type", "label", "address"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["phone_contact_method", "sms_contact_method"]}, "country_code": {"type": "integer", "description": "The 1-to-3 digit country calling code.", "minimum": 1, "maximum": 1999}, "enabled": {"type": "boolean", "description": "If true, this phone is capable of receiving SMS messages.", "readOnly": true}, "blacklisted": {"type": "boolean", "description": "If true, this phone has been blacklisted by PagerDuty and no messages will be sent to it.", "readOnly": true}}, "required": ["country_code"], "example": {"type": "phone_contact_method", "label": "work", "country_code": 123, "address": "1234567"}}]}, {"description": "The Push Contact Method of the User.", "allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "description": "The method to contact a user.", "properties": {"type": {"type": "string", "description": "The type of contact method being created.", "enum": ["email_contact_method", "phone_contact_method", "push_notification_contact_method", "sms_contact_method"]}, "label": {"type": "string", "description": "The label (e.g., "Work", "Mobile", etc.)."}, "address": {"type": "string", "description": "The "address" to deliver to: email, phone number, etc., depending on the type."}}, "discriminator": {"propertyName": "type"}, "required": ["type", "label", "address"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["push_notification_contact_method"]}, "device_type": {"type": "string", "description": "The type of device.", "enum": ["android", "ios"], "readOnly": true}, "sounds": {"type": "array", "items": {"type": "object", "properties": {"type": {"type": "string", "description": "The type of sound.", "enum": ["alert_high_urgency", "alert_low_urgency"]}, "file": {"type": "string", "description": "The sound file name."}}}}, "created_at": {"type": "string", "format": "date-time", "description": "Time at which the contact method was created."}, "blacklisted": {"type": "boolean", "description": "If true, this phone has been blacklisted by PagerDuty and no messages will be sent to it.", "readOnly": true}}, "required": ["device_type"], "example": {"type": "push_notification_contact_method", "label": "work", "device_type": "android", "address": "12341234"}}]}, {"description": "The Email Contact Method of the User.", "allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "description": "The method to contact a user.", "properties": {"type": {"type": "string", "description": "The type of contact method being created.", "enum": ["email_contact_method", "phone_contact_method", "push_notification_contact_method", "sms_contact_method"]}, "label": {"type": "string", "description": "The label (e.g., "Work", "Mobile", etc.)."}, "address": {"type": "string", "description": "The "address" to deliver to: email, phone number, etc., depending on the type."}}, "discriminator": {"propertyName": "type"}, "required": ["type", "label", "address"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["email_contact_method"]}, "send_short_email": {"type": "boolean", "description": "Send an abbreviated email message instead of the standard email output. Useful for email-to-SMS gateways and email based pagers.", "default": false}}, "example": {"type": "email_contact_method", "label": "work", "address": "grady.haylie.126@hickle.net", "send_short_email": false}}]}]}}, "required": ["contact_method"]}',  # noqa: E501
    "CREATEUSERNOTIFICATIONRULE": '{"type": "object", "properties": {"notification_rule": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "description": "A rule for contacting the user.", "properties": {"type": {"type": "string", "description": "The type of object being created.", "default": "assignment_notification_rule", "enum": ["assignment_notification_rule"]}, "start_delay_in_minutes": {"type": "integer", "description": "The delay before firing the rule, in minutes.", "minimum": 0}, "contact_method": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["email_contact_method_reference", "phone_contact_method_reference", "push_notification_contact_method_reference", "sms_contact_method_reference"]}}}]}, "urgency": {"type": "string", "enum": ["high", "low"], "description": "Which incident urgency this rule is used for. Account must have the `urgencies` ability to have a low urgency notification rule."}}, "required": ["start_delay_in_minutes", "urgency", "contact_method", "type"], "example": {"type": "assignment_notification_rule", "start_delay_in_minutes": 0, "contact_method": {"id": "PXPGF42", "type": "email_contact_method_reference"}, "urgency": "high"}}]}}, "required": ["notification_rule"]}',  # noqa: E501
    "UPDATEUSERNOTIFICATIONRULE": '{"type": "object", "properties": {"notification_rule": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "description": "A rule for contacting the user.", "properties": {"type": {"type": "string", "description": "The type of object being created.", "default": "assignment_notification_rule", "enum": ["assignment_notification_rule"]}, "start_delay_in_minutes": {"type": "integer", "description": "The delay before firing the rule, in minutes.", "minimum": 0}, "contact_method": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["email_contact_method_reference", "phone_contact_method_reference", "push_notification_contact_method_reference", "sms_contact_method_reference"]}}}]}, "urgency": {"type": "string", "enum": ["high", "low"], "description": "Which incident urgency this rule is used for. Account must have the `urgencies` ability to have a low urgency notification rule."}}, "required": ["start_delay_in_minutes", "urgency", "contact_method", "type"], "example": {"type": "assignment_notification_rule", "start_delay_in_minutes": 0, "contact_method": {"id": "PXPGF42", "type": "email_contact_method_reference"}, "urgency": "high"}}]}}, "required": ["notification_rule"]}',  # noqa: E501
    "CREATEUSERNOTIFICATIONSUBSCRIPTIONS": '{"type": "object", "properties": {"subscribables": {"type": "array", "uniqueItems": true, "minItems": 1, "items": {"title": "NotificationSubscribable", "description": "A reference of a subscribable entity.", "type": "object", "properties": {"subscribable_id": {"type": "string", "description": "The ID of the entity to subscribe to"}, "subscribable_type": {"type": "string", "description": "The type of the entity being subscribed to", "enum": ["incident", "business_service"]}}, "example": {"subscribable_id": "PD1234", "subscribable_type": "incident"}}}}, "required": ["subscribables"]}',  # noqa: E501
    "UNSUBSCRIBEUSERNOTIFICATIONS": '{"type": "object", "properties": {"subscribables": {"type": "array", "uniqueItems": true, "minItems": 1, "items": {"title": "NotificationSubscribable", "description": "A reference of a subscribable entity.", "type": "object", "properties": {"subscribable_id": {"type": "string", "description": "The ID of the entity to subscribe to"}, "subscribable_type": {"type": "string", "description": "The type of the entity being subscribed to", "enum": ["incident", "business_service"]}}, "example": {"subscribable_id": "PD1234", "subscribable_type": "incident"}}}}, "required": ["subscribables"]}',  # noqa: E501
    "CREATEHANDOFFNOTIFICATIONRULE": '{"type": "object", "properties": {"oncall_handoff_notification_rule": {"type": "object", "description": "A rule for contacting the user for Handoff Notifications.", "properties": {"id": {"type": "string", "readOnly": true}, "notify_advance_in_minutes": {"type": "integer", "description": "The delay before firing the rule, in minutes.", "minimum": 0}, "handoff_type": {"type": "string", "description": "The type of handoff being created.", "default": "both", "enum": ["both", "oncall", "offcall"]}, "contact_method": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["email_contact_method_reference", "phone_contact_method_reference", "push_notification_contact_method_reference", "sms_contact_method_reference"]}}}]}}, "required": ["id", "handoff_type", "contact_method"], "example": {"id": "PXPGF42", "notify_advance_in_minutes": 180, "handoff_type": "both", "contact_method": {"id": "PXPGF42", "type": "email_contact_method_reference"}}}}, "required": ["oncall_handoff_notification_rule"]}',  # noqa: E501
    "UPDATEUSERHANDOFFNOTIFICATION": '{"type": "object", "properties": {"oncall_handoff_notification_rule": {"type": "object", "description": "A rule for contacting the user for Handoff Notifications.", "properties": {"id": {"type": "string", "readOnly": true}, "notify_advance_in_minutes": {"type": "integer", "description": "The delay before firing the rule, in minutes.", "minimum": 0}, "handoff_type": {"type": "string", "description": "The type of handoff being created.", "default": "both", "enum": ["both", "oncall", "offcall"]}, "contact_method": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["email_contact_method_reference", "phone_contact_method_reference", "push_notification_contact_method_reference", "sms_contact_method_reference"]}}}]}}, "required": ["id", "handoff_type", "contact_method"], "example": {"id": "PXPGF42", "notify_advance_in_minutes": 180, "handoff_type": "both", "contact_method": {"id": "PXPGF42", "type": "email_contact_method_reference"}}}}, "required": ["oncall_handoff_notification_rule"]}',  # noqa: E501
    "UPDATEUSERSTATUSNOTIFICATIONRULE": '{"type": "object", "properties": {"status_update_notification_rule": {"type": "object", "description": "A rule for contacting the user for Incident Status Updates.", "properties": {"contact_method": {"allOf": [{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "summary": {"type": "string", "nullable": true, "readOnly": true, "description": "A 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."}, "type": {"type": "string", "readOnly": true, "description": "A 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."}, "self": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "the API show URL at which the object is accessible"}, "html_url": {"type": "string", "nullable": true, "readOnly": true, "format": "url", "description": "a URL at which the entity is uniquely displayed in the Web app"}}}, {"type": "object", "required": ["type", "id"]}]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["email_contact_method_reference", "phone_contact_method_reference", "push_notification_contact_method_reference", "sms_contact_method_reference"]}}}]}}, "required": ["contact_method"], "example": {"contact_method": {"id": "PXPGF42", "type": "email_contact_method_reference"}}}}, "required": ["status_update_notification_rule"]}',  # noqa: E501
    "CREATEWEBHOOKSUBSCRIPTION": '{"type": "object", "properties": {"webhook_subscription": {"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "type": {"type": "string", "description": "The type indicating the schema of the object.", "default": "webhook_subscription", "enum": ["webhook_subscription"]}, "active": {"type": "boolean", "default": true, "description": "Determines whether this subscription will produce webhook events."}, "delivery_method": {"type": "object", "properties": {"id": {"type": "string", "readOnly": true}, "secret": {"type": "string", "description": "The secret used to sign webhook payloads. Only provided on the initial create response.", "nullable": true, "readOnly": true}, "temporarily_disabled": {"type": "boolean", "description": "Whether or not this webhook subscription is temporarily disabled. Becomes `true` if the delivery method URL is repeatedly rejected by the server."}, "type": {"type": "string", "description": "Indicates the type of the delivery method.", "default": "http_delivery_method", "enum": ["http_delivery_method"]}, "url": {"type": "string", "description": "The destination URL for webhook delivery.", "format": "url"}, "custom_headers": {"type": "array", "description": "Optional headers to be set on this webhook subscription when sent. The header values are redacted in GET requests, but are not redacted on the webhook when delivered to the webhook\'s endpoint.", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The header name"}, "value": {"type": "string", "description": "The header value"}}}}}, "required": ["type", "url"]}, "description": {"type": "string", "description": "A short description of the webhook subscription."}, "events": {"type": "array", "description": "The set of outbound event types the webhook will receive.", "minItems": 1, "uniqueItems": true, "items": {"type": "string"}}, "filter": {"type": "object", "properties": {"id": {"type": "string", "description": "The id of the object being used as the filter.  This field is required for all filter types except account_reference."}, "type": {"type": "string", "description": "The type of object being used as the filter.", "enum": ["account_reference", "service_reference", "team_reference"]}}, "required": ["type"]}, "oauth_client": {"description": "OAuth client details. This field is populated in responses when oauth_client_id is set.", "readOnly": true, "type": "object", "properties": {"id": {"type": "string", "description": "The ID of the OAuth client", "example": "AGMEB7F7YJYELCPG4Y5YWMYGXE"}, "type": {"type": "string", "enum": ["oauth_client_reference"], "description": "The type of object being referenced", "example": "oauth_client_reference", "default": "oauth_client_reference"}, "summary": {"type": "string", "description": "A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client", "example": "PagerDuty Webhook Integration", "readOnly": true}}, "required": ["id", "type"]}}, "required": ["type", "delivery_method", "events", "filter"]}}, "required": ["webhook_subscription"]}',  # noqa: E501
}
