schema_assignments

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

Overview

Name	schema_assignments
Type	Resource
Id	pagerduty.custom_fields.schema_assignments

Fields

The following fields are returned by SELECT queries:

list_schema_assignments

The list of Assignments

Name	Datatype	Description
id	string	The ID of the resource.
created_at	string (date-time)	The date/time the object was created at.
schema	object
service	object
type	string	A string that determines the schema of the object. This must be the standard name for the entity, suffixed by _reference if the object is a reference.
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_schema_assignments	select	filter, X-EARLY-ACCESS	limit, offset, total	List Schema Assignments by service_id or schema_id <!-- 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_schema_assignment	insert	X-EARLY-ACCESS, data__schema_assignment		Assign a new Schema to a service <!-- 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_schema_assignment	delete	id, X-EARLY-ACCESS		Remove the Schema assigned to a service <!-- 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_schema_assignments	exec	filter, X-EARLY-ACCESS	limit, offset, total	List Schema Assignments by service_id or schema_id <!-- 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!
filter	object	One of service_id or schema_id is required.
id	string	The ID of the resource.
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_schema_assignments

List Schema Assignments by service_id or schema_id

<!-- 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,
schema,
service,
type,
updated_at
FROM pagerduty.custom_fields.schema_assignments
WHERE filter = '{{ filter }}' -- required
AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required
AND limit = '{{ limit }}'
AND offset = '{{ offset }}'
AND total = '{{ total }}'
;

INSERT examples

create_custom_fields_schema_assignment

Assign a new Schema to a service

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

Manifest

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

DELETE examples

delete_schema_assignment

Remove the Schema assigned to a service

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

Lifecycle Methods

_list_schema_assignments

List Schema Assignments by service_id or schema_id

<!-- 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.schema_assignments._list_schema_assignments 
@filter='{{ filter }}' --required, 
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@total={{ total }}
;