Provides ticket form definitions used to structure and organize ticket fields for agents and end users.

Table-Specific Information

Select

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

SELECT * FROM TicketForms WHERE Id = '123'

SELECT * FROM TicketForms WHERE Id IN ('123', '456')

SELECT * FROM TicketForms WHERE Active = true

SELECT * FROM TicketForms WHERE EndUserVisible = true

SELECT * FROM TicketForms WHERE FallbackToDefault = true

SELECT * FROM TicketForms WHERE AssociatedToBrand = true

Insert

The Name column is required to insert. This operation is allowed for logged-in users with the "admin" role only.

INSERT INTO TicketForms (Name, EndUserVisible, DisplayName, Position, Active, Default) VALUES ('Snowboard Problem', true, 'Snowboard Damage' 2, true, false)

Update

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

UPDATE TicketForms SET Name = 'Snowboard Fixed', DisplayName = 'Snowboard has been fixed' WHERE Id = '123'

Delete

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

DELETE FROM TicketForms WHERE Id = '123'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		The Id of the ticket form.
Name	String	False		The name of the form.
RawName	String	False		The dynamic content placeholder, if present, or the 'name' value, if not.
DisplayName	String	False		The name of the form that is displayed to an end user.
RawDisplayName	String	False		The dynamic content placeholder, if present, or the 'display_name' value, if not.
Position	Integer	False		The position of this form among other forms in the account, i.e. dropdown.
Active	Boolean	False		Indicates whether the form is active.
EndUserVisible	Boolean	False		Indicates whether the form is visible to end users.
Default	Boolean	False		Indicates whether the form is the default form for this account.
TicketFieldIds	String	False		The Ids of all ticket fields included in this ticket form.
InAllBrands	Boolean	False		Indicates whether the form is available for use in all brands on this account.
RestrictedBrandIds	String	False		The Ids of all brands that this ticket form is restricted to.
FallbackToDefault	Boolean	False		Indicates whether the default ticket form is returned when the filter criteria result in a set with no active, end-user-visible ticket forms.
AssociatedToBrand	Boolean	False		Indicates whether only ticket forms associated with the current brand, as defined by the URL, are returned.
CreatedAt	Datetime	True		The time the ticket form was created.
UpdatedAt	Datetime	True		The time of the last update of the ticket form.
AgentConditions	String	False		The array of condition sets used to control field visibility in agent workspaces.
EndUserConditions	String	False		The array of condition sets used to control field visibility in end user products.
Url	String	True		The URL of the ticket form.