JDBC Driver for Zendesk

Build 20.0.7587

Macros

Create, update, delete, and query Macros 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 Macros

SELECT * FROM Macros WHERE Id = '123'

SELECT * FROM Macros WHERE Active = true

SELECT * FROM Macros Order By CreatedAt

SELECT * FROM Macros Order By UpdateddAt

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 Title and Actions fields are required to insert. Allowed for agents.

INSERT INTO Macros(Title, Actions) VALUES('Roger Wilco II', '[{\"field\": \"status\", \"value": \"solved\"}]')

Update

You must specify the Id of the macro to update. Updating an action updates the containing array, clearing the other actions. Include all your actions when updating any action.Allowed for agents.

UPDATE Macros SET Title='Roger Wilco III' WHERE Id = '123'

Delete

You must specify the Id of the macro to delete it. Allowed for agents.

DELETE FROM Macros WHERE Id = '123'

Columns

Name Type ReadOnly Description
Id [KEY] Long True

Automatically assigned when created.

Title String False

The title of the macro.

Actions String False

An object describing what the macro will do.

Active Boolean False

Useful for determining if the macro should be displayed.Only active macros if true, inactive macros if false.

Description String False

The description of the macro.

Position Integer False

The position of the macro.

Restrictions String False

Who may access this macro. Will be null when everyone in the account can access it.

CreatedAt Datetime True

The time the macro was created.

UpdatedAt Datetime True

The time of the last update of the macro.

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
Access String

Only macros with given access. Possible values are personal, shared, or account.

Category String

Only macros within given category.

GroupId Integer

Only macros belonging to given group.

OnlyViewable Boolean

Only macros that can be applied to tickets if true, All macros the current user can manage if false. Defaults to false.

Attachments String

An array of macro attachment IDs to be associated with the macro, used in Insertion

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