custom_field_values

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

Overview

Name	custom_field_values
Type	Resource
Id	pagerduty.incidents.custom_field_values

Fields

The following fields are returned by SELECT queries:

list

The list of custom 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 and cannot be changed once created. (title: Field Name)
display_name	string	The human-readable name of the field. This must be unique across an account.
data_type	string	The kind of data the custom field is allowed to contain. (boolean, integer, float, string, datetime, url)
description	string	A description of the data this field contains.
field_type	string	The type of data this field contains. In combination with the data_type field. (single_value, single_value_fixed, multi_value, multi_value_fixed)
type	string	Determines the type of the reference. (field_value)
value	object	(title: Boolean)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	id		Get custom field values for an incident.<br /><br /><!-- theme: warning --><br /><br />Scoped OAuth requires: incidents.read<br />
update	update	id, custom_fields		Set custom field values for an incident.<br /><br />Scoped OAuth requires: incidents.write<br />

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
id	string	The ID of the resource.

SELECT examples

list

Get custom field values for an incident.<br /><br /><!-- theme: warning --><br /><br />Scoped OAuth requires: incidents.read<br />

SELECT
id,
name,
display_name,
data_type,
description,
field_type,
type,
value
FROM pagerduty.incidents.custom_field_values
WHERE id = '{{ id }}' -- required
;

UPDATE examples

update

Set custom field values for an incident.<br /><br />Scoped OAuth requires: incidents.write<br />

UPDATE pagerduty.incidents.custom_field_values
SET 
custom_fields = '{{ custom_fields }}'
WHERE 
id = '{{ id }}' --required
AND custom_fields = '{{ custom_fields }}' --required
RETURNING
custom_fields;