Optional additionalA container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.
Optional categoryThe section in which the field appears: "what_happened" or "why_it_happened". When null, the field appears in the Attributes section.
Optional collectedThe lifecycle stage at which the app prompts users to fill out this field. Cannot be set on required fields.
Optional defaultThe default value for the field. Must be one of the valid values when valid_values is set.
Optional displayThe human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.
The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods.
Optional ordinalA decimal string representing the field's display order in the UI.
Optional requiredWhen true, users must fill out this field on incidents.
Optional tagFor metric tag-type fields only, the metric tag key that powers the autocomplete options.
The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.
Optional validThe list of allowed values for dropdown and multiselect fields. Limited to 1000 values.
Generated using TypeDoc
Attributes for creating an incident user-defined field.