TicketFields

Columns

Name

Type

ReadOnly

References

Description

Id [KEY]

Long

True

Automatically assigned when the ticket is created.

Type

String

False

The type of the ticket field: checkbox, date, decimal, integer, regexp, tagger, text, or textarea. Type is not editable once created.

Title

String

False

The title of the ticket field.

RawTitle

String

False

The dynamic content placeholder, if present, or the 'title' value, if not.

Description

String

False

The description of the purpose of this ticket field, shown to users.

RawDescription

String

False

The dynamic content placeholder, if present, or the 'description' value, if not.

Position

Integer

False

A relative position for the ticket fields that determines the order of ticket fields on a ticket. Note that positions 0 to 7 are reserved for system fields.

Active

Boolean

False

Whether this field is available.

Required

Boolean

False

Whether this field is available.

CollapsedForAgents

Boolean

False

If this field should be shown to agents by default or be hidden alongside infrequently used fields. Classic interface only.

RegexpForValidation

String

False

Regular expression field only. The validation pattern for a field value to be deemed valid.

TitleInPortal

String

False

The title of the ticket field when shown to end users.

RawTitleInPortal

String

False

The dynamic content placeholder, if present, or the 'title_in_portal' value, if not.

VisibleInPortal

Boolean

False

Whether this field is available to end users.

EditableInPortal

Boolean

False

Whether this field is editable by end users.

Tag

String

False

A tag value to set for checkbox fields when checked.

CreatedAt

Datetime

True

The time the ticket field was created.

UpdatedAt

Datetime

True

The time of the last update of the ticket field.

SystemFieldOptions

String

True

Presented for a ticket field of type 'tickettype', 'priority' or 'status'.

CustomFieldOptions

String

False

Required and presented for a ticket field of type 'tagger'.

Removable

Boolean

True

If this field is not a system basic field that must be present for all tickets on the account.

Url

String

True

The URL for this resource.

Last updated