CData Python Connector for Zendesk

Build 23.0.8839

Translations

Create, Update, Delete and Query the Translations in Zendesk.

Table Specific Information

Select

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

Lists all translations for a given article, section, or category.

SELECT * FROM Translations WHERE ArticleId = '19206609899793'
SELECT * FROM Translations WHERE ArticleId = '19206609899793' AND Locale = 'en-us'
SELECT * FROM Translations WHERE SectionId = '19206579484689'
SELECT * FROM Translations WHERE SectionId = '19206609899793' AND Locale = 'en-us'
SELECT * FROM Translations WHERE CategoryId = '19206609899793'
SELECT * FROM Translations WHERE CategoryId = '19206609899793' 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

To create a translation for a given source i.e. article, section, or category, the affiliated id of the source, Locale and Title fields are required. Any locale that you specify must be enabled for the current Help Center. The locale must also be different from that of any existing translation associated with the source object. Allowed for Help Center Managers and Agents(article translations only)

INSERT INTO Translations (ArticleId, Locale, Title) VALUES (19206609899793, 'hr', 'Article Transalation')

INSERT INTO Translations (SectionId, Locale, Title) VALUES (19206579484689, 'hr', 'Section Transalation')

INSERT INTO Translations (CategoryId, Locale, Title) VALUES (19206609883537, 'hr', 'Category Transalation')

Update

You must specify the affiliated id of the source and Locale for update. Allowed for Agents (only articles).

UPDATE Translations SET Title = 'Updated Article Translation' WHERE ArticleId = '19206609899793' AND Locale = 'hr'

UPDATE Translations SET Title = 'Section_Title_Updated' WHERE SectionId = '19206579484689' AND Locale = 'hr'

UPDATE Translations SET Title = 'Categoris Title' WHERE CategoryId = '19206609883537' AND Locale = 'hr'

Delete

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

DELETE FROM Translations WHERE Id = '19207534349457'

Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned when a translation is created.

CreatedById Long True

The id of the user who created the translation.

UpdatedById Long True

The id of the user who last updated the translation.

SourceId Long True

The id of the item that has this translation.

Title String False

The title of the translation.

Body String False

HTML body of the translation. Empty by default.

Draft Boolean False

True if the translation is a draft; false otherwise. False by default.

HtmlUrl String True

The url of the translation in Help Center.

Locale String False

The locale of the translation.

Outdated Boolean False

True if the translation is outdated; false otherwise. False by default.

SourceType String True

The type of the item that has this translation. Can be article, section, or category.

Url String True

The API url of the translation.

CreatedAt Datetime True

The time at which the translation was created.

UpdatedAt Datetime True

The time at which the translation 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

Id of the associated article.

SectionId Long

Id of the associated section.

CategoryId Long

Id of the associated category.

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