customfields_fields

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

Overview

Name	customfields_fields
Type	Resource
Id	pagerduty.custom_fields.customfields_fields

Fields

The following fields are returned by SELECT queries:

get_custom_fields_field

The field requested.

Name	Datatype	Description
id	string	The ID of the resource.
display_name	string	The human-readable name of the field. This must be unique across an account.
created_at	string (date-time)	The date/time the object was created at.
datatype	string	The kind of data the custom field is allowed to contain.
description	string	A description of the data this field contains.
field_options	array	The fixed list of value options that may be stored in this field.
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"
self	string (url)	The API show URL at which the object is accessible
summary	string	A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier.
type	string
updated_at	string (date-time)	The date/time the object was last updated.

list_custom_fields_fields

A paginated list of fields.

Name	Datatype	Description
id	string	The ID of the resource.
display_name	string	The human-readable name of the field. This must be unique across an account.
created_at	string (date-time)	The date/time the object was created at.
datatype	string	The kind of data the custom field is allowed to contain.
description	string	A description of the data this field contains.
field_options	array	The fixed list of value options that may be stored in this field.
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"
self	string (url)	The API show URL at which the object is accessible
summary	string	A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier.
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	select	field_id, X-EARLY-ACCESS	include[]	Show detailed information about 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.
list_custom_fields_fields	select	X-EARLY-ACCESS	limit, offset, total, include[]	List fields. <!-- 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	insert	X-EARLY-ACCESS, data__field		Create a new Field, along with the Field Options if provided. An account may have up to 1000 Fields. <!-- 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	delete	field_id, X-EARLY-ACCESS		Delete a Field. Fields may not be deleted if they are used by a Field 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_fields	exec	X-EARLY-ACCESS	limit, offset, total, include[]	List fields. <!-- 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	exec	field_id, X-EARLY-ACCESS	include[]	Show detailed information about 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.
update_custom_fields_field	exec	field_id, X-EARLY-ACCESS, field		Update 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.
include[]	string	Array of additional details to include.
limit	integer	The number of results per page.
offset	integer	Offset to start pagination search results.
total	boolean	By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated. See our Pagination Docs for more information.

SELECT examples

get_custom_fields_field

Show detailed information about 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,
display_name,
created_at,
datatype,
description,
field_options,
fixed_options,
multi_value,
self,
summary,
type,
updated_at
FROM pagerduty.custom_fields.customfields_fields
WHERE field_id = '{{ field_id }}' -- required
AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required
AND include[] = '{{ include[] }}'
;

list_custom_fields_fields

List fields.

<!-- 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,
display_name,
created_at,
datatype,
description,
field_options,
fixed_options,
multi_value,
self,
summary,
type,
updated_at
FROM pagerduty.custom_fields.customfields_fields
WHERE X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required
AND limit = '{{ limit }}'
AND offset = '{{ offset }}'
AND total = '{{ total }}'
AND include[] = '{{ include[] }}'
;

INSERT examples

create_custom_fields_field

Create a new Field, along with the Field Options if provided. An account may have up to 1000 Fields.

<!-- 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 (
data__field,
X-EARLY-ACCESS
)
SELECT 
'{{ field }}' /* required */,
'{{ X-EARLY-ACCESS }}'
RETURNING
field
;

Manifest

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

DELETE examples

delete_custom_fields_field

Delete a Field. Fields may not be deleted if they are used by a Field 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.customfields_fields
WHERE field_id = '{{ field_id }}' --required
AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' --required
;

Lifecycle Methods

_list_custom_fields_fields

List fields.

<!-- 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._list_custom_fields_fields 
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@total={{ total }}, 
@include[]='{{ include[] }}'
;

_get_custom_fields_field

Show detailed information about 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._get_custom_fields_field 
@field_id='{{ field_id }}' --required, 
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, 
@include[]='{{ include[] }}'
;

update_custom_fields_field

Update 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.update_custom_fields_field 
@field_id='{{ field_id }}' --required, 
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required 
@@json=
'{
"field": "{{ field }}"
}'
;