custom_field_options

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

Overview

Name	custom_field_options
Type	Resource
Id	pagerduty.incident_types.custom_field_options

Fields

The following fields are returned by SELECT queries:

get

The field option of the custom field 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	object
type	string	(field_option)
updated_at	string (date-time)	The date/time the object was last updated.

list

The field option for the custom field 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	object
type	string	(field_option)
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	select	type_id_or_name, field_option_id, field_id		Get a field option on a custom field<br /><br />Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data,<br />to provide additional context and support features such as customized filtering, search and analytics.<br />Custom Fields can be applied to different incident types.<br /><br />Scoped OAuth requires: custom_fields.read<br />
list	select	type_id_or_name, field_id		List field options for a custom field.<br /><br />Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data,<br />to provide additional context and support features such as customized filtering, search and analytics.<br />Custom Fields can be applied to different incident types.<br /><br />Scoped OAuth requires: custom_fields.read<br />
create	insert	type_id_or_name, field_id, field_option		Create a field option for a custom field.<br /><br />Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data,<br />to provide additional context and support features such as customized filtering, search and analytics.<br />Custom Fields can be applied to different incident types.<br /><br />Scoped OAuth requires: custom_fields.write<br />
update	update	type_id_or_name, field_option_id, field_id, field_option		Update a field option for a custom field.<br /><br />Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data,<br />to provide additional context and support features such as customized filtering, search and analytics.<br />Custom Fields can be applied to different incident types.<br /><br />Scoped OAuth requires: custom_fields.write<br />
delete	delete	type_id_or_name, field_option_id, field_id		Delete a field option for a custom field.<br /><br />Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data,<br />to provide additional context and support features such as customized filtering, search and analytics.<br />Custom Fields can be applied to different incident types.<br /><br />Scoped OAuth requires: custom_fields.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
field_id	string	The ID of the field.
field_option_id	string	The ID of the field option.
type_id_or_name	string	The ID or name of the Incident Type.

SELECT examples

get

Get a field option on a custom field<br /><br />Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data,<br />to provide additional context and support features such as customized filtering, search and analytics.<br />Custom Fields can be applied to different incident types.<br /><br />Scoped OAuth requires: custom_fields.read<br />

SELECT
id,
created_at,
data,
type,
updated_at
FROM pagerduty.incident_types.custom_field_options
WHERE type_id_or_name = '{{ type_id_or_name }}' -- required
AND field_option_id = '{{ field_option_id }}' -- required
AND field_id = '{{ field_id }}' -- required
;

list

List field options for a custom field.<br /><br />Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data,<br />to provide additional context and support features such as customized filtering, search and analytics.<br />Custom Fields can be applied to different incident types.<br /><br />Scoped OAuth requires: custom_fields.read<br />

SELECT
id,
created_at,
data,
type,
updated_at
FROM pagerduty.incident_types.custom_field_options
WHERE type_id_or_name = '{{ type_id_or_name }}' -- required
AND field_id = '{{ field_id }}' -- required
;

INSERT examples

create

Create a field option for a custom field.<br /><br />Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data,<br />to provide additional context and support features such as customized filtering, search and analytics.<br />Custom Fields can be applied to different incident types.<br /><br />Scoped OAuth requires: custom_fields.write<br />

INSERT INTO pagerduty.incident_types.custom_field_options (
field_option,
type_id_or_name,
field_id
)
SELECT 
'{{ field_option }}' /* required */,
'{{ type_id_or_name }}',
'{{ field_id }}'
RETURNING
field_option
;

Manifest

# Description fields are for documentation purposes
- name: custom_field_options
props:
  - name: type_id_or_name
    value: "{{ type_id_or_name }}"
    description: Required parameter for the custom_field_options resource.
  - name: field_id
    value: "{{ field_id }}"
    description: Required parameter for the custom_field_options resource.
  - name: field_option
    description: |
      Details of the field option to be created.
    value:
      data:
        data_type: "{{ data_type }}"
        value: "{{ value }}"

UPDATE examples

update

Update a field option for a custom field.<br /><br />Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data,<br />to provide additional context and support features such as customized filtering, search and analytics.<br />Custom Fields can be applied to different incident types.<br /><br />Scoped OAuth requires: custom_fields.write<br />

UPDATE pagerduty.incident_types.custom_field_options
SET 
field_option = '{{ field_option }}'
WHERE 
type_id_or_name = '{{ type_id_or_name }}' --required
AND field_option_id = '{{ field_option_id }}' --required
AND field_id = '{{ field_id }}' --required
AND field_option = '{{ field_option }}' --required
RETURNING
field_option;

DELETE examples

delete

Delete a field option for a custom field.<br /><br />Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data,<br />to provide additional context and support features such as customized filtering, search and analytics.<br />Custom Fields can be applied to different incident types.<br /><br />Scoped OAuth requires: custom_fields.write<br />

DELETE FROM pagerduty.incident_types.custom_field_options
WHERE type_id_or_name = '{{ type_id_or_name }}' --required
AND field_option_id = '{{ field_option_id }}' --required
AND field_id = '{{ field_id }}' --required
;