Skip to main content

schemas

Overview

Nameschemas
TypeResource
Idpagerduty.custom_fields.schemas

Fields

NameDatatypeDescription
idstringThe ID of the resource.
descriptionstringA description of this schema.
created_atstringThe date/time the object was created at.
field_configurationsarray
selfstringThe API show URL at which the object is accessible
summarystringA 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.
titlestringThe name of the schema.
typestring
updated_atstringThe date/time the object was last updated.

Methods

NameAccessible byRequired ParamsDescription
get_custom_fields_schemaSELECTX-EARLY-ACCESS, schema_idGet detailed information about 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_schemasSELECTX-EARLY-ACCESSList all Schemas.

<!-- 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_schemaINSERTX-EARLY-ACCESS, data__schemaCreate a new Schema, along with the Field Configurations if provided. An account may have up to 100 Schemas.

<!-- 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_schemaDELETEX-EARLY-ACCESS, schema_idDelete a Schema. Schemas may not be deleted if they are in use by any 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.
_get_custom_fields_schemaEXECX-EARLY-ACCESS, schema_idGet detailed information about 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_schemasEXECX-EARLY-ACCESSList all Schemas.

<!-- 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_schemaEXECX-EARLY-ACCESS, schema_id, data__schemaUpdate a Schema, along with the Field Configurations if provided.

<!-- 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.