fields_schemas

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

Overview

Name	fields_schemas
Type	Resource
Id	pagerduty.custom_fields.fields_schemas

Fields

The following fields are returned by SELECT queries:

list_custom_fields_schemas_using_field

A paginated list of schemas using the field.

Name	Datatype	Description
id	string	The ID of the resource.
created_at	string (date-time)	The date/time the object was created at.
description	string	A description of this schema.
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.
title	string	The name of the 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
list_custom_fields_schemas_using_field	select	field_id, X-EARLY-ACCESS	limit, offset, total	List all Schemas using the 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_schemas_using_field	exec	field_id, X-EARLY-ACCESS	limit, offset, total	List all Schemas using the 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.
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

list_custom_fields_schemas_using_field

List all Schemas using the 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,
description,
self,
summary,
title,
type,
updated_at
FROM pagerduty.custom_fields.fields_schemas
WHERE field_id = '{{ field_id }}' -- required
AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required
AND limit = '{{ limit }}'
AND offset = '{{ offset }}'
AND total = '{{ total }}'
;

Lifecycle Methods

_list_custom_fields_schemas_using_field

List all Schemas using the 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.fields_schemas._list_custom_fields_schemas_using_field 
@field_id='{{ field_id }}' --required, 
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@total={{ total }}
;