JDBC Driver for Zendesk

Build 24.0.8963

Articles

Create, Update, Archive and query Acticles in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the 本製品.
SELECT * FROM Articles
SELECT * FROM Articles WHERE Id = '18467349573905'

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 columns Locale, PermissionGroupId, Title, SectionId and UserSegmentId are required to insert. Allowed for agents.

INSERT INTO Articles(Locale, PermissionGroupId, Title, SectionId, UserSegmentId) VALUES('en-us', 18214159653905, 'The Title', 18214167902481, null)

Update

You must specify the Id of the Article to update it. It only update the article-level metadata such as its Promoted, Position, etc. It does not update translation properties such as the article's Title, Body, Locale, or Draft. Allowed for agents.

UPDATE Articles SET Promoted=true WHERE Id = '18460304837265'

Delete

You must specify the Id of the Article to archive it. You can restore the article using the Help Center user interface. Allowed for agents.

DELETE FROM Articles WHERE Id = 18467236423441

Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned when the article is created

AuthorId Long True

The id of the user who wrote the article (set to the user who made the request on create by default)

Body String False

HTML body of the article. Unsafe tags and attributes may be removed before display. For a list of safe tags and attributes, see Allowing unsafe HTML in Help Center articles in Zendesk help

CommentsDisabled Boolean False

True if comments are disabled; false otherwise

CreatedAt Datetime True

The time the article was created

Draft Boolean False

True if the translation for the current locale is a draft; false otherwise. false by default. Can be set when creating but not when updating. For updating, see Translations

EditedAt Datetime True

The time the article was last edited in its displayed locale

HtmlUrl String True

The url of the article in Help Center

LabelNames String False

An array of label names associated with this article. By default no label names are used. Only available on certain plans

Locale String False

The locale that the article is being displayed in

Outdated Boolean True

Deprecated. Always false because the source translation is always the most up-to-date translation

OutdatedLocales String True

Locales in which the article was marked as outdated

PermissionGroupId Long False

The id of the permission group which defines who can edit and publish this article

Position Integer False

The position of this article in the article list. 0 by default

Promoted Boolean False

True if this article is promoted; false otherwise. false by default

SectionId Long False

The id of the section to which this article belongs

SourceLocale String True

The source (default) locale of the article

Title String False

The title of the article

UpdatedAt Datetime True

The time the article was last updated

Url String True

The API url of the article

UserSegmentId Long False

The id of the user segment which defines who can see this article. Set to null to make it accessible to everyone

VoteCount Integer True

The total number of upvotes and downvotes

VoteSum Integer True

The sum of upvotes (+1) and downvotes (-1), which may be positive or negative

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
CategoryId Long

Id of the categories

UserId Long

Id of author

StartTime Datetime

Start Time

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.8963