Class IncidentUserDefinedFieldAttributesUpdateRequest

Attributes for updating an incident user-defined field. All fields are optional.

Hierarchy

  • IncidentUserDefinedFieldAttributesUpdateRequest

Constructors

constructor

Properties

additionalProperties? category? collected? defaultValue? displayName? ordinal? required? validValues?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional category

category?: IncidentUserDefinedFieldCategory

The section in which the field appears: "what_happened" or "why_it_happened". When null, the field appears in the Attributes section.

Optional collected

collected?: IncidentUserDefinedFieldCollected

The lifecycle stage at which the app prompts users to fill out this field. Cannot be set on required fields.

Optional defaultValue

defaultValue?: string

The default value for the field. Must be one of the valid values when valid_values is set.

Optional displayName

displayName?: string

The human-readable name shown in the UI.

Optional ordinal

ordinal?: string

A decimal string representing the field's display order in the UI.

Optional required

required?: boolean

When true, users must fill out this field on incidents.

Optional validValues

validValues?: IncidentUserDefinedFieldValidValue[]

The list of allowed values for dropdown and multiselect fields. Limited to 1000 values.

Settings

Member Visibility

Theme

Generated using TypeDoc