CData Python Connector for Zendesk

Build 23.0.8839

Sections

Create, update, delete, and query Sections 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 Sections
SELECT * FROM Sections WHERE Id = '13647896255645'
SELECT * FROM Sections WHERE Locale = 'en-us'
SELECT * FROM Sections WHERE Locale = 'en-us' AND Id = '13647896255645'
SELECT * FROM Sections WHERE CategoryId = '13625283663133'
SELECT * FROM Sections WHERE Locale = 'en-us' AND CategoryId = '13625283663133'

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 and CategoryId columns are required to insert. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for Agents.

INSERT INTO Sections (Name, CategoryId) VALUES ('Test CData', '13626588262429')

Update

You must specify the Id of the Section to update. It updates the section-level data such as Name, Description, Position, CategoryId, ParentSectionId and ThemeTemplate. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for Help Center managers.

UPDATE Sections SET Name = 'UpdatedName' WHERE Id = '13647896255645'

Delete

You must specify the Id of the Section to delete it. Allowed for Help Center managers.

DELETE FROM Sections WHERE Id = '13647939064221'
DELETE FROM Sections WHERE Id = '13647939064221' AND Locale = 'en-us'

Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned when creating subscriptions.

CategoryId Long False

The id of the category to which this section belongs.

Name String False

The name of the section.

Description String False

The description of the section.

Locale String False

The locale in which the section is displayed.

ParentSectionId Long False

The id of the section to which this section belongs. Only writable for Guide Enterprise customers.

CreatedAt Datetime True

The time at which the section was created.

UpdatedAt Datetime True

The time at which the section was last updated.

Url String True

The API url of this section.

HtmlUrl String True

The url of this section in Help Center.

Outdated Boolean True

Whether the section is out of date.

Position Integer False

The position of this section in the section list. Used when sorting is set to manual. By default the section is added to the end of the list.

SourceLocale String True

The source (default) locale of the section.

ThemeTemplate String False

The theme template name used to display this section in Help Center.

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