customfields_fields_field_options

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

Overview

Name	customfields_fields_field_options
Type	Resource
Id	pagerduty.custom_fields.customfields_fields_field_options

Fields

The following fields are returned by SELECT queries:

get_custom_fields_field_option

The field option requested.

Name	Datatype	Description
id	string	The ID of the resource.
created_at	string (date-time)	The date/time the object was created at.
data
type	string
updated_at	string (date-time)	The date/time the object was last updated.

list_custom_fields_field_options

A list of field options.

Name	Datatype	Description
id	string	The ID of the resource.
created_at	string (date-time)	The date/time the object was created at.
data
type	string
updated_at	string (date-time)	The date/time the object was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_custom_fields_field_option	select	field_id, field_option_id, X-EARLY-ACCESS		Get a Field Option. <!-- 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.
list_custom_fields_field_options	select	field_id, X-EARLY-ACCESS		List all enabled Field Options for a Field. <!-- 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.
create_custom_fields_field_option	insert	field_id, X-EARLY-ACCESS, data__field_option		Create a new Field Option. Field Options may only be created for Fields where fixed_options is true. A Field may have no more than 10 enabled options. <!-- 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.
delete_custom_fields_field_option	delete	field_id, field_option_id, X-EARLY-ACCESS		Delete a Field Option. <!-- 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.
_list_custom_fields_field_options	exec	field_id, X-EARLY-ACCESS		List all enabled Field Options for a Field. <!-- 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_custom_fields_field_option	exec	field_id, field_option_id, X-EARLY-ACCESS		Get a Field Option. <!-- 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.
update_custom_fields_field_option	exec	field_id, field_option_id, X-EARLY-ACCESS, field_option		Update Field Option for a Field. <!-- 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!
field_id	string	The ID of the field.
field_option_id	string	The ID of the field option.

SELECT examples

get_custom_fields_field_option

Get a Field Option.

<!-- 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,
created_at,
data,
type,
updated_at
FROM pagerduty.custom_fields.customfields_fields_field_options
WHERE field_id = '{{ field_id }}' -- required
AND field_option_id = '{{ field_option_id }}' -- required
AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required
;

list_custom_fields_field_options

List all enabled Field Options for a Field.

<!-- 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,
created_at,
data,
type,
updated_at
FROM pagerduty.custom_fields.customfields_fields_field_options
WHERE field_id = '{{ field_id }}' -- required
AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required
;

INSERT examples

create_custom_fields_field_option

Create a new Field Option. Field Options may only be created for Fields where fixed_options is true. A Field may have no more than 10 enabled options.

<!-- 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.

INSERT INTO pagerduty.custom_fields.customfields_fields_field_options (
data__field_option,
field_id,
X-EARLY-ACCESS
)
SELECT 
'{{ field_option }}' /* required */,
'{{ field_id }}',
'{{ X-EARLY-ACCESS }}'
RETURNING
field_option
;

Manifest

# Description fields are for documentation purposes
- name: customfields_fields_field_options
  props:
    - name: field_id
      value: string
      description: Required parameter for the customfields_fields_field_options resource.
    - name: X-EARLY-ACCESS
      value: string
      description: Required parameter for the customfields_fields_field_options resource.
    - name: field_option
      value: object

DELETE examples

delete_custom_fields_field_option

Delete a Field Option.

<!-- 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.

DELETE FROM pagerduty.custom_fields.customfields_fields_field_options
WHERE field_id = '{{ field_id }}' --required
AND field_option_id = '{{ field_option_id }}' --required
AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' --required
;

Lifecycle Methods

_list_custom_fields_field_options

List all enabled Field Options for a Field.

<!-- 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.custom_fields.customfields_fields_field_options._list_custom_fields_field_options 
@field_id='{{ field_id }}' --required, 
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required
;

_get_custom_fields_field_option

Get a Field Option.

<!-- 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.custom_fields.customfields_fields_field_options._get_custom_fields_field_option 
@field_id='{{ field_id }}' --required, 
@field_option_id='{{ field_option_id }}' --required, 
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required
;

update_custom_fields_field_option

Update Field Option for a Field.

<!-- 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.custom_fields.customfields_fields_field_options.update_custom_fields_field_option 
@field_id='{{ field_id }}' --required, 
@field_option_id='{{ field_option_id }}' --required, 
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required 
@@json=
'{
"field_option": "{{ field_option }}"
}'
;