JDBC Driver for Zendesk

Build 20.0.7587

TicketForms

Create, update, delete, and query Ticket Forms in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM TicketForms

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

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Name field is required to insert. Allowed for admins.

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 (readonly="false" in the table) are optional. Allowed for admins.

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. Allowed for admins.

DELETE FROM TicketForms WHERE Id='123'

Columns

Name Type ReadOnly Description
Id [KEY] Long True

Ticket form id.

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

If the form is set as active.

EndUserVisible Boolean False

Is the form visible to the end user.

Default Boolean False

Is the form the default form for this account.

TicketFieldIds String False

Ids of all ticket fields which are in this ticket form.

InAllBrands Boolean False

Is the form available for use in all brands on this account.

RestrictedBrandIds String False

Ids of all brands that this ticket form is restricted to.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
FallbackToDefault Boolean

If true, returns default ticket form when the criteria defined by the parameters results in a set without active and end user visible ticket forms.

AssociatedToBrand Boolean

Only ticket forms of current brand (defined by url) if true.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587