field_values_schema

Creates, updates, deletes, gets or lists a field_values_schema resource.

Overview

Name	field_values_schema
Type	Resource
Id	pagerduty.incidents.field_values_schema

Fields

The following fields are returned by SELECT queries:

get_schema_for_incident

The schema requested.

Name	Datatype	Description
id	string	The ID of the resource.
description	string	A description of this schema.
field_configurations	array
self	string (url)	The API show URL at which the object is accessible
summary	string	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.
title	string	The name of the schema.
type	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_schema_for_incident	select	id, X-EARLY-ACCESS	include[]	Get detailed information about a Schema for an incident. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
_get_schema_for_incident	exec	id, X-EARLY-ACCESS	include[]	Get detailed information about a Schema for an incident. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

Parameters

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

Name	Datatype	Description
X-EARLY-ACCESS	string	This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header and the above value. Do not use this endpoint in production, as it may change!
id	string	The ID of the resource.
include[]	string	Array of additional details to include. Including field_options will also include field options.

SELECT examples

get_schema_for_incident

Get detailed information about a Schema for an incident.

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

SELECT
id,
description,
field_configurations,
self,
summary,
title,
type
FROM pagerduty.incidents.field_values_schema
WHERE id = '{{ id }}' -- required
AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required
AND include[] = '{{ include[] }}'
;

Lifecycle Methods

_get_schema_for_incident

Get detailed information about a Schema for an incident.

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

EXEC pagerduty.incidents.field_values_schema._get_schema_for_incident 
@id='{{ id }}' --required, 
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, 
@include[]='{{ include[] }}'
;