Class IncidentUserDefinedFieldAttributesResponse

Attributes of an incident user-defined field.

Hierarchy

  • IncidentUserDefinedFieldAttributesResponse

Constructors

Properties

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
attachedTo: string

The resource type this field is attached to. Always "incidents".

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

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

created: Date

Timestamp when the field was created.

defaultValue: null | string

The default value for the field.

deleted: null | Date

Timestamp when the field was soft-deleted, or null if not deleted.

displayName: string

The human-readable name shown in the UI.

Metadata for autocomplete-type user-defined fields, describing how to populate autocomplete options.

modified: null | Date

Timestamp when the field was last modified.

name: string

The unique identifier of the field.

ordinal: null | string

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

prerequisite: null | string

Reserved for future use. Always null.

required: boolean

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

reserved: boolean

When true, this field is reserved for system use and cannot be deleted.

tableId: number

Reserved for internal use. Always 0.

tagKey: null | string

For metric tag-type fields only, the metric tag key that powers the autocomplete options.

type: null | number

The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.

The list of allowed values for dropdown, multiselect, and autocomplete fields.

Generated using TypeDoc