field_values

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

Overview

Name	field_values
Type	Resource
Id	pagerduty.incidents.field_values

Fields

The following fields are returned by SELECT queries:

get_incident_field_values

The list of field values

Name	Datatype	Description
id	string	Id of the field.
name	string	The name of the field. May include ASCII characters, specifically lowercase letters, digits, and underescores. The name for a Field must be unique.
display_name	string	The human-readable name of the field. This must be unique across an account.
datatype	string	The kind of data the custom field is allowed to contain.
description	string	A description of the data this field contains.
fixed_options	boolean	If true, restricts the values allowed to be stored in the custom field to a limited set of options (configured via the Field Option sub-resource). Must be false if datatype is "boolean", "url", or "datetime"
multi_value	boolean	If true, allows the custom field to store a set of multiple values. Must be false if datatype is not "string" or "url"
type	string	Determines the type of the reference.
value

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_incident_field_values	select	id, X-EARLY-ACCESS		Get field values 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_incident_field_values	exec	id, X-EARLY-ACCESS		Get field values 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.
set_incident_field_values	exec	id, field_values		Set field values 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.

SELECT examples

get_incident_field_values

Get field values 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,
name,
display_name,
datatype,
description,
fixed_options,
multi_value,
type,
value
FROM pagerduty.incidents.field_values
WHERE id = '{{ id }}' -- required
AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required
;

Lifecycle Methods

_get_incident_field_values

Get field values 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._get_incident_field_values 
@id='{{ id }}' --required, 
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required
;

set_incident_field_values

Set field values 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.set_incident_field_values 
@id='{{ id }}' --required 
@@json=
'{
"field_values": "{{ field_values }}"
}'
;