Returns ticket fields, including field type, display, and configuration details.

Table-Specific Information

Select

The following query is processed server-side while other filters are processed client-side within the provider.

SELECT * FROM TicketFields WHERE Id = '123'

Insert

The Type and Title columns are required to insert. This operation is allowed for logged-in users with the "admin" role only.

INSERT INTO TicketFields (Type, Title) VALUES ('text', 'Age')

To insert a ticket field of type tagger (dropdown) or multiselect (dropdown), CustomFieldOptions is also required. This operation is allowed for logged-in users with the "admin" role only.

INSERT INTO TicketFields (Type, Title, CustomFieldOptions) VALUES ('tagger', 'TestDropdown', '[{\"name\": \"Apple Pie\", \"value\": \"apple\"}, {\"name\": \"Pecan Pie\", \"value\": \"pecan\"}]')

To insert a ticket field of type regexp, RegexpForValidation is also required. This operation is allowed for logged-in users with the "admin" role only.

INSERT INTO TicketFields (Type, Title, RegexpForValidation) VALUES ('regexp', 'TestRegExp', '\\b([0-9]{4})-(1[0-2]|0?[1-9])-(3[0-1]|[1-2][0-9]|0?[1-9])\\b')

Lookup Relationships

You can also create Lookup Relationships. A lookup relationship field is a custom field whose type is "lookup". This type of custom field gives you the ability to create a relationship from a source object to a target object.

To create a lookup relationship field, the Type and RelationshipTargetType columns are required. The Type column value must be "lookup". A suitable combination of Field, Operator, and Value is required for insertion in RelationshipFilterAll and RelationshipFilterAny. See a list of the possible combinations here.

INSERT INTO TicketFieldsRelationshipFilterAll#temp(Field, Operator, Value) VALUES ('role', 'is', 'Agent')
INSERT INTO TicketFieldsRelationshipFilterAny#temp(Field, Operator, Value) VALUES ('role', 'is', 'Agent')
INSERT INTO TicketFields (Type, Title, RelationshipTargetType, RelationshipFilterAll, RelationshipFilterAny) VALUES ('lookup', 'Lookup Relationships', 'zen:user', 'TicketFieldsRelationshipFilterAll#temp', 'TicketFieldsRelationshipFilterAny#temp')

Update

You must specify the Id of the ticket field to update. All fields that are not readonly are optional. This operation is allowed for logged-in users with the "admin" role only.

UPDATE TicketFields SET Title = 'Your age' WHERE Id = '123'

For a ticket field of type tagger (dropdown) or multiselect (dropdown), use the CustomFieldOptions column to update the options. For type regexp use RegexpForValidation to update the regular expression.

Delete

You must specify the Id of the ticket field to delete it. This operation is allowed for logged-in users with the "admin" role only.

DELETE FROM TicketFields WHERE Id = '123'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the ticket field 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		Indicates whether this field is available.
Required	Boolean	False		Indicates whether this field is required to be filled in by agents.
CollapsedForAgents	Boolean	False		Indicates whether this field is shown to agents by default or 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		Indicates whether this field is available to end users.
EditableInPortal	Boolean	False		Indicates 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		Indicates whether 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.
AgentDescription	String	False		A description of the ticket field that only agents can see.
CustomStatuses	String	True		List of customized ticket statuses. Only presented for a system ticket field of type custom_status.
RelationshipFilterAll	String	False		A filter definition that allows your autocomplete to filter down results with Logical AND.
RelationshipFilterAny	String	False		A filter definition that allows your autocomplete to filter down results with Logical OR.
RelationshipTargetType	String	False		A representation of what type of object the field references. Options are zen:user, zen:organization, zen:ticket, or zen:custom_object:CUSTOM_OBJECT_KEY. For example zen:custom_object:apartment.
RequiredInPortal	String	False		Indicates whether end users must enter a value in the field to create the request.
SubTypeId	String	False		For system ticket fields of type priority and status. Defaults to 0. A priority sub type of 1 removes the Low and Urgent options. A status sub type of 1 adds the On-Hold option.