CData Python Connector for Zendesk

Build 23.0.8839

ArticleComments

Create, Update, Delete and Query the Article Comments in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the connector.
SELECT * FROM ArticleComments WHERE UserId = '19128124956177'
SELECT * FROM ArticleComments WHERE ArticleId = '19206579478289'
SELECT * FROM ArticleComments WHERE ArticleId = '19206579478289' AND Locale = 'en-us'
SELECT * FROM ArticleComments WHERE ArticleId = '19206579478289' AND Id = '19244072685969'
SELECT * FROM ArticleComments WHERE ArticleId = '19206579478289' AND Id = '19244072685969' AND Locale = 'en-us'

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 Locale, ArticleId and Body fields are required to insert. Allowed for End users.

INSERT INTO ArticleComments (ArticleId, Locale, Body, NotifySubscribers) VALUES ('19206579478289', 'en-us', 'Sample Comment Body', false)

Update

You must specify the ArticleId and Id of the comment to update. Allowed for Agents and the end user who created the comment.

UPDATE ArticleComments SET Body = 'Updated Comment' WHERE ArticleId = '19206579478289' AND Id = '19268721555473'

Delete

You must specify the Id of the Comment and ArticleId to delete it. Allowed for Agents and the end user who created the comment.

DELETE FROM ArticleComments WHERE ArticleId = '19206579478289' AND Id = '19269079247633'

Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned when the comment is created.

AuthorId Long False

The id of the author of this comment. Writable on create by Help Center managers.

Body String False

The comment made by the author.

Locale String False

The locale in which this comment was made.

url String True

The API url of this comment.

HtmlUrl String True

The url at which the comment is presented in Help Center.

NonAuthorEditorId Long True

The user id of whoever performed the most recent (if any) non-author edit. A non-author edit consists of an edit make by a user other than the author that creates or updates the body or author_id. Note that only edits made after May 17, 2021 will be reflected in this field. If no non-author edits have occured since May 17, 2021, then this field will be null.

NonAuthorUpdatedAt Datetime True

When the comment was last edited by a non-author user.

SourceId Long True

The id of the item on which this comment was made.

SourceType String True

The type of the item on which this comment was made. Currently only supports 'Article'.

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.

CreatedAt Datetime False

The time the comment was created. Writable on create by Help Center managers.

UpdatedAt Datetime True

The time at which the comment was last updated.

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
ArticleId Long

The Id of the Article.

UserId Long

The Id of the User.

NotifySubscribers Boolean

Supplying a notify_subscribers property with a value of false will prevent subscribers to the comment's article from receiving a comment creation email notification. This can be helpful when creating many comments at a time.

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