field_configurations
Overview
| Name | field_configurations |
| Type | Resource |
| Id | pagerduty.custom_fields.field_configurations |
Fields
| Name | Datatype | Description |
|---|---|---|
id | string | The ID of the resource. |
_type | string | |
created_at | string | 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 | 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 | The date/time the object was last updated. |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
get_custom_fields_field_configuration | SELECT | X-EARLY-ACCESS, field_configuration_id, schema_id | 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 | X-EARLY-ACCESS, schema_id | 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 | X-EARLY-ACCESS, schema_id, 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 | X-EARLY-ACCESS, field_configuration_id, schema_id | 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. |
_get_custom_fields_field_configuration | EXEC | X-EARLY-ACCESS, field_configuration_id, schema_id | 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 | EXEC | X-EARLY-ACCESS, schema_id | 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. |
update_custom_fields_field_configuration | EXEC | X-EARLY-ACCESS, field_configuration_id, schema_id, data__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. |