field_configurations

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

Overview

Name	field_configurations
Type	Resource
Id	pagerduty.custom_fields.field_configurations

Fields

The following fields are returned by SELECT queries:

get_custom_fields_field_configuration

The field configuration requested.

Name	Datatype	Description
id	string	The ID of the resource.
created_at	string (date-time)	The date/time the object was created at.
default_value	object	The value to use for this field if none is provided. It must be specified if required is true.
field		The Field to be included in this schema. Each Field may only be used in one Field Configuration per schema.
required	boolean	If true, this Field must always have a value set for objects using this schema.
type	string
updated_at	string (date-time)	The date/time the object was last updated.

list_custom_fields_field_configurations

A list of field configurations in the schema.

Name	Datatype	Description
id	string	The ID of the resource.
created_at	string (date-time)	The date/time the object was created at.
default_value	object	The value to use for this field if none is provided. It must be specified if required is true.
field		The Field to be included in this schema. Each Field may only be used in one Field Configuration per schema.
required	boolean	If true, this Field must always have a value set for objects using this schema.
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_configuration	select	schema_id, field_configuration_id, X-EARLY-ACCESS	include[]	Show detailed information about a Field Configuration. <!-- 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_configurations	select	schema_id, X-EARLY-ACCESS	include[]	List all Field Configurations for the given Schema. <!-- 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_configuration	insert	schema_id, X-EARLY-ACCESS, data__field_configuration		Add a new Field Configuration to an existing Schema. A Schema may use at most 20 Fields, and so may have at most 20 Field Configurations. <!-- 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_configuration	delete	schema_id, field_configuration_id, X-EARLY-ACCESS		Remove a Field Configuration and its associated Field from a Schema. <!-- 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_configurations	exec	schema_id, X-EARLY-ACCESS	include[]	List all Field Configurations for the given Schema. <!-- 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_configuration	exec	schema_id, field_configuration_id, X-EARLY-ACCESS	include[]	Show detailed information about a Field Configuration. <!-- 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_configuration	exec	schema_id, field_configuration_id, X-EARLY-ACCESS, field_configuration		Update settings for Field Configuration in Schema. <!-- 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_configuration_id	string	The ID of the field configuration.
schema_id	string	The ID of the schema.
include[]	string	Array of additional details to include.

SELECT examples

get_custom_fields_field_configuration

Show detailed information about a Field Configuration.

<!-- 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,
default_value,
field,
required,
type,
updated_at
FROM pagerduty.custom_fields.field_configurations
WHERE schema_id = '{{ schema_id }}' -- required
AND field_configuration_id = '{{ field_configuration_id }}' -- required
AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required
AND include[] = '{{ include[] }}'
;

list_custom_fields_field_configurations

List all Field Configurations for the given Schema.

<!-- 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,
default_value,
field,
required,
type,
updated_at
FROM pagerduty.custom_fields.field_configurations
WHERE schema_id = '{{ schema_id }}' -- required
AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required
AND include[] = '{{ include[] }}'
;

INSERT examples

create_custom_fields_field_configuration

Add a new Field Configuration to an existing Schema. A Schema may use at most 20 Fields, and so may have at most 20 Field Configurations.

<!-- 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.field_configurations (
data__field_configuration,
schema_id,
X-EARLY-ACCESS
)
SELECT 
'{{ field_configuration }}' /* required */,
'{{ schema_id }}',
'{{ X-EARLY-ACCESS }}'
RETURNING
field_configuration
;

Manifest

# Description fields are for documentation purposes
- name: field_configurations
  props:
    - name: schema_id
      value: string
      description: Required parameter for the field_configurations resource.
    - name: X-EARLY-ACCESS
      value: string
      description: Required parameter for the field_configurations resource.
    - name: field_configuration
      value: object

DELETE examples

delete_custom_fields_field_configuration

Remove a Field Configuration and its associated Field from a Schema.

<!-- 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.field_configurations
WHERE schema_id = '{{ schema_id }}' --required
AND field_configuration_id = '{{ field_configuration_id }}' --required
AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' --required
;

Lifecycle Methods

_list_custom_fields_field_configurations

List all Field Configurations for the given Schema.

<!-- 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.field_configurations._list_custom_fields_field_configurations 
@schema_id='{{ schema_id }}' --required, 
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, 
@include[]='{{ include[] }}'
;

_get_custom_fields_field_configuration

Show detailed information about a Field Configuration.

<!-- 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.field_configurations._get_custom_fields_field_configuration 
@schema_id='{{ schema_id }}' --required, 
@field_configuration_id='{{ field_configuration_id }}' --required, 
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, 
@include[]='{{ include[] }}'
;

update_custom_fields_field_configuration

Update settings for Field Configuration in Schema.

<!-- 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.field_configurations.update_custom_fields_field_configuration 
@schema_id='{{ schema_id }}' --required, 
@field_configuration_id='{{ field_configuration_id }}' --required, 
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required 
@@json=
'{
"field_configuration": "{{ field_configuration }}"
}'
;