接続の確立

Zendesk への接続を追加

Zendesk への接続を追加するには：

アプリケーションコンソールで、接続ページに移動します。
接続の追加パネルで、追加したい接続のアイコンを選択します。
Zendesk アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからZendesk コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

Zendesk への接続

Zendesk に接続するには、https://{subdomain}.zendesk.com の形式でURL（Zendesk Support URL）を設定します。接続後、次のセクションの説明に従ってユーザー認証を行います。

また、TicketMetrics テーブルのアーカイブデータを扱うユーザーは、UseIncrementalAPI プロパティをTrue に設定する必要があります。

Zendesk への認証

Zendesk は、Zendesk インスタンスの設定に応じて、3種類の認証をサポートします。

API トークン認証

API トークン認証を使用する場合は、E メールアドレスとApiToken を指定します。 AuthScheme をAPIToken に、User をE メールアドレスに設定し、Zendesk Support の管理画面で以下の設定を行います。

Token アクセスを有効にします。
Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。

最後に、ApiToken をアクティブなAPI トークンに設定します。

OAuth 認証

Zendesk はネットワーク経由で共有データにアクセスするすべてのインスタンスでOAuth 認証に対応しています。これは、Web、デスクトップ、ヘッドレスサーバーのいずれから認証する場合でも、 AuthScheme をOAuth に設定してカスタムOAuth アプリケーションを作成する必要があることを意味します。

以下のサブセクションでは、3つの一般的な認証フローでのZendesk への認証について詳しく説明します。

デスクトップ：ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。
Web：共有ウェブサイト経由でデータにアクセスします。
ヘッドレスサーバー：他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。

カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成を参照してください。 Zendesk で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

OAuth アクセストークンの自動リフレッシュ：

Sync App がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。

はじめてデータに接続する前に、次の接続プロパティを設定します。
- InitiateOAuth = REFRESH。
- OAuthClientId = アプリケーション設定のクライアントId。
- OAuthClientSecret = アプリケーション設定のクライアントシークレット。
- OAuthAccessToken = GetOAuthAccessToken によって返されたアクセストークン。
- OAuthSettingsLocation = Sync App がOAuth 値を保存する場所のパス。これは接続間で維持されます。
その後のデータ接続では、以下を設定します。
- InitiateOAuth
- OAuthSettingsLocation

Basic 認証（レガシー）

Basic 認証はZendesk で廃止されましたが、一部のアカウントではまだ利用できる場合があります。Basic 認証を使用する場合は、E メールアドレスとPassword を指定します。 AuthScheme をBasic に、User をE メールアドレスに、Password をパスワードに設定します。

高度な設定

SSL コンフィギュレーションのカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL/TLS のネゴシエーションを試みます。別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows システムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらに、HTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

次のプロパティを設定します。

プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
接続をトンネルするには、FirewallType をTUNNEL に設定します。
認証するには、FirewallUser とFirewallPassword を設定します。
SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

高度な機能

このセクションでは、Zendesk Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。カスタムビューの作成と設定の概要については、ユーザー定義ビューを参照してください。

SSL の設定

SSL の設定を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシに合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、Zendesk にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくは、クエリ処理を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログを参照してください。基本的なロギングに必要なのは2つの接続プロパティだけですが、より詳細なロギングをサポートする多くの機能があり、LogModules 接続プロパティを使用してロギングする情報のサブセットを指定することができます。

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort：プロキシサーバーが起動しているTCP ポート。
ProxyAuthScheme：プロキシサーバーに対して認証する際にSync App が使用する認証方法。
ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
接続をトンネルするには、FirewallType をTUNNEL に設定します。
認証するには、FirewallUser とFirewallPassword を設定します。
SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

データモデル

CData Sync App は、Zendesk API のエンティティをテーブル、ビュー、およびストアドプロシージャにモデル化します。Tickets スキーマは、カスタムフィールドの変更を動的に反映します。その他のエンティティは、簡単なテキストベースのコンフィギュレーションファイルであるスキーマファイルにて定義されます。

クエリ処理の使用

Sync App は、Zendesk API にできるだけ多くのSELECT 構文処理をオフロードし、残りのクエリをSync App 内で処理します。次のセクションでは、API の制限と要件を説明します。

ストアドプロシージャ

ストアドプロシージャは、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。

テーブル

Sync App はZendesk のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

Zendesk Connector for CData Sync テーブル


Name	Description
AccountSettings	Query and update Account Settings in Zendesk.
ArticleAttachments	Query and Delete Acticle Attachment in Zendesk.
ArticleComments	Create, Update, Delete and Query the Article Comments in Zendesk.
ArticleLabels	Create, delete, and query Article Labels in Zendesk.
Articles	Create, Update, Archive and query Acticles in Zendesk.
ArticleTranslations	Create, Update, Delete and Query the Translations for Articles in Zendesk.
Attributes	Create, Update, Delete and Query the Attributes in Zendesk. An attribute in Zendesk refers to a skill type. Skill types are categories of skills.
AttributeValues	Create, Update, Delete and Query the Attribute Values in Zendesk. An attribute value in this API refers to a skill. Skills are associated with an agent and determine the agent's suitability to solve a ticket.
Automations	Create, update, delete, and query Automations in Zendesk.
Bookmarks	Create, Delete and Query the Bookmarks in Zendesk.
Brands	Create, delete, update, and query Brands in Zendesk.
Categories	Create, update, delete, and query Categories in Zendesk.
CategoryTranslations	Create, Update, Delete and Query the Translations for Categories in Zendesk.
ContentSubscriptions	Create, Update, Delete and Query the Content Subscriptions in Zendesk. Users can subscribe to sections, articles, community posts, and community topics.
ContentTags	Create, Update, Delete and Query the Content Tags in Zendesk.
CustomAgentRoles	Create, Update, Delete and Query CustomAgentRoles in Zendesk.
CustomObjects	Create, delete, update, and query Custom Objects in Zendesk.
CustomTicketStatuses	Create, update, and query custom ticket statuses in zendesk.
GroupMemberships	Create, delete, and query Group Memberships in Zendesk.
Groups	Create, update, delete, and query Groups in Zendesk.
GroupSlaPolicies	Create, Update, Delete and Query Group SLA Policies in Zendesk.
Holidays	Create, update, delete, and query Schedules in Zendesk.
JiraLinks	View and create links between your Jira and Zendesk instances.
Macros	Create, update, delete, and query Macros in Zendesk.
ManagementPermissionGroups	Create, Update, Delete and Query the Management Permission Groups in Zendesk. A management permission group defines which agents can create, update, archive, and publish articles. It consists of a set of privileges, each of which is mapped to a user segment. Agents receive whichever privileges are associated with the user segments they belong to.
OrganizationFields	Create, update, delete, and query Organization Fields in Zendesk.
OrganizationMemberships	Create, delete, and query Organization Memberships in Zendesk.
Organizations	Create, delete, update, and query Organizations in Zendesk.
OrganizationSubscriptions	Create, delete, and query Organization Subscriptions in Zendesk.
PostComments	Query, Insert, Update and Delete PostComments in Zendesk.
Posts	Query, Insert, Update and Delete Posts in Zendesk.
SatisfactionRatings	Create and query Requests in Zendesk.
Schedules	Create, update, delete and query Schedules in Zendesk.
Sections	Create, update, delete, and query Sections in Zendesk.
SectionTranslations	Create, Update, Delete and Query the Translations for Sections in Zendesk.
Sessions	Query and delete Sessions in Zendesk.
SharingAgreements	Create, update, delete, and query SharingAgreements in Zendesk.
SideConversations	Create, update and query Side Conversations in Zendesk.
SlaPolicies	Create, update, delete, and query SlaPolicies in Zendesk.
SupportAddresses	Create, update, delete, and query Support Addresses in Zendesk.
SuspendedTickets	Query and delete Suspended Tickets in Zendesk.
Targets	Create, Update, Delete and Query Targets in Zendesk.
TicketAudits	Query TicketAudits in Zendesk.
TicketComments	Query TicketComments belonging to a specified ticket in Zendesk.
TicketEvents	Query TicketEvents in Zendesk.
TicketFields	Create, update, delete, and query TicketFields in Zendesk.
TicketForms	Create, update, delete, and query Ticket Forms in Zendesk.
TicketMetricEvents	Queries TicketMetricEvents in Zendesk.
TicketMetrics	Query TicketMetrics in Zendesk.
Tickets	Create, update, delete, and query Tickets.
TicketSkips	Create and Query the TicketSkips in Zendesk. A skip is a record of when an agent skips over a ticket without responding to the end user. Skips are typically recorded while a play-only agent is in Guided mode.
Tickets_Collaborators	The Collaborator id of users currently CC'ed on the ticket.
Tickets_Followers	The ids of agents currently following the ticket.
Tickets_Followups	The ids of the followups created from ticket.
Tickets_Macros	List of macros to be recorded in the ticket audit.
Tickets_SatisfactionRatings	The satisfaction rating of the ticket, if it exists, or the state of satisfaction.
Tickets_SharingAgreements	The sharing agreements used for ticket.
Tickets_Tags	The tags applied to the ticket.
Tickets_Viasources	List ViaSources for the Ticket.
Topics	Query, Insert, Update and Delete Topics in Zendesk.
Translations	Create, Update, Delete and Query the Translations in Zendesk. This table is deprecated, and is being replaced by the ArticleTranslations, CategoryTranslations, and SectionTranslations tables.
TriggerCategories	Create, update, delete, and query Trigger Categories in Zendesk.
Triggers	Create, update, delete, and query Triggers in Zendesk.
UserFields	Create, update, delete, and query User Fields.
UserIdentities	Create, update, delete, and query User Identities.
Users	Create, update, delete, and query Users in Zendesk.
UserSegments	Create, Update, Delete and Query the User Segments in Zendesk. A user segment defines who can view the content of a section or topic.
Views	Create, update, delete and query views in Zendesk.
Votes	Create, Delete and Query the Votes in Zendesk. Votes represents positive and negative opinions of users about articles, article comments, posts or post comments.

AccountSettings

Query and update Account Settings in Zendesk.

Table Specific Information

Select

The Sync App executes all filters on this table client side.

Update

All fields that are not readonly (readonly="false" in the table) can be updated. Allowed for admins. For example:

UPDATE AccountSettings SET ActiveFeaturesCustomerSatisfaction = true

Columns


Name	Type	ReadOnly	References	Description
BrandingHeaderColor	String	False		HEX of the header color.
BrandingPageBackgroundColor	String	True		HEX of the page background color.
BrandingTabBackgroundColor	String	True		HEX of tab background color.
BrandingTextColor	String	True		HEX of the text color, usually matched to contrast well with header_color.
BrandingHeaderLogoUrl	String	True		The URL for the custom header logo.
BrandingFaviconUrl	String	True		The URL for the custom favicon.
AppsUse	Boolean	True		The account can use apps.
AppsCreatePrivate	Boolean	True		The account can create private apps.
TicketsCommentsPublicByDefault	Boolean	True		Comments from agents are public by default.
TicketsIsFirstCommentPrivateEnabled	Boolean	True		Allow first comment on tickets to be private.
TicketsListNewestCommentsFirst	Boolean	True		When viewing a ticket, show the newest comments and events first.
TicketsCollaboration	Boolean	True		CCs may be added to a ticket.
TicketsPrivateAttachments	Boolean	True		Users must login to access attachments.
TicketsEmailAttachments	Boolean	True		Attachments should be sent as real attachments when under the size limit.
TicketsAgentCollision	Boolean	True		Clients should provide an indicator when a ticket is being viewed by another agent.
TicketsMaximumPersonalViewsToList	Integer	True		Maximum number of personal Views clients should display in menus.
TicketsTagging	Boolean	True		Tickets may be tagged.
TicketsMarkdownTicketComments	Boolean	True		Whether agent comments should be processed with Markdown.
TicketsEmojiAutocompletion	Boolean	True		Whether agent comments should allow for Emoji rendering.
TicketsAgentTicketDeletion	Boolean	False		Whether agents can delete tickets.
ChatEnabled	Boolean	True		Chat is enabled.
ChatMaximumRequests	Integer	True		The maximum number of chat requests an agent may handle at one time.
ChatWelcomeMessage	String	True		The message automatically sent to end-users when they begin chatting with an agent.
TwitterShortenUrl	String	True		Possible values: always, optional, never.
GSuiteHasGoogleApps	Boolean	True		Whether has google apps.
GSuiteHasGoogleAppsAdmin	Boolean	False		Account has at least one G Suite admin.
VoiceEnabled	Boolean	True		Whether Voice is enabled.
VoiceMaintenance	Boolean	True		.
VoiceLogging	Boolean	True		.
VoiceOutboundEnabled	Boolean	True		.
VoiceAgentConfirmationWhenForwarding	Boolean	True		.
VoiceAgentWrapUpAfterCalls	Boolean	True		.
VoiceMaximumQueueSize	Integer	True		.
VoiceMaximumQueueWaitTime	Integer	True		.
VoiceOnlyDuringBusinessHours	Boolean	True		.
VoiceRecordingsPublic	Boolean	True		.
VocieUkMobileForwarding	Boolean	True		.
UsersTagging	Boolean	True		Users may be tagged.
UsersTimeZoneSelection	Boolean	True		Whether user can view time zone for profile.
UsersLanguageSelection	Boolean	True		Whether to display language drop down for a user.
UsersAgentCreatedWelcomeEmails	Boolean	True		Whether a user created by an agent receives a welcome email.
UsersEndUserPhoneNumberValidation	Boolean	False		Whether a user's phone number is validated.
GooddataAdvancedAnalytics_Enabled	Boolean	True		GoodData Advanced Analytics is enabled.
BrandsDefaultBrandId	Long	False		The id of the brand that is assigned to tickets by default.
BrandsRequireBrandOnNewTickets	Boolean	True		Require agents to select a brand before saving tickets.
StatisticsForum	Boolean	True		Allow users to view forum statistics.
StatisticsSearch	Boolean	True		Allow users to view search statistics.
BillingBackend	String	True		Backend Billing system either internal or zuora.
ActiveFeaturesOnHoldStatus	Boolean	True		Account can use status hold.
ActiveFeaturesUserTagging	Boolean	True		Enable user tags.
ActiveFeaturesTicketTagging	Boolean	True		Allow tagging tickets.
ActiveFeaturesTopicSuggestion	Boolean	True		Allow topic suggestions in tickets.
ActiveFeaturesVoice	Boolean	True		Voice support.
ActiveFeaturesFacebookLogin	Boolean	True		Facebook login.
ActiveFeaturesGoogleLogin	Boolean	True		Google login.
ActiveFeaturesTwitterLogin	Boolean	True		Twitter login.
ActiveFeaturesForumAnalytics	Boolean	True		Forum and search analytics.
ActiveFeaturesBusinessHours	Boolean	False		Business hours.
ActiveFeaturesAgentForwarding	Boolean	True		Agent forwarding.
ActiveFeaturesChat	Boolean	True		Chat.
ActiveFeaturesChatAboutMyTicket	Boolean	True		Chat about my ticket.
ActiveFeaturesCustomerSatisfaction	Boolean	False		Customer satisfaction.
ActiveFeaturesSatisfactionPrediction	Boolean	False		Satisfaction Prediction.
ActiveFeaturesCsatReasonCode	Boolean	True		Csat reason code.
ActiveFeaturesScreencasts	Boolean	True		.
ActiveFeaturesMarkdown	Boolean	True		Markdown in ticket comments.
ActiveFeaturesLanguageDetection	Boolean	True		Language detection.
ActiveFeaturesBccArchiving	Boolean	True		Account has a bcc_archive_address set.
ActiveFeaturesAllowCcs	Boolean	True		Allow ccs.
ActiveFeaturesAdvancedAnalytics	Boolean	True		Advanced analytics.
ActiveFeaturesInsights	Boolean	True		Insights.
ActiveFeaturesSandbox	Boolean	True		Account has a sandbox.
ActiveFeaturesSuspendedTicketNotification	Boolean	True		Suspended ticket notification.
ActiveFeaturesTwitter	Boolean	True		Account monitors at least one Twitter handle.
ActiveFeaturesFacebook	Boolean	True		Account is actively linked to at least one Facebook page.
ActiveFeaturesFeedbackTabs	Boolean	True		Feedback tab has been configured before.
ActiveFeaturesDynamicContents	Boolean	True		Account has at least one dynamic content.
ActiveFeaturesLightAgents	Boolean	True		Account has at least one light agent.
ActiveFeaturesTicketForms	Boolean	True		Ticket forms.
ActiveFeaturesUserOrgFields	Boolean	True		User org fields.
ActiveFeaturesIsAbusive	Boolean	True		Account exceeded trial limits.
ActiveFeaturesRichContentInEmails	Boolean	True		Account supports incoming HTML email.
ApiAcceptedApiAgreement	Boolean	False		Account has accepted the API agreement.
ApiPasswordAccess	Boolean	False		Allow the account to use the API with username/password.
ApiTokenAccess	Boolean	False		Allow the account to use the API with API tokens.
TicketFormsInstructions	String	False		.
RawTicketFormsInstructions	String	True		.
LotusPrefer	Boolean	True		Prefers the current version of Zendesk Support rather than Zendesk Classic.
RulesMacroMostUsed	Boolean	False		Display the most-used macros in the Apply macro list. Defaults to true.
RulesMacroOrder	String	False		Default macro display order. Possible values are alphabetical or position.
LimitsAttachmentSize	Integer	True		The maximum ticket attachment file size (in bytes).
MetricsAccountSize	String	True		An account size category computed from the number of billable agents.

ArticleAttachments

Query and Delete Acticle Attachment in Zendesk.

Table Specific Information

Select

The following queries are processed server-side while other filters are processed client-side by the Sync App. Allowed for Agents and End users, as long as they can view the associated article.

SELECT * FROM ArticleAttachments WHERE ArticleId = '18214155815057'
SELECT * FROM ArticleAttachments WHERE Id = '18470148791057'
SELECT * FROM ArticleAttachments WHERE Id = '18470148791057' AND Locale='en-us' AND ArticleId = '18214155815057'

Delete

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

DELETE FROM ArticleAttachments WHERE Id = '18460736594833'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Assigned ID when the article attachment is created.
ArticleId	Long	True	Articles.Id	The associated article, if present.
ContentType	String	True		The file type. Example: image/png.
ContentUrl	String	True		URL where the attachment file can be downloaded.
CreatedAt	Datetime	True		The time the article attachment was created.
DisplayFileName	String	True		display_file_name.
FileName	String	True		The file name.
Inline	Boolean	True		The attached file is shown in the admin interface for inline attachments. Its URL can be referenced in the article's HTML body. Inline attachments are image files directly embedded in the article body. If false, the attachment is listed in the list of attachments. The default value is false.
RelativePath	String	True		relative_path.
Size	Integer	True		The attachment file size in bytes.
UpdatedAt	Datetime	True		The time the article attachment was last updated.
Url	String	True		The URL of the article attachment.
AttachmentsResponse	String	True		Content of the attachments.

Pseudo-Columns

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


Name	Type	Description
Locale	String	The locale that the article attachments is being displayed in.
IsInline	Boolean	Boolean value that represents Article is inline or not.
Base64EncodedResponse	Boolean	Raw response gets converted into base64encoded. デフォルト値はtrueです。

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 Sync App.

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'

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

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


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.

ArticleLabels

Create, delete, and query Article Labels in Zendesk.

Table Specific Information

Select

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

SELECT * FROM ArticleLabels WHERE Id = '10552059820828'
SELECT * FROM ArticleLabels WHERE ArticleId = '10480909113756'
SELECT * FROM ArticleLabels WHERE ArticleId = '10480909113756' AND Locale = 'en-us'

Insert

The ArticleId and Name columns are required to insert. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for Agents.

INSERT INTO ArticleLabels (ArticleId, Name) VALUES (10480909113756, 'Test')

Delete

You must specify the Id of the ArticleLabel to delete it. Allowed for Agents.

DELETE FROM ArticleLabels WHERE Id = '10552125680668'
DELETE FROM ArticleLabels WHERE Id = '13647939064221' AND ArticleId = '10480909113756'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the label is created.
Name	String	False		The actual name of the label.
CreatedAt	Datetime	True		The time at which the label was created.
UpdatedAt	Datetime	True		The time at which the label was last updated.
Url	String	True		The API url of this label.

Pseudo-Columns

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


Name	Type	Description
ArticleId	Long	The unique ID of the article.
Locale	String	The locale the item is displayed in.

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 Sync App.

SELECT * FROM Articles
SELECT * FROM Articles WHERE Id = '18467349573905'

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.

ArticleTranslations

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

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.
ArticleId	Long	False	Articles.Id	Id of the associated article.

Attributes

Create, Update, Delete and Query the Attributes in Zendesk. An attribute in Zendesk refers to a skill type. Skill types are categories of skills.

Table Specific Information

Select

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

SELECT * FROM Attributes WHERE Id = 'd5e889c8-6364-11ee-8493-6361d728a3c9'

Insert

The Name field is required to insert. Allowed for agents.

INSERT INTO Attributes (Name) VALUES ('Test')

Update

You must specify the Id of the Attribute to update. Allowed for admins.

UPDATE Attributes SET Name = 'CData' WHERE Id = 'd5e889c8-6364-11ee-8493-6361d728a3c9'

Delete

You must specify the Id of the Attribute to delete it. Allowed for admins.

DELETE FROM Attributes WHERE Id = 'db70666a-6364-11ee-bfc8-7f3b952deb2c'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Automatically assigned when an attribute is created.
Name	String	False		The name of the attribute.
url	String	True		URL of the attribute.
CreatedAt	Datetime	True		When this record was created.
UpdatedAt	Datetime	True		When this record was last updated.

AttributeValues

Create, Update, Delete and Query the Attribute Values in Zendesk. An attribute value in this API refers to a skill. Skills are associated with an agent and determine the agent's suitability to solve a ticket.

Table Specific Information

Select

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

SELECT * FROM AttributeValues WHERE AttributeId = 'd5e889c8-6364-11ee-8493-6361d728a3c9'
SELECT * FROM AttributeValues WHERE AttributeId = 'd5e889c8-6364-11ee-8493-6361d728a3c9' AND Id = '5943809a-6f5d-4f6e-8669-e8a65bd3583b'

Insert

The AttributeId and Name fields are required to insert. Allowed for admins.

INSERT INTO AttributeValues (AttributeId, Name) VALUES ('d5e889c8-6364-11ee-8493-6361d728a3c9', 'TestValue')

Update

You must specify the AttributeId and Id of the AttributeValue to update. Allowed for admins.

UPDATE AttributeValues SET Name = 'CData' WHERE AttributeId = 'd5e889c8-6364-11ee-8493-6361d728a3c9' AND Id = '5943809a-6f5d-4f6e-8669-e8a65bd3583b'

Delete

You must specify the AttributeId and Id of the AttributeValue to delete it. Allowed for agents.

DELETE FROM AttributeValues WHERE AttributeId = 'db70666a-6364-11ee-bfc8-7f3b952deb2c' AND Id = '5943809a-6f5d-4f6e-8669-e8a65bd3583b'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Automatically assigned when an attribute value is created.
AttributeId	String	False	Attributes.Id	The Attribute Id.
Name	String	False		The name of the attribute value.
url	String	True		URL of the attribute.
CreatedAt	Datetime	True		When this record was created.
UpdatedAt	Datetime	True		When this record was last updated.

Automations

Create, update, delete, and query Automations in Zendesk.

Table Specific Information

Select

The following queries are processed server side, while other filters are processed client side within the Sync App.

SELECT * FROM Automations WHERE Id = '123'

SELECT * FROM Automations ORDER BY Position 

SELECT * FROM Automations ORDER BY CreatedAt  

SELECT * FROM Automations ORDER BY UpdatedAt

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

INSERT INTO Automations (Title, ConditionsAll, Actions) VALUES ('Roger Wilco II', '[{ \"field\": \"status\", \"operator\": \"is\",\"value\": \"open\" }, {\"field\": \"priority\", \"operator\": \"less_than\", \"value\": \"high\" }]', '[{\"field\": \"status\", \"value": \"solved\"}]')

Update

You must specify the Id of the automation to update. Title is required. Active and Position are optional. Updating an action updates the containing array, clearing the other actions. Include all your actions when updating any action. Allowed for agents.

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

Delete

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

DELETE FROM Automations WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when created.
Title	String	False		The title of the automation.
Active	Boolean	False		Whether the automation is active.
Position	Integer	False		The position of the automation.
ConditionsAll	String	False		An object that describes the conditions under which the automation will execute.
ConditionsAny	String	False		An object that describes the conditions under which the automation will execute.
Actions	String	False		An object describing what the automation will do.
CreatedAt	Datetime	True		The time the automation was created.
UpdatedAt	Datetime	True		The time of the last update of the automation.

Bookmarks

Create, Delete and Query the Bookmarks in Zendesk.

Table Specific Information

Select

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

SELECT * FROM Bookmarks

Insert

The TicketId field is required to insert. Allowed for agents.

INSERT INTO Bookmarks (TicketId) VALUES ('4')

Delete

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

DELETE FROM Bookmarks WHERE Id = '19152874442641'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the bookmark is created.
Ticket	String	True		The ticket object.
url	String	True		The API url of this bookmark.
CreatedAt	Datetime	True		The time the bookmark was created.

Pseudo-Columns

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


Name	Type	Description
TicketId	Integer	The time the bookmark was created.

Brands

Create, delete, update, and query Brands in Zendesk.

Table Specific Information

Select

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

SELECT * FROM Brands WHERE Id = '123'

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 Subdomain fields are required to insert. Allowed for admins.

INSERT INTO Brands (Name, Subdomain) VALUES ('Brand 1', 'brand1')

Update

You must specify the Id of the automation to update. Allowed for agents.

UPDATE Brands SET Name = 'Brand 2', Subdomain = 'brand2', HostMapping = 'brand2.com', Active = true  WHERE Id = '123'

Delete

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

DELETE FROM Brands WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	False		Automatically assigned when the brand is created.
Name	String	False		The name of the brand.
CreatedAt	Datetime	False		The time the brand was created.
UpdatedAt	Datetime	False		The time of the last update of the brand.
BrandUrl	String	False		The url of the brand.
HasHelpCenter	Boolean	False		If the brand has a Help Center.
HelpCenterState	String	False		The state of the Help Center: enabled, disabled, or restricted.
Active	Boolean	False		If the brand is set as active.
Default	Boolean	False		Is the brand the default brand for this account.
LogoId	Long	False		The id of logo image for this brand.
LogoUrl	String	False		The url of logo image for this brand.
LogoFileName	String	False		The name of logo image for this brand.
LogoContentUrl	String	False		The content url of logo image for this brand.
LogoMappedContentUrl	String	False		The mapped content url of logo image for this brand.
LogoContentType	String	False		The content type of logo image for this brand.
LogoSize	Integer	False		The size of logo image for this brand.
TicketFormIds	String	False		The ids of ticket forms that are available for use by a brand.
HostMapping	String	False		The hostmapping to this brand, if any (only admins view this key).
Subdomain	String	False		The subdomain of the brand.
SignatureTemplate	String	False		The signature template for a brand.
Url	String	False		The API url of this brand.

CategoryTranslations

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

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.
CategoryId	Long	False	Categories.Id	Id of the associated category.

ContentSubscriptions

Create, Update, Delete and Query the Content Subscriptions in Zendesk. Users can subscribe to sections, articles, community posts, and community topics.

Table Specific Information

Select

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

The following queries list the content subscriptions of a given user. To list your own subscriptions, specify me as the user id.

SELECT * FROM ContentSubscriptions WHERE UserId = '19128124956177'
SELECT * FROM ContentSubscriptions WHERE UserId = 'me'

The following queries list the subscriptions to a given topic.

SELECT * FROM ContentSubscriptions WHERE TopicId = '19209878690449'
SELECT * FROM ContentSubscriptions WHERE TopicId = '19209878690449' AND Id = '19209922023185'

The following queries list the subscriptions to a given post.

SELECT * FROM ContentSubscriptions WHERE PostId = '19206579516945'
SELECT * FROM ContentSubscriptions WHERE PostId = '19206579516945' AND Id = '19210209123217'

The following queries list the subscriptions to a given section. Provide values for the SectionId and Locale.

SELECT * FROM ContentSubscriptions WHERE SectionId = '19206579484689' AND Locale = 'en-us'
SELECT * FROM ContentSubscriptions WHERE SectionId = '19206579484689' AND Locale = 'en-us' AND Id = '19210938828817'

The following queries list the subscriptions to a given article. Provide values for the ArticleId and Locale.

SELECT * FROM ContentSubscriptions WHERE ArticleId = '19206609899793' AND Locale = 'en-us'
SELECT * FROM ContentSubscriptions WHERE ArticleId = '19206609899793' AND Locale = 'en-us' AND Id = '19211885836945'

Insert

To create a Subscription for a given Topic, TopicId column is required. Allowed for End-users. Agents with the Help Center manager role can optionally supply a UserId value. If provided, the user associated with UserId will be subscribed to the topic.

INSERT INTO ContentSubscriptions (TopicId, IncludeComments) VALUES ('19209878690449', true)

To create a Subscription for a given Post, PostId column is required. Allowed for End-users. Agents with the Help Center manager role can optionally supply a UserId value. If provided, the user associated with UserId will be subscribed to the post.

INSERT INTO ContentSubscriptions (PostId, UserId) VALUES ('19206579516945', '19157178632977')

To create a Subscription for a given Section, SectionId, Locale and SourceLocale columns are required. Allowed for End-users. Agents with the Help Center manager role can optionally supply a UserId value. If provided, the user associated with UserId will be subscribed to the section.

INSERT INTO ContentSubscriptions (SectionId, Locale, SourceLocale) VALUES ('19206579484689', 'en-us', 'en-us')

To create a Subscription for a given Article, ArticleId, Locale and SourceLocale columns are required. Allowed for End-users. Agents with the Help Center manager role can optionally supply a UserId value. If provided, the user associated with UserId will be subscribed to the article.

INSERT INTO ContentSubscriptions (ArticleId, Locale, SourceLocale) VALUES ('19206609899793', 'en-us', 'en-us')

Update

Update can be perform only on Topic Subscription. The TopicId and Id of the Subscription are required to Update it. Allowed for End-users.

UPDATE ContentSubscriptions SET IncludeComments = false WHERE TopicId = '19209878690449' AND Id = '19209922023185'

Delete

To remove a subscription to a given topic, Id and TopicId columns are required. Allowed for End-users.

DELETE FROM ContentSubscriptions WHERE TopicId = '19209878690449' AND Id = '19209922023185'

To remove a subscription to a given post, Id and PostId columns are required. Allowed for End-users.

DELETE FROM ContentSubscriptions WHERE PostId = '19206579516945' AND Id = '19210420873745'

To remove the specified subscription from the specified section, Id, SectionId and Locale columns are required. Allowed for End-users.

DELETE FROM ContentSubscriptions WHERE SectionId = '19206579516945' AND Id = '19210420873745' AND Locale = 'en-us'

To remove the specified subscription from the specified article, Id, ArticleId and Locale columns are required. Allowed for End-users.

DELETE FROM ContentSubscriptions WHERE ArticleId = '19206609899793' AND Id = '19211885836945' AND Locale = 'en-us'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the subscription is created.
UserId	String	False	Users.Id	The id of the user who has this subscription.
ContentId	Long	True		The id of the subscribed item.
ContentType	String	True		The type of the subscribed item.
IncludeComments	Boolean	False		Subscribe also to article comments/post comments. Only for section/topic subscriptions.
Locale	String	False		The locale of the subscribed item.
SourceLocale	String	False		Used only for Create Section Subscription and Create Article Subscription, where it's mandatory. Selects the locale of the content to be subscribed.
Url	String	True		The API url of the subscription.
CreatedAt	Datetime	True		The time at which the subscription was created.
UpdatedAt	Datetime	True		The time at which the subscription was last updated.

Pseudo-Columns

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


Name	Type	Description
TopicId	Long	Id of the Topic.
PostId	Long	Id of the Post.
SectionId	Long	Id of the Section.
ArticleId	Long	Id of the Article.

ContentTags

Create, Update, Delete and Query the Content Tags in Zendesk.

Table Specific Information

Select

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

SELECT * FROM ContentTags WHERE Id = '01HCCV8145J2MBX6XZ103G10CH'

Insert

The Name field is required to insert. Allowed for Guide managers and Guide agents.

INSERT INTO ContentTags (Name) VALUES ('Test')

Update

You must specify the Id of the ContentTag to update. Allowed for Guide managers.

UPDATE ContentTags SET Name = 'CData' WHERE Id = '01HCEJVFV4X9MA9D2SBC86FE5S'

Delete

You must specify the Id of the ContentTag to delete it. Allowed for Guide managers.

DELETE FROM ContentTags WHERE Id = '01HCEJVFV4X9MA9D2SBC86FE5S'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Automatically assigned when the content tag is created.
Name	String	False		The name of the content tag.
CreatedAt	Datetime	True		When the content tag was created.
UpdatedAt	Datetime	True		When the content tag was last updated.

CustomAgentRoles

Create, Update, Delete and Query CustomAgentRoles in Zendesk.

Table Specific Information

Select

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

Allowed for Agents.

SELECT * FROM CustomAgentRoles

When Id is mention in the criteria, the query is allowed only for Administrators and Agents with the manage_roles permission.

SELECT * FROM CustomAgentRoles WHERE Id = '13575064971293'

Insert

The Name field is required to insert. Allowed for Administrators and Agents with the manage_roles permission.

INSERT INTO CustomAgentRoles (Name, Description, ConfigurationChatAccess, ConfigurationUserViewAccess) VALUES ('Test', 'Description', true, 'readonly')

Update

You must specify the Id of the CustomAgentRole to update it. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for Administrators and Agents with the manage_roles permission.

UPDATE CustomAgentRoles SET Name = 'Updated Name', Description = 'Updated description', ConfigurationChatAccess = false, ConfigurationUserViewAccess = 'readonly' WHERE Id = '13575064971293'

Delete

You must specify the Id of the CustomAgentRole to delete it. Allowed for Administrators and Agents with the manage_roles permission.

DELETE FROM CustomAgentRoles WHERE Id = '13575064971293'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned upon creation.
Name	String	False		Name of the custom role.
Description	String	False		A description of the role.
CreatedAt	Datetime	True		The time the record was created.
UpdatedAt	Datetime	True		The time the record was last updated.
ConfigurationChatAccess	Boolean	False		Boolean value that checks whether or not the agent has access to Chat.
ConfigurationEndUserProfileAccess	String	False		What the agent can do with end-user profiles. Allowed values are edit, edit-within-org, full, readonly.
ConfigurationForumAccess	String	False		The kind of access the agent has to Guide. Allowed values are edit-topics, full, readonly.
ConfigurationForumAccessRestrictedContent	Boolean	False		Configuration Forum Access Restricted Content.
ConfigurationMacroAccess	String	False		What the agent can do with macros. Allowed values are full, manage-group, manage-personal, readonly.
ConfigurationManageBusinessRules	Boolean	False		Whether or not the agent can create and manage schedules and view rules analysis.
ConfigurationManageDynamicContent	Boolean	False		Whether or not the agent can access dynamic content.
ConfigurationManageExtensionsAndChannels	Boolean	False		Whether or not the agent can manage channels and extensions.
ConfigurationManageFacebook	Boolean	False		Whether or not the agent can manage facebook pages.
ConfigurationOrganizationEditing	Boolean	False		Whether or not the agent can add or modify organizations.
ConfigurationReportAccess	String	False		What the agent can do with reports. Allowed values are full, none, readonly.
ConfigurationTicketAccess	String	False		What kind of tickets the agent can access. Allowed values are all, assigned-only, within-groups, within-groups-and-public-groups, within-organization.
ConfigurationTicketCommentAccess	String	False		What kind of tickets the agent can access. Allowed values are all, assigned-only, within-groups, within-groups-and-public-groups, within-organization.
ConfigurationTicketDeletion	Boolean	False		Whether or not the agent can delete tickets.
ConfigurationTicketMerge	Boolean	False		Whether or not the agent can merge tickets.
ConfigurationTicketTagEditing	Boolean	False		Whether or not the agent can edit ticket tags.
ConfigurationTwitterSearchAccess	Boolean	False		Configuration Twitter Search Access.
ConfigurationViewAccess	String	False		What the agent can do with views. Allowed values are full, manage-group, manage-personal, playonly, readonly.
ConfigurationUserViewAccess	String	False		What the agent can do with customer lists. Allowed values are full, manage-group, manage-personal, none, readonly.
ConfigurationAssignTicketsToAnyGroup	Boolean	False		Whether or not the agent can assign tickets to any group.
ConfigurationCustomObjects	String	False		A list of custom object keys mapped to JSON objects that define the agent's permissions (scopes) for each object. Allowed values: are read, update, delete, create. The read permission is required if any other scopes are specified.
ConfigurationEndUserListAccess	String	False		Whether or not the agent can view lists of user profiles. Allowed values are full, none.
ConfigurationExploreAccess	String	False		Allowed values are edit, full, none, readonly.
ConfigurationGroupAccess	Boolean	False		Whether or not the agent can add or modify groups.
ConfigurationLightAgent	Boolean	False		Configuration Light Agent.
ConfigurationManageAutomations	Boolean	False		Whether or not the agent can create and manage automations.
ConfigurationManageContextualWorkspaces	Boolean	False		Whether or not the agent can view, add, and edit contextual workspaces.
ConfigurationManageGroupMemberships	Boolean	False		Whether or not the agent can create and manage group memberships.
ConfigurationManageGroups	Boolean	False		Whether or not the agent can create and modify groups.
ConfigurationManageOrganizationFields	Boolean	False		Whether or not the agent can create and manage organization fields.
ConfigurationManageOrganizations	Boolean	False		Whether or not the agent can create and modify organizations.
ConfigurationManageRoles	String	False		Whether or not the agent can create and manage custom roles with the exception of the role they're currently assigned. Doesn't allow agents to update role assignments for other agents. Allowed values are all-except-self, none.
ConfigurationManageSkills	Boolean	False		Whether or not the agent can create and manage skills.
ConfigurationManageSlas	Boolean	False		Whether or not the agent can create and manage SLAs.
ConfigurationManageSuspendedTickets	Boolean	False		Whether or not the agent can manage suspended tickets.
ConfigurationManageTeamMembers	String	False		Whether or not the agent can manage team members. Allows agents to update role assignments for other agents. Allowed values are all-with-self-restriction, readonly, none.
ConfigurationManageTicketFields	Boolean	False		Whether or not the agent can create and manage ticket fields.
ConfigurationManageTicketForms	Boolean	False		Whether or not the agent can create and manage ticket forms.
ConfigurationManageTriggers	Boolean	False		Whether or not the agent can create and manage triggers.
ConfigurationManageUserFields	Boolean	False		Whether or not the agent can create and manage user fields.
ConfigurationModerateForums	Boolean	False		Configuration Moderate Forums.
ConfigurationOrganizationNotesEditing	Boolean	False		Whether or not the agent can add or modify organization notes.
ConfigurationSideConversationCreate	Boolean	False		Whether or not the agent can contribute to side conversations.
ConfigurationTicketEditing	Boolean	False		Whether or not the agent can edit ticket properties.
ConfigurationTicketRedaction	Boolean	False		Whether or not the agent can redact content from tickets. Only applicable to tickets permitted by ticket_access.
ConfigurationViewDeletedTickets	Boolean	False		Whether or not the agent can view deleted tickets.
ConfigurationVoiceAccess	Boolean	False		Whether or not the agent can answer and place calls to end users.
ConfigurationVoiceDashboardAccess	Boolean	False		Whether or not the agent can view details about calls on the Talk dashboard.
RoleType	Integer	True		The user's role id. It is 0 for a custom agent.
TeamMemberCount	Integer	True		The number of team members assigned to this role.

CustomObjects

Create, delete, update, and query Custom Objects in Zendesk.

Select

The CustomObjects table supports the ObjectName column in the WHERE clause. This table supports the following operator: '='. For example:

SELECT * FROM CustomObjects WHERE ObjectName = 'house'

Insert

You can insert any field into the CustomObjects table that is not read-only. To insert Properties details for a custom object, use the #TEMP table to insert the fields of the property. The fields of the Property are present in the CustomObjectField view. For Example:

INSERT INTO CustomObjectField#TEMP (FieldName, Type, Description, Required) VALUES ('NumOfRooms', 'integer', 'The number of rooms.', true)
INSERT INTO CustomObjectField#TEMP (FieldName, Type, Description, Required) VALUES ('NumOfBaths', 'integer', 'The number of baths.', true)
INSERT INTO CustomObjectField#TEMP (FieldName, Type, Description, Required) VALUES ('Balcony', 'boolean', 'Whether or not balcony is there.', true)
INSERT INTO CustomObjectField#TEMP (FieldName, Type, Description) VALUES ('PropertyAge', 'string', 'Old or new construction.')
INSERT INTO CustomObjects (ObjectName, Properties) VALUES ('house', CustomObjectField#TEMP)

Update

You can update only Properties column in the CustomObjects Table. To update the properties details for a custom object, Use the #TEMP table to insert the fields of the property. The fields of the Property is present in CustomObjectField view.

INSERT INTO CustomObjectField#TEMP (FieldName, Type, Description, Required) VALUES ('CarParking', 'string', 'Whether or not car parking is available', true)");
INSERT INTO CustomObjectField#TEMP (FieldName, Required) VALUES ('balcony', false)");
UPDATE CustomObjects SET Properties = 'CustomObjectField#TEMP' WHERE ObjectName = 'house'");

Delete

To delete a Custom Object, the ObjectName is required.

DELETE FROM CustomObjects WHERE ObjectName = 'house'

Columns


Name	Type	ReadOnly	References	Description
ObjectName [KEY]	String	False		A user-defined unique identifier. Writable on create only.
CreatedAt	Datetime	True		The time the object type was created.
UpdatedAt	Datetime	True		The time of the last update of the object type.
Version	String	False		The version of this schema.
Properties	String	False		A description of the object record, up to a maximum of 32 KB.

CustomTicketStatuses

Create, update, and query custom ticket statuses in zendesk.

Table Specific Information

Select

The following queries are processed server-side, while other filters are processed client-side in the Sync App.

SELECT * FROM CustomTicketStatuses WHERE Id = 9930628462492

Insert

INSERT INTO CustomTicketStatuses (active,agentlabel,description,enduserdescription,enduserlabel,statuscategory) VALUES ('true', 'Try to Respond quickly', 'Customer needs a response quickly', 'Your ticket is being responded to', 'Urgent processing', 'open')

Update

UPDATE CustomTicketStatuses SET description = 'Customer needs a response quickly.' WHERE Id = 9930628462492

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the custom ticket status is created.
Active	Boolean	False		If true, the custom status is set to active, If false, the custom status is set to inactive.
URL	String	True		The label displayed to agents. Maximum length is 48 characters.
AgentLabel	String	False		The label displayed to agents. Maximum length is 48 characters.
Default	Boolean	False		If true, the custom status is set to default. If false, the custom status is set to non-default.
Description	String	False		The description of when the user should select this custom ticket status.
StatusCategory	String	False		The status category the custom ticket status belongs to. 使用できる値は次のとおりです。new, open, hold, pending, solved
EndUserLabel	String	False		The label displayed to end users. Maximum length is 48 characters.
EndUserDescription	String	False		The description displayed to end users.
RawAgentLabel	String	True		The dynamic content placeholder. If the dynamic content placeholder is not available, this is the agent_label value.
RawDescription	String	True		The dynamic content placeholder. If the dynamic content placeholder is not available, this is the raw_description value.
RawEndUserLabel	String	True		The dynamic content placeholder. If the dynamic content placeholder is not available, this is the raw_end_user_label value.
RawEndUserDescription	String	True		The dynamic content placeholder. If the dynamic content placeholder is not available, this is the raw_end_user_description value.
CreatedAt	Datetime	True		The date and time the custom ticket status was created.
UpdatedAt	Datetime	True		The time of the last update of the ticket field.

GroupMemberships

Create, delete, and query Group Memberships in Zendesk.

Table Specific Information

Select

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

SELECT * FROM GroupMemberships WHERE Id = '123'

SELECT * FROM GroupMemberships WHERE UserId = '123'

SELECT * FROM GroupMemberships WHERE GroupId = '123'

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 UserId and GroupId fields are required to insert (assigns an agent to a given group). Allowed for admins.

INSERT INTO GroupMemberships (UserId, GroupId) VALUES ('72', '88')

Delete

You must specify the Id of the membership to delete it (immediately removes a user from a group and schedules a job to unassign all working tickets that are assigned to the given user and group combination). Allowed for admins.

DELETE FROM GroupMemberships WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the ticket is created.
UserId	Long	False	Users.Id	The id of an agent.
GroupId	Long	False	Groups.Id	The id of a group.
Default	Boolean	False		If true, tickets assigned directly to the agent will assume this membership's group.
CreatedAt	Datetime	True		The time the membership was created.
UpdatedAt	Datetime	True		The time of the last update of the membership.
Url	String	True		The API url of this record.

Groups

Create, update, delete, and query Groups in Zendesk.

Table Specific Information

Select

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

SELECT * FROM Groups WHERE Id = '123'

SELECT * FROM Groups WHERE UserId = '123'

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 field is required to insert. Allowed for admins.

INSERT INTO Groups (Name) VALUES ('My Group')

Update

You must specify the Id of the group to update it. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for admins.

UPDATE Groups SET Name = 'Interesting Group' WHERE Id = '123'

Delete

You must specify the Id of the group to delete it. Note that you cannot delete the default group of the account. Allowed for admins.

DELETE FROM Groups WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the ticket is created.
Name	String	False		The name of the group.
CreatedAt	Datetime	True		The time the group was created.
UpdatedAt	Datetime	True		The time of the last update of the group.
Deleted	Boolean	True		Deleted groups get marked as such.
Url	String	True		The API url of this group.
UserId	Long	False		The user id used to query groups.

GroupSlaPolicies

Create, Update, Delete and Query Group SLA Policies in Zendesk.

Table Specific Information

Select

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

SELECT * FROM GroupSlaPolicies

SELECT * FROM GroupSlaPolicies WHERE Id = '01HXV0PT0DMK4MTFNK9Y6ENFJA'

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 Filter fields are required to insert. Allowed for admins.

INSERT INTO GroupSlaPolicies (Title, Description, Position, Filter) VALUES('Title test', 'desc' ,3, '{"all":[{"field":"group_id","operator":"includes","value":[9634300495132]}]}

Update

You must specify the Id of the GroupSlaPolicy to update. Allowed for admins.

UPDATE GroupSlaPolicies SET Title = 'Updated title' WHERE Id = '01HXV6JCGCDZGJ851VPQZWMG1E'

Delete

You must specify the Id of the GroupSlaPolicy to delete it. Allowed for admins.

DELETE FROM GroupSlaPolicies WHERE Id = '01HXV6JCGCDZGJ851VPQZWMG1E'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Automatically assigned when created.
Title	String	False		The title of the Group SLA policy.
Position	Integer	False		Position of the Group SLA policy. This position determines the order in which policies are matched to tickets. If not specified, the Group SLA policy is added at the last position.
Description	String	False		The description of the Group SLA policy.
PolicyMetrics	String	False		Array of policy metric objects.
CreatedAt	Datetime	True		The time the Group SLA policy was created.
UpdatedAt	Datetime	True		The time of the last update of the Group SLA policy.
Filter	String	False		An object that describes the conditions a ticket must match for a Group SLA policy to be applied to the ticket.
Url	String	True		URL of the Group SLA policy record.

Holidays

Create, update, delete, and query Schedules in Zendesk.

Table Specific Information

Select

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

SELECT * FROM Holidays WHERE ScheduleId = '123'

SELECT * FROM Holidays WHERE ScheduleId = '123' AND Id = '456'

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 ScheduleId, Name, StartDate and EndDate fields are required to insert. Allowed for admins.

INSERT INTO Holidays (ScheduleId, Name, StartDate, EndDate) VALUES ('360000022454', 'Christmas', '2016-12-25', '2016-12-25')

Update

You must specify the ScheduleId and Id of the holiday to update.Allowed for admins.

UPDATE Holidays SET Name = 'Christmas', StartDate = '2018-12-25', EndDate = '2018-12-25'  WHERE ScheduleId = '123' AND Id = '456'

Delete

You must specify the ScheduleId and Id of the holiday to delete it. Allowed for admins.

DELETE FROM Holidays WHERE ScheduleId = '123' AND Id = '456'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned upon creation.
ScheduleId	Long	False	Schedules.Id	Id of the schedule the holiday belongs to.
Name	String	False		Name of the holiday.
StartDate	Date	False		Time when the holiday starts.
EndDate	Date	False		Time when the holiday ends.

JiraLinks

View and create links between your Jira and Zendesk instances.

Table Specific Information

Select

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

SELECT * FROM JiraLinks WHERE Id = 123
SELECT * FROM JiraLinks WHERE TicketId = 123
SELECT * FROM JiraLinks WHERE IssueId = 123

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 Subdomain fields are required to insert. Allowed for admins.

INSERT INTO JiraLinks (TicketId, IssueId, IssueKey) VALUES (1, 1, 'TP-1')

Delete

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

DELETE FROM JiraLinks WHERE Id = 123

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	True		Automatically assigned when the link is created.
TicketId	Integer	False	Tickets.Id	The id of the Zendesk ticket.
IssueId	Integer	False		The id of the Jira issue.
IssueKey	String	False		The key for the Jira issue.
CreatedAt	Datetime	True		The time at which the link was created.
UpdatedAt	Datetime	True		The time at which the link was last updated.

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 Sync App.

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	References	Description
Id [KEY]	Long	False		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	False		The time the macro was created.
UpdatedAt	Datetime	False		The time of the last update of the macro.
Access	String	False		Only macros with given access. Possible values are personal, shared, or account.
Category	String	False		Only macros within given category.
GroupId	Long	False	Groups.Id	Only macros belonging to given group.
OnlyViewable	Boolean	False		Only macros that can be applied to tickets if true, All macros the current user can manage if false. Defaults to false.
Attachments	String	False		An array of macro attachment IDs to be associated with the macro, used in Insertion.

ManagementPermissionGroups

Create, Update, Delete and Query the Management Permission Groups in Zendesk. A management permission group defines which agents can create, update, archive, and publish articles. It consists of a set of privileges, each of which is mapped to a user segment. Agents receive whichever privileges are associated with the user segments they belong to.

Table Specific Information

Select

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

SELECT * FROM ManagementPermissionGroups WHERE Id = '19162149101585'

Insert

The Name column is required to insert. All fields that are not readonly (readonly="false" in the table) are optional for insert. Allowed for Help Center managers.

INSERT INTO ManagementPermissionGroups (Name, Edit) VALUES ('Test', '19162093613969, 19236810082193')

Update

You must specify the Id of the ManagementPermissionGroup to update. All fields that are not readonly (readonly="false" in the table) are optional for insert. Allowed for Help Center managers.

UPDATE ManagementPermissionGroups SET Name = 'UpdatedName' WHERE Id = '19239392699537'

Delete

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

DELETE FROM ManagementPermissionGroups WHERE Id = '19239392699537'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the permission group is created.
BuiltIn	Boolean	True		Whether the permission group is built-in. Built-in permission groups cannot be modified.
Name	String	False		Permission group name.
Edit	String	False		The ids of user segments that have edit privileges. For insertion and updation provide these values separated by comma.
Publish	String	False		The ids of user segments that have publish privileges. For insertion and updation provide these values separated by comma.
CreatedAt	Datetime	True		When the permission group was created.
UpdatedAt	Datetime	True		When the permission group was last updated.

OrganizationFields

Create, update, delete, and query Organization Fields in Zendesk.

Table Specific Information

Select

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

SELECT * FROM OrganizationFields WHERE Id = '123'

Insert

The Type, Title, and Key fields are required to insert. The types of custom fields that can be created are the following: text (default when no Type is specified), textarea, checkbox, date, integer, decimal, and regex (when Type is regex, RegexpForValidation is required too). Allowed for admins.

INSERT INTO OrganizationFields (Type, Title, Key) VALUES ('text', 'Support description', 'support_description')

You can also create Lookup Relationships. A lookup relationship field is a custom field whose type is "lookup". This type of custom field gives you the ability to create a relationship from a source object to a target object. To create a lookup relationship fields, Type, Key and RelationshipTargetType columns are required. The Type column value must be "lookup". A suitable combination of Field, Operator and Value is required for insertion in RelationshipFilterAll and RelationshipFilterAny. Here is a list of the possible combinations: "https://developer.zendesk.com/documentation/ticketing/reference-guides/conditions-reference/#shared-conditions".

INSERT INTO OrganizationFieldsRelationshipFilterAll#temp (Field, Operator, Value) VALUES ('status', 'less_than', 'solved')
INSERT INTO OrganizationFieldsRelationshipFilterAny#temp (Field, Operator, Value) VALUES ('status', 'less_than', 'solved')
INSERT INTO OrganizationFields (Type, Title, Key, RelationshipTargetType, RelationshipFilterAll, RelationshipFilterAny) VALUES ('lookup', 'Support description', 'support_description5', 'zen:ticket', 'OrganizationFieldsRelationshipFilterAll#temp', 'OrganizationFieldsRelationshipFilterAny#temp')

Update

You must specify the Id of the organization field to update. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for admins.

UPDATE OrganizationFields SET Title = 'Updated title' WHERE Id = '123'

Delete

You must specify the Id of the organizational field to delete it. Allowed for admins.

DELETE FROM OrganizationFields WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	False		Automatically assigned upon creation.
Key	String	False		A unique key that identifies this custom field. Required on create.This is used for updating the field and referencing in placeholders. After a field is created, you cannot change its key.
Type	String	False		Type of the custom field: checkbox, date, decimal, dropdown, integer, regexp, text, or textarea. After a field is created, you cannot change its type.
Title	String	False		The title of the custom field.
RawTitle	String	False		The dynamic content placeholder, if present, or the title value, if not.
Description	String	False		User-defined description of this field s purpose.
RawDescription	String	False		The dynamic content placeholder, if present, or the description value, if not.
Position	Integer	False		Ordering of the field relative to other fields.
Active	Boolean	False		If true, this field is available for use.
System	Boolean	False		If true, only active and position values of this field can be changed.
RegexpForValidation	String	False		Regular expression field only. The validation pattern for a field value to be deemed valid.
CreatedAt	Datetime	False		The time the ticket field was created.
UpdatedAt	Datetime	False		The time of the last update of the ticket field.
Tag	String	False		Optional for custom field of type checkbox; not presented otherwise.
CustomFieldOptions	String	False		Required and presented for a custom field of type dropdown.
Url	String	False		The URL for this resource.
RelationshipFilterAll	String	False		A filter definition that allows your autocomplete to filter down results with Logical AND.
RelationshipFilterAny	String	False		A filter definition that allows your autocomplete to filter down results with Logical OR.
RelationshipTargetType	String	False		A representation of what type of object the field references. Options are zen:user, zen:organization, zen:ticket, or zen:custom_object:CUSTOM_OBJECT_KEY. For example zen:custom_object:apartment.

OrganizationMemberships

Create, delete, and query Organization Memberships in Zendesk.

Table Specific Information

Select

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

SELECT * FROM OrganizationMemberships WHERE Id = '123'

SELECT * FROM OrganizationMemberships WHERE UserId = '123'

SELECT * FROM OrganizationMemberships WHERE OrganizationId = '123'

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 The UserId and OrganizationId fields are required to insert (assigns a user to a given organization). Allowed for agents.

INSERT INTO OrganizationMemberships (UserId, OrganizationId) VALUES ('772', '881')

Delete

You must specify the Id of the membership to delete it. Allowed for admins.

DELETE FROM OrganizationMemberships WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the membership is created.
OrganizationId	Long	False	Organizations.Id	The ID of the organization associated with this user, in this membership.
UserId	Long	False	Users.Id	The ID of the user for whom this memberships belongs.
Default	Boolean	False		Denotes whether this is the default organization membership for the user. If false, returns null.
CreatedAt	Datetime	False		When this record was created.
UpdatedAt	Datetime	False		When this record last got updated.
Url	String	False		The url of this resource.

Organizations

Create, delete, update, and query Organizations in Zendesk.

Table Specific Information

Select

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

SELECT * FROM Organizations WHERE Id = '123'

SELECT * FROM Organizations WHERE Id IN ('123', '456')

SELECT * FROM Organizations WHERE UserId = '123'

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 field is required to insert. Allowed for admins. Note: You must provide a unique name for each organization. Normally the system does not allow records to be created with identical names. However, a race condition can occur if you make two or more identical POSTs very close to each other, causing the records to have identical organization names.

INSERT INTO Organizations (Name) VALUES ('My Organization')

To create many organizations see the Batch Processing section for an example.

Update

You must specify the Id of the organization to update it. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for admins.

UPDATE Organizations SET Notes = 'Something interesting' WHERE Id = '123'

To make the same change to multiple organizations, use the following Sql statement:

UPDATE Organizations SET Notes = 'Something interesting' WHERE Id IN ('123', '456')

To make different changes to multiple organizations, see Batch Processing for an example.

Delete

You must specify the Id of the organization to delete it. Allowed for admins.

DELETE FROM Organizations WHERE Id = '123'

You can delete many organizations simultaneously by providing their ids:

DELETE FROM Organizations WHERE Id IN ('123', '456')

You can also delete many organizations simultaneously by using Batch Processing.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the ticket is created.
Name	String	False		A unique name for the organization.
GroupId	Long	False	Groups.Id	New tickets from users in this organization are automatically put in this group.
ExternalId	String	False		A unique external id to associate organizations to an external record.
CreatedAt	Datetime	True		The time the organization was created.
UpdatedAt	Datetime	True		The time of the last update of the organization.
DomainNames	String	False		An array of domain names associated with this organization.
Details	String	False		Any details obout the organization, such as the address.
Notes	String	False		Any notes you have about the organization.
SharedTickets	Boolean	False		End users in this organization are able to see tickets of each other.
SharedComments	Boolean	False		End users in this organization are able to see comments on tickets of each other.
Tags	String	False		The tags of the organization.
Url	String	True		The URL for this resource.
UserId	Long	False		The user id used to query organizations.

OrganizationSubscriptions

Create, delete, and query Organization Subscriptions in Zendesk.

Table Specific Information

Select

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

SELECT * FROM OrganizationSubscriptions WHERE Id = '123'

SELECT * FROM OrganizationSubscriptions WHERE UserId = '123'

SELECT * FROM OrganizationSubscriptions WHERE OrganizationId = '123'

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 UserId and OrganizationId fields are required to insert. End users can only subscribe to shared organizations in which they're members. Allowed for agents and end users.

INSERT INTO OrganizationSubscriptions (UserId, OrganizationId) VALUES ('772', '881')

Delete

You must specify the Id of the subscription to delete it. Allowed for agents and end users.

DELETE FROM OrganizationSubscriptions WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Organization subscription id.
OrganizationId	Long	False	Organizations.Id	.
UserId	Long	False		.
CreatedAt	Datetime	True		.
Url	String	True		The url of this resource.

PostComments

Query, Insert, Update and Delete PostComments in Zendesk.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the comment is created.
Url	String	True		The API url of the comment.
HtmlUrl	String	True		The community url of the comment.
Body	String	False		The comment made by the author.
AuthorId	Long	True		The id of the author of the comment. *Writable on create by Help Center managers.
PostId	Long	True	Posts.Id	The id of the post on which the comment was made.
Official	Boolean	False		Whether the comment is marked as official.
VoteSum	Integer	True		The sum of upvotes (+1) and downvotes (-1), which may be positive or negative.
VoteCount	Integer	True		The total number of upvotes and downvotes.
CreatedAt	Datetime	True		The time the post was created.
UpdatedAt	Datetime	True		The time of the last update of the post.
FilterBy	String	False		May be planned, not_planned, completed, answered or none.

Posts

Query, Insert, Update and Delete Posts in Zendesk.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the post is created.
Url	String	True		The API url of the post.
HtmlUrl	String	True		The community url of the post.
Title	String	False		The title of the post.
Details	String	False		The details of the post.
AuthorId	Long	True		The id of the author of the post. *Writable on create by Help Center managers.
Pinned	Boolean	False		When true, pins the post to the top of its topic.
Featured	Boolean	False		Whether the post is featured.
Closed	Boolean	False		Whether further comments are allowed.
Status	String	False		The status of the post.
VoteSum	Integer	True		The sum of upvotes (+1) and downvotes (-1), which may be positive or negative.
VoteCount	Integer	True		The total number of upvotes and downvotes.
CommentCount	Integer	True		The number of comments on the post.
FollowerCount	Integer	True		The number of followers of the post.
TopicId	Long	False	Topics.Id	The id of the topic that the post belongs to.
CreatedAt	Datetime	True		The time the post was created.
UpdatedAt	Datetime	True		The time of the last update of the post.
FilterBy	String	False		May be planned, not_planned, completed, answered or none.

SatisfactionRatings

Create and query Requests in Zendesk.

Table Specific Information

Select

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

SELECT * FROM SatisfactionRatings WHERE Id = '123'

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 TicketId and Score fields are required to insert. Creates a CSAT rating for solved tickets, or for tickets that were previously solved and then reopened. Allowed for an end user who requested the ticket.

INSERT INTO SatisfactionRatings (TicketId, Score) VALUES ('12', 'good')

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	False		Automatically assigned upon creation.
TicketId	Integer	False	Tickets.Id	The id of ticket being rated.
Score	String	False		The rating: offered, unoffered, good or bad. When used in a filter it takes one of values: offered, unoffered, received, received_with_comment, received_without_comment, good, good_with_comment, good_without_comment, bad, bad_with_comment, bad_without_comment.
Comment	String	False		The comment received with this rating, if available.
Reason	String	False		The reason for a bad rating given by the requester in a follow-up question. Satisfaction reasons must be enabled.
AssigneeId	Long	False	Users.Id	The id of agent assigned to at the time of rating.
GroupId	Long	False	Groups.Id	The id of group assigned to at the time of rating.
RequesterId	Long	False	Users.Id	The id of ticket requester submitting the rating.
CreatedAt	Datetime	False		The time the satisfaction rating got created.
UpdatedAt	Datetime	False		The time the satisfaction rating got updated.
Url	String	False		The API url of this rating.
StartTime	Datetime	False		Time of the oldest satisfaction rating.
EndTime	Datetime	False		Time of the most recent satisfaction rating.

Schedules

Create, update, delete and query Schedules in Zendesk.

Table Specific Information

Select

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

SELECT * FROM Schedules WHERE Id = '123'

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 TimeZone fields are required to insert. Allowed for admins.

INSERT INTO Schedules (Name, TimeZone) VALUES ('test', 'Eastern Time (US & Canada)')

Update

You must specify the Id of the schedule to update. Allowed for admins.

UPDATE Schedules SET Name = 'EMEA', TimeZone = 'London' WHERE Id = '123'

You can update the intervals of a Schedule by issuing a separate Update statement.

UPDATE Schedules SET Intervals = '[{\"start_time\": 3420, \"end_time\": 3900}]' WHERE Id = '123'

Delete

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

DELETE FROM Schedules WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned upon creation.
Name	String	False		Name of the schedule.
TimeZone	String	False		Time zone of the schedule.
Intervals	String	False		Array of intervals for the schedule.
CreatedAt	Datetime	True		Time the schedule was created.
UpdatedAt	Datetime	True		Time the schedule was last updated.

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 Sync App.

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'

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.
Sorting	String	False		The type of sorting.

SectionTranslations

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

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.
SectionId	Long	False	Sections.Id	Id of the associated section.

Sessions

Query and delete Sessions in Zendesk.

Table Specific Information

Select

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

SELECT * FROM Sessions WHERE Userid = '123'

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.

Delete

You must specify the UserId and Id of the session to delete it. Allowed for admins, agents, end users.

DELETE FROM Sessions WHERE Userid = '123' AND Id = '456'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the session is created.
UserId	Long	True	Users.Id	The id of the user.
AuthenticatedAt	Datetime	True		When the session was created.
LastSeenAt	Datetime	True		The last approximate time this session was seen. This does not update on every request.
Url	String	True		The API URL of this session.

SharingAgreements

Create, update, delete, and query SharingAgreements in Zendesk.

Table Specific Information

Select

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

SELECT * FROM SharingAgreements WHERE Id = '123'

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 RemoteSubdomain field is required to insert. Allowed for agents.

INSERT INTO SharingAgreements (RemoteSubdomain) VALUES ('Foo')

Update

You must specify the Id of the SharingAgreement to update. Only Status is allowed to be updated. Allowed for agents.

UPDATE SharingAgreements SET Status = 'accepted' WHERE Id = '123'

Delete

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

DELETE FROM SharingAgreements WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned upon creation.
Name	String	False		Name of this sharing agreement.
Type	String	False		Can be one of the following: 'inbound', 'outbound'.
Status	String	False		Can be one of the following: 'accepted', 'declined', 'pending', 'inactive'.
PartnerName	String	False		Can be one of the following: 'jira', null.
RemoteSubdomain	String	False		Subdomain of the remote account or null if not associated with an account.
CreatedAt	Datetime	True		The time the record was created.

SideConversations

Create, update and query Side Conversations in Zendesk.

Table Specific Information

Select

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

At least TicketId is required in order to retrieve the SideConversations.

SELECT * FROM SideConversations WHERE TicketId = 1
SELECT * FROM SideConversations WHERE TicketId = 1 AND Id = '5d133b65-576c-11ee-bcb2-bdce8f618e59'

Insert

The Columns TicketId, Subject, PreviewText and Participants are required to insert. Allowed for Agents.

INSERT INTO SideConversationParticipants#temp (Email,Name) VALUES ('[email protected]', 'someone')
INSERT INTO SideConversations (TicketId, Subject, PreviewText, Participants) VALUES (1, 'Test Subject', 'Test Body', 'SideConversationParticipants#temp')

You can also reply to a side conversation. The Columns Id, TicketId, Subject, PreviewText and Participants are required for Reply on a particular SideConversation. Allowed for Agents.

INSERT INTO SideConversationParticipants#temp (Email,Name) VALUES ('[email protected]', 'someone')
INSERT INTO SideConversations (Id, TicketId, Subject, PreviewText, Participants) VALUES ('5d133b65-576c-11ee-bcb2-bdce8f618e59', 2, 'Test Reply', 'Body for Reply message', 'SideConversationParticipants#temp')

Update

You must specify the TicketId and Id of the SideConversation to update. It only updates the State and Subject columns. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for Agents.

UPDATE SideConversations SET State = 'open' WHERE Id = '5d133b65-576c-11ee-bcb2-bdce8f618e59' AND TicketId = 1

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		Automatically assigned when the side conversation is created.
TicketId	Integer	False	Tickets.Id	The parent ticket id of the side conversation.
ExternalIds	String	False		A key-value store of metadata. All values must be strings.
Subject	String	False		The subject of the side conversation.
CreatedAt	Datetime	True		The time the side conversation was created.
UpdatedAt	Datetime	True		The time the side conversation was created.
MessageAddedAt	Datetime	True		The time of the last message on the side conversation.
Participants	String	False		An array of participants in the side conversation.
PreviewText	String	False		A plain text text describing the side conversation.
State	String	False		The state of the side conversation.
StateUpdatedAt	Datetime	True		The time of the update of the state of the side conversation.
Url	String	True		The API url of the side conversation.

SlaPolicies

Create, update, delete, and query SlaPolicies in Zendesk.

Table Specific Information

Select

The following queries are processed server-side while other filters are processed client-side within the Sync App.

SELECT * FROM SlaPolicies
SELECT * FROM SlaPolicies WHERE Id = '18393257431953'

Insert

The Title field and atleast one field from either FilterAll or FilterAny is required to insert. A suitable combination of Field, Operator and Value is required for insertion in FilterAll and FilterAny. Here is a list of the possible combinations: "https://developer.zendesk.com/documentation/ticketing/reference-guides/conditions-reference/#shared-conditions". Allowed for admins.

INSERT INTO SlaPoliciesFilterAll#temp(Field, Operator, Value) VALUES('type', 'is', 'incident')
INSERT INTO SlaPoliciesFilterAny#temp(Field, Operator, Value) VALUES('type', 'is', 'problem')
INSERT INTO SlaPolicies(Title, Description, FilterAll, FilterAny) values('Test', 'This is the test description', 'SlaPoliciesFilterAll#temp', 'SlaPoliciesFilterAny#temp')

Update

You must specify the Id of the SlaPolicies to update it. FilterAll and FilterAny aggregate columns support duplicate values in the object, so in order to update these fields, you must specifty the whole aggregate object. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for admins.

INSERT INTO SlaPoliciesFilterAll#temp(Field, Operator, Value) Values('type', 'is', 'task')
INSERT INTO SlaPoliciesFilterAll#temp(Field, Operator, Value) Values('type', 'is', 'incident')
INSERT INTO SlaPoliciesFilterAll#temp(Field, Operator, Value) Values('group_id', 'is', '18285074736529')
UPDATE SlaPolicies SET Title='Updated Title', FilterAll='SlaPoliciesFilterAll#temp' WHERE Id = '18393257431953'

Delete

You must specify the Id of the group to delete it. Allowed for admins.

DELETE FROM SlaPolicies WHERE Id=18392949131793

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned.
Title	String	False		The title of the SLA policy.
Description	String	False		The description of the SLA policy.
CreatedAt	Datetime	True		When this locale was created.
UpdatedAt	Datetime	True		When this locale was last updated.
Position	Integer	True		Position of the SLA policy, determines the order they will be matched. If not specified, SLA Policy is added as the last position.
FilterAll	String	False		An object that describes the conditions that a ticket must match in order for an SLA policy to be applied to that ticket.
FilterAny	String	False		An object that describes the conditions that a ticket must match in order for an SLA policy to be applied to that ticket.
PolicyMetrics	String	False		An object that describes the metric targets for each value of the priority field.

SupportAddresses

Create, update, delete, and query Support Addresses in Zendesk.

Table Specific Information

Select

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

SELECT * FROM SupportAddresses WHERE Id = '123'

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 Email field is required to insert (only adding a Zendesk support address to your account is supported). To add a Zendesk address, use the following syntax: {local-part}@{accountname}.zendesk.com. Example: '[email protected]'. The local-part can be anything you like. Allowed for admins.

INSERT INTO SupportAddresses  (Email) VALUES ('[email protected]')

Update

You must specify the Id of the support address to update. Allowed for admins.

UPDATE SupportAddresses SET Name = 'Sales' WHERE Id = '123'

Delete

You must specify the Id of the support address to delete it. Allowed for admins.

DELETE FROM SupportAddresses WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when created.
Name	String	False		The name for the address.
Email	String	False		The email address (not updateable).
CreatedAt	Datetime	True		The time the brand was created.
UpdatedAt	Datetime	True		The time of the last update of the brand.
Default	Boolean	False		Whether the address is the account's default support address.
BrandId	Long	False	Brands.Id	The id of the brand.
ForwardingStatus	String	True		Possible values: unknown, waiting, verified, or failed.
SpfStatus	String	True		Possible values: unknown, verified, failed.

SuspendedTickets

Query and delete Suspended Tickets in Zendesk.

Table Specific Information

Select

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

SELECT * FROM SuspendedTickets WHERE Id = '123'

SELECT * FROM SuspendedTickets ORDER BY AuthorEmail

SELECT * FROM SuspendedTickets ORDER BY Cause

SELECT * FROM SuspendedTickets ORDER BY Subject

SELECT * FROM SuspendedTickets ORDER BY CreatedAt

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.

Delete

You must specify the Id of the suspended ticket to delete it. Allowed for unrestricted agents.

DELETE FROM SuspendedTickets WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the ticket is created.
TicketId	Integer	True	Tickets.Id	The ticket ID this suspended email is associated with, if available.
MessageId	String	True		The ID of the email, if available.
BrandId	Long	True	Brands.Id	The id of the brand this ticket is associated with - only applicable for enterprise accounts.
Recipient	String	True		The original recipient e-mail address of the ticket.
Subject	String	True		The value of the subject field for this ticket.
Content	String	True		The content that was flagged.
AuthorId	Long	True		The id of author.
AuthorName	String	True		The name of author.
AuthorEmail	String	True		The email of author.
Cause	String	True		Why the ticket was suspended.
CreatedAt	Datetime	True		When this record was created.
UpdatedAt	Datetime	True		When this record last got updated.
ViaChannel	String	True		.
ViaSourceFromId	Long	True		.
ViaSourceFromTitle	String	True		.
ViaSourceTo	String	True		.
ViaSourceRel	String	True		.
Url	String	True		The API url of this ticket.

Targets

Create, Update, Delete and Query Targets in Zendesk.

Table Specific Information

Select

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

SELECT * FROM Targets

SELECT * FROM Targets WHERE Id = '13957230417180'

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 Type, Title, Email and Subjects fields are required to insert. Allowed for admins.

INSERT INTO Targets (Type, Title, Email, Subject) VALUES ('email_target', 'YM_title', '[email protected]', 'This Subject is for Testing')

Update

You must specify the Type and Id of the Target to update. Allowed for admins.

UPDATE Targets SET Email = '[email protected]', Type = 'email_target'  WHERE Id = '18958433666450'

Delete

You must specify the Id of the Target to delete it. Allowed for admins.

DELETE FROM Targets WHERE Id = '13957990475420'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when Target is created.
Type	String	False		A pre-defined target, such as basecamp_target.
Title	String	False		A name for the target.
Active	Boolean	False		Whether or not the target is activated.
Email	String	False		Email.
Subject	String	False		Subject of the email.
Url	String	True		Url.
CreatedAt	Datetime	True		The time the target was created.

TicketAudits

Query TicketAudits in Zendesk.

Table Specific Information

Select

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

SELECT * FROM TicketAudits WHERE TicketId = '123'

SELECT * FROM TicketAudits WHERE TicketId = '123' AND Id = '456'

To get the TicketIds of deleted tickets, run this query:

GETDELETED FROM TicketAudits

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	False		Automatically assigned when creating audits.
TicketId	Integer	False	Tickets.Id	The ID of the associated ticket.
AuthorId	Long	False	Users.Id	The user who created the audit.
CreatedAt	Datetime	False		The time the audit was created.
Metadata	String	False		Metadata for the audit, custom and system data.
ViaChannel	String	False		This object explains how this audit was created. This does not update on every request.
ViaSource	String	False		This object explains how this audit was created. This does not update on every request.
Events	String	False		The Array of Events that happened in this Audit.

TicketComments

Query TicketComments belonging to a specified ticket in Zendesk.

Table Specific Information

Select

The Ticket Id is required to query this view. The following queries are processed server side.

SELECT * FROM TicketComments WHERE TicketId = '123'

To get the TicketIds of deleted tickets run this query:

GETDELETED FROM TicketComments

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	False		Automatically assigned when the ticket is created.
TicketId	Integer	False	Tickets.Id	The id of the ticket the comment belongs to.
AuthorId	Long	False	Users.Id	The id of the comment author.
AuditId	Long	False		The id of the ticket audit record.
Type	String	False		Comment or VoiceComment.
Body	String	False		The comment string.
CreatedAt	Datetime	False		The time the comment was created.
HtmlBody	String	False		The comment formatted as HTML.
PlainBody	String	False		The comment as plain text.
IsPublic	Boolean	False		True if a public comment; false if an internal note. The initial value set on ticket creation persists for any additional comment unless you change it.
ViaChannel	String	False		This tells you how the ticket or event was created. Examples: 'web', 'mobile', 'rule', 'system'.
ViaSource	String	False		.
MetadataCustom	String	False		.
MetadataSystemClient	String	False		.
MetadataSystemIpAddres	String	False		.
MetadataSystemLatitude	String	False		.
MetadataSystemLongitude	String	False		.
MetadataSystemLocation	String	False		.

Pseudo-Columns

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


Name	Type	Description
UpdatedAt	Datetime	The time of the comment was updated.
ReferenceNumber	String	Reference number which can be use while doing temp table insertion.

TicketEvents

Query TicketEvents in Zendesk.

Table Specific Information

Select

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

SELECT * FROM TicketEvents WHERE StartTime = '2023-10-11'
SELECT * FROM TicketEvents WHERE StartTime = '2023-10-11' AND Include = true
SELECT * FROM TicketEvents WHERE Include = true

To get the TicketIds of deleted tickets run this query:

GETDELETED FROM TicketEvents

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	False		Automatically assigned when Ticket Event is created.
TicketId	Integer	False	Tickets.Id	The ticket Id.
ChildEvents	String	False		Array of the Child Events.
UpdaterId	Long	False		Updater Id.
Timestamp	String	False		Timestamp at which event is created.
Via	String	False		The medium through which event is created.
SystemClient	String	False		System client information.
SystemLocation	String	False		System location information.
SystemLatitude	String	False		System latitude information.
SystemLongitude	String	False		System longitude information.
EventType	String	False		Type of the Event.
CreatedAt	Datetime	False		When this record was created.
Metadata	String	False		The metadata of the event.

Pseudo-Columns

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


Name	Type	Description
StartTime	Datetime	The time to start the incremental export from. Must be at least one minute in the past. If not provided, it will take the starttime for the most recent minute.
Include	Boolean	If true, it will include the comments in the event stream. By default, value is false.

TicketFields

Create, update, delete, and query TicketFields in Zendesk.

Table Specific Information

Select

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

SELECT * FROM TicketFields WHERE Id = '123'

Insert

The Type and Title fields are required to insert. Allowed for admins.

INSERT INTO TicketFields (Type, Title) VALUES ('text', 'Age')

To insert a ticket field of type tagger (dropdown) or multiselect (dropdown), CustomFieldOptions is also required. Allowed for admins.

INSERT INTO TicketFields (Type, Title, CustomFieldOptions) VALUES ('tagger', 'TestDropdown', '[{\"name\": \"Apple Pie\", \"value\": \"apple\"}, {\"name\": \"Pecan Pie\", \"value\": \"pecan\"}]')

To insert a ticket field of type regexp, RegexpForValidation is also required. Allowed for admins.

INSERT INTO TicketFields (Type, Title, RegexpForValidation) VALUES ('regexp', 'TestRegExp', '\\b([0-9]{4})-(1[0-2]|0?[1-9])-(3[0-1]|[1-2][0-9]|0?[1-9])\\b')

You can also create Lookup Relationships. A lookup relationship field is a custom field whose type is "lookup". This type of custom field gives you the ability to create a relationship from a source object to a target object. To create a lookup relationship fields, Type and RelationshipTargetType columns are required. The Type column value must be "lookup". A suitable combination of Field, Operator and Value is required for insertion in RelationshipFilterAll and RelationshipFilterAny. Here is a list of the possible combinations: "https://developer.zendesk.com/documentation/ticketing/reference-guides/conditions-reference/#shared-conditions".

INSERT INTO TicketFieldsRelationshipFilterAll#temp(Field, Operator, Value) VALUES ('role', 'is', 'Agent')
INSERT INTO TicketFieldsRelationshipFilterAny#temp(Field, Operator, Value) VALUES ('role', 'is', 'Agent')
INSERT INTO TicketFields (Type, Title, RelationshipTargetType, RelationshipFilterAll, RelationshipFilterAny) VALUES ('lookup', 'Lookup Relationships', 'zen:user', 'TicketFieldsRelationshipFilterAll#temp', 'TicketFieldsRelationshipFilterAny#temp')

Update

You must specify the Id of the ticket field to update. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for admins.

UPDATE TicketFields SET Title = 'Your age' WHERE Id = '123'

For a ticket field of type tagger (dropdown) or multiselect (dropdown), use the CustomFieldOptions column to update the options. For type regexp use RegexpForValidation to update the regular expression.

Delete

You must specify the Id of the ticket field to delete it. Allowed for admins.

DELETE FROM TicketFields WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the ticket is created.
Type	String	False		The type of the ticket field: checkbox, date, decimal, integer, regexp, tagger, text, or textarea. Type is not editable once created.
Title	String	False		The title of the ticket field.
RawTitle	String	False		The dynamic content placeholder, if present, or the 'title' value, if not.
Description	String	False		The description of the purpose of this ticket field, shown to users.
RawDescription	String	False		The dynamic content placeholder, if present, or the 'description' value, if not.
Position	Integer	False		A relative position for the ticket fields that determines the order of ticket fields on a ticket. Note that positions 0 to 7 are reserved for system fields.
Active	Boolean	False		Whether this field is available.
Required	Boolean	False		Whether this field is available.
CollapsedForAgents	Boolean	False		If this field should be shown to agents by default or be hidden alongside infrequently used fields. Classic interface only.
RegexpForValidation	String	False		Regular expression field only. The validation pattern for a field value to be deemed valid.
TitleInPortal	String	False		The title of the ticket field when shown to end users.
RawTitleInPortal	String	False		The dynamic content placeholder, if present, or the 'title_in_portal' value, if not.
VisibleInPortal	Boolean	False		Whether this field is available to end users.
EditableInPortal	Boolean	False		Whether this field is editable by end users.
Tag	String	False		A tag value to set for checkbox fields when checked.
CreatedAt	Datetime	True		The time the ticket field was created.
UpdatedAt	Datetime	True		The time of the last update of the ticket field.
SystemFieldOptions	String	True		Presented for a ticket field of type 'tickettype', 'priority' or 'status'.
CustomFieldOptions	String	False		Required and presented for a ticket field of type 'tagger'.
Removable	Boolean	True		If this field is not a system basic field that must be present for all tickets on the account.
Url	String	True		The URL for this resource.
AgentDescription	String	False		A description of the ticket field that only agents can see.
CustomStatuses	String	True		List of customized ticket statuses. Only presented for a system ticket field of type custom_status.
RelationshipFilterAll	String	False		A filter definition that allows your autocomplete to filter down results with Logical AND.
RelationshipFilterAny	String	False		A filter definition that allows your autocomplete to filter down results with Logical OR.
RelationshipTargetType	String	False		A representation of what type of object the field references. Options are zen:user, zen:organization, zen:ticket, or zen:custom_object:CUSTOM_OBJECT_KEY. For example zen:custom_object:apartment.
RequiredInPortal	String	False		If true, end users must enter a value in the field to create the request.
SubTypeId	String	False		For system ticket fields of type priority and status. Defaults to 0. A priority sub type of 1 removes the Low and Urgent options. A status sub type of 1 adds the On-Hold option.

TicketForms

Create, update, delete, and query Ticket Forms in Zendesk.

Table Specific Information

Select

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

SELECT * FROM TicketForms WHERE Id = '123'

SELECT * FROM TicketForms WHERE Id IN ('123', '456')

SELECT * FROM TicketForms WHERE Active = true

SELECT * FROM TicketForms WHERE EndUserVisible = true

SELECT * FROM TicketForms WHERE FallbackToDefault = true

SELECT * FROM TicketForms WHERE AssociatedToBrand = true

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 field is required to insert. Allowed for admins.

INSERT INTO TicketForms (Name, EndUserVisible, DisplayName, Position, Active, Default) VALUES ('Snowboard Problem', true, 'Snowboard Damage' 2, true, false)

Update

You must specify the Id of the ticket form to update it. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for admins.

UPDATE TicketForms SET Name = 'Snowboard Fixed', DisplayName = 'Snowboard has been fixed' WHERE Id = '123'

Delete

You must specify the Id of the ticket form to delete it. Allowed for admins.

DELETE FROM TicketForms WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Ticket form id.
Name	String	False		The name of the form.
RawName	String	False		The dynamic content placeholder, if present, or the 'name' value, if not.
DisplayName	String	False		The name of the form that is displayed to an end user.
RawDisplayName	String	False		The dynamic content placeholder, if present, or the 'display_name' value, if not.
Position	Integer	False		The position of this form among other forms in the account, i.e. dropdown.
Active	Boolean	False		If the form is set as active.
EndUserVisible	Boolean	False		Is the form visible to the end user.
Default	Boolean	False		Is the form the default form for this account.
TicketFieldIds	String	False		Ids of all ticket fields which are in this ticket form.
InAllBrands	Boolean	False		Is the form available for use in all brands on this account.
RestrictedBrandIds	String	False		Ids of all brands that this ticket form is restricted to.
FallbackToDefault	Boolean	False		If true, returns default ticket form when the criteria defined by the parameters results in a set without active and end user visible ticket forms.
AssociatedToBrand	Boolean	False		Only ticket forms of current brand (defined by url) if true.
CreatedAt	Datetime	True		The time the ticket form was created.
UpdatedAt	Datetime	True		The time of the last update of the ticket form.
AgentConditions	String	False		Array of condition sets for agent workspaces.
EndUserConditions	String	False		Array of condition sets for end user products.
Url	String	True		URL of the ticket form.

TicketMetricEvents

Queries TicketMetricEvents in Zendesk.

Table Specific Information

Select

To query ticket metric events, starting from a given time, use the following example:

SELECT * FROM TicketMetricEvents WHERE StartTime = '2017-02-05'

To get the TicketIds of deleted tickets, run this query:

GETDELETED FROM TicketMetricEvents

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	False		Automatically assigned when the record is created.
TicketId	Integer	False	Tickets.Id	The Id of the associated ticket.
Metric	String	False		One of the following: agent_work_time, pausable_update_time, periodic_update_time, reply_time, requester_wait_time, or resolution_time.
InstanceId	Long	False		The instance of the metric associated with the event.
Type	String	False		When this locale last got updated.
Time	Datetime	False		The time the event occurred.
Sla	String	False		Available if type is apply_sla. The SLA policy and target being enforced on the ticket and the metric in question, if any.
Status	String	False		Available if type is update_status. Minutes since the metric has been open. See status.
Deleted	Boolean	False		Available if type is breach. In general, you can ignore any breach event when deleted is true.

TicketMetrics

Query TicketMetrics in Zendesk.

Table Specific Information

Select

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

SELECT * FROM TicketMetrics WHERE TicketId = '123' 

SELECT * FROM TicketMetrics WHERE TicketId IN (SELECT Id FROM Tickets)

To get the TicketIds of deleted tickets run this query:

GETDELETED FROM TicketMetrics

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	False		Automatically assigned.
TicketId [KEY]	Integer	False	Tickets.Id	The ID of the associated ticket.
GroupStations	Integer	False		Number of groups this ticket passed through.
AssigneeStations	Integer	False		Number of assignees this ticket had.
Reopens	Integer	False		Total number of times the ticket was reopened.
Replies	Integer	False		Total number of times ticket was replied to.
AssigneeUpdatedAt	Datetime	False		When the assignee last updated the ticket.
RequesterUpdatedAt	Datetime	False		When the requester last updated the ticket.
StatusUpdatedAt	Datetime	False		When the status was last updated.
InitiallyAssignedAt	Datetime	False		When the ticket was initially assigned.
AssignedAt	Datetime	False		When the ticket was last assigned.
SolvedAt	Datetime	False		When the ticket was solved.
LatestCommentAddedAt	Datetime	False		When the latest comment was added.
FirstResolutionTimeCalendar	Int	False		Number of minutes to the first resolution time inside and out of business hours.
FirstResolutionTimeBusiness	Int	False		Number of minutes to the first resolution time inside and out of business hours.
ReplyTimeCalendar	Int	False		Number of minutes to the first reply inside and out of business hours.
ReplyTimeBusiness	Int	False		Number of minutes to the first reply inside and out of business hours.
FullResolutionTimeCalendar	Int	False		Number of minutes to the full resolution inside and out of business hours.
FullResolutionTimeBusiness	Int	False		Number of minutes to the full resolution inside and out of business hours.
AgentWaitTimeCalendar	Int	False		Number of minutes the agent spent waiting inside and out of business hours.
AgentWaitTimeBusiness	Int	False		Number of minutes the agent spent waiting inside and out of business hours.
RequesterWaitTimeCalendar	Int	False		Number of minutes the requester spent waiting inside and out of business hours.
RequesterWaitTimeBusiness	Int	False		Number of minutes the requester spent waiting inside and out of business hours.
CreatedAt	Datetime	False		When this record was created.
UpdatedAt	Datetime	False		When this record last got updated.
Url	String	False		The API url of this ticket metric.

Tickets

Create, update, delete, and query Tickets.

Table Specific Information

Select

The following queries are processed server side.

SELECT * FROM Tickets WHERE Id = '123'

SELECT * FROM Tickets WHERE Id IN ('123', '456')

SELECT * FROM Tickets WHERE UserId = '123'

SELECT * FROM Tickets WHERE OrganizationId = '123'

SELECT * FROM Tickets WHERE ViewId = '123'

The following ticket property keywords (columns/pseudo-columns) from the Search API are supported in the WHERE clause: created (CreatedAt), updated (UpdatedAt), due_date (DueAt), assignee, submitter, requester, via, subject, description, status, priority, ticket_type (Type), GroupId, GroupName, tags, commenter, cc, has_attachment. The supported search operators are: =, <, >, <=, >=. For example:

SELECT * FROM Tickets WHERE CreatedAt = '2017-02-15'

SELECT * FROM Tickets WHERE CreatedAt > '2017-02-15 10:15:00 AM' AND Status = 'open'

Other filters are processed client side within the Sync App. 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 Description or Comment fields are required to insert. Any other Custom Field of the ticket may be required to insert. Allowed for Agents.

INSERT INTO Tickets (Subject, Description) VALUES ('Sample Task', 'Details regarding the task.')

To insert multiple tickets, see Batch Processing for an example.

Update

You must specify the Id of the ticket to update it. All fields that are not read-only (readonly="false" in the table) are optional. Allowed for Agents.

UPDATE Tickets SET Subject = 'updated', Status = 'Open' WHERE Id = '123'

You can create a new ticket comment by updating the ticket:

UPDATE Tickets SET Comment = 'this is a new comment' WHERE Id = '123'

To make the same change to multiple tickets, use the following SQL statement:

UPDATE Tickets SET Status = 'Open' WHERE Id IN ('123', '456')

To make different changes to multiple tickets, see Batch Processing for an example.

Delete

You must specify the Id of the ticket to delete it. Allowed for Admins.

DELETE FROM Tickets WHERE Id = '123'

You can delete many tickets simultaneously by providing their ids:

DELETE FROM Tickets WHERE Id IN ('123', '456')

You can also delete many tickets simultaneously by using Batch Processing.

To get the Ids of deleted tickets run this query:

GETDELETED FROM Tickets

To delete a ticket permanently use the DeleteTicketsPermanently stored procedure.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	False		Automatically assigned when the ticket is created.
Subject	String	False		The value of the subject field for this ticket. When used in WHERE clause: The text in the ticket's subject.
RawSubject	String	False		The dynamic content placeholder, if present, or the subject value, if not.
Description	String	False		The first comment on the ticket. When used in WHERE clause: The text in the ticket's description and comments.
Type	String	False		The type of this ticket. Possible values: problem, incident, question or task.
Priority	String	False		The urgency with which the ticket should be addressed. Possible values: urgent, high, normal, low.
Status	String	False		The state of the ticket. Possible values: new, open, pending, hold, solved, closed.
Recipient	String	False		The original recipient e-mail address of the ticket.
HasIncidents	Boolean	False		Is true of this ticket has been marked as a problem, false otherwise.
DueAt	Datetime	False		If this is a ticket of type task it has a due date. Due date format uses ISO 8601 format.
RequesterId	Long	False	Users.Id	The user who requested this ticket.
SubmitterId	Long	False	Users.Id	The user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket.
AssigneeId	Long	False	Users.Id	The agent currently assigned to the ticket.
OrganizationId	String	False	Organizations.Id	The organization of the requester. You can only specify the ID of an organization associated with the requester.
GroupId	Long	False	Groups.Id	The ID of the group, to which the Ticket is assigned.
CollaboratorIds	String	False		The ids of users currently cc-ed on the ticket.
FollowerIds	String	False		Agents currently following the ticket.
ForumTopicId	Long	False	Topics.Id	The topic this ticket originated from, if any.
ProblemId	Integer	False	Tickets.Id	For tickets of type incident, the ID of the problem the incident is linked to.
ExternalId	String	False		An id you can use to link Zendesk Support tickets to local records.
FollowupIds	String	False		Closed tickets only. The ids of the followups created from this ticket.
MacroIds	String	False		POST requests only. List of macro IDs to be recorded in the ticket audit.
TicketFormId	Long	False	TicketForms.Id	Enterprise only. The id of the ticket form to render for the ticket.
BrandId	Long	False	Brands.Id	Enterprise only. The id of the brand this ticket is associated with.
Tags	String	False		The array of tags applied to this ticket.
ViaChannel	String	False		This tells you how the ticket or event was created. Examples: web, mobile, rule, system.
ViaSource	String	False		The ticket's source.
SatisfactionRating	String	False		The satisfaction rating of the ticket, if it exists, or the state of satisfaction, 'offered' or 'unoffered'.
SharingAgreementIds	String	False		The ids of the sharing agreements used for this ticket.
AllowChannelback	Boolean	False		Is false if channelback is disabled, true otherwise. Only applicable for channels framework ticket.
IsPublic	Boolean	False		Is true if any comments are public, false otherwise.
CreatedAt	Datetime	False		When this record was created.
UpdatedAt	Datetime	False		When this record last got updated.
Url	String	False		The API url of this ticket.
View_Id	Long	False	Views.Id	The view that tickets belong to.
User_Id	Long	False	Users.Id	The user that tickets belong to.
Assignee	String	False		The assigned agent or other entity. You can specify 'none', 'me', user name (full name or partial), email address, user ID, or phone number.
GroupName	String	False		The name of the group to which the Ticket is assigned. If it is not used as a query filter, a search on this column results in null.
Requester	String	False		The ticket requester. You can specify 'none', 'me', user name (full name or partial), email address, user ID, or phone number.
Submitter	String	False		The ticket submitter. This may be different than the requester if the ticket was submitted by an agent on behalf of the requester. You can specify 'none', 'me', user name (full name or partial), email address, user ID, or phone number. .
Brand	String	False		Search for a specific Brand on a ticket. If it is not used as a query filter, a search on this column results in null.
Commenter	String	False		People who have added comments to tickets. You can specify 'none', 'me', user name (full name or partial), email address, user ID, or phone number.
Cc	String	False		People who have been CC'd on tickets. You can specify 'none', 'me', user name (full name or partial), email address, user ID, or phone number.
HasAttachment	Boolean	False		Search for all tickets with or without attachments using 'true' or 'false'.
AllowAttachments	Boolean	False		Permission for agents to add add attachments to a comment. Defaults to true.
CustomStatusId	Long	False		The custom ticket status id of the ticket.
EmailCcIds	String	False		An array of objects that represent agent or end users email CCs to add or delete from the ticket.
FromMessagingChannel	Boolean	False		If true, the ticket's via type is a messaging channel.
ResultType	String	False		Result type.

Pseudo-Columns

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


Name	Type	Description
Via	String	The ticket's source, which can be any of the following:mail, api, phone, etc.
ViaFollowupSourceId	String	POST requests only. The id of a closed ticket when creating a follow-up ticket.
Solved	Date	The date the ticket was set to solved.
Comment	String	Used to create a comment on the ticket, when creating or updating a ticket.
IsPublicComment	Boolean	Used when creating a comment on the ticket. Set this to true to add a public comment and false to add an internal note.
TicketComments	String	Ticket comments object.
ReferenceNumber	String	Reference number which can be use while doing temp table insertion.

TicketSkips

Create and Query the TicketSkips in Zendesk. A skip is a record of when an agent skips over a ticket without responding to the end user. Skips are typically recorded while a play-only agent is in Guided mode.

Table Specific Information

Select

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

SELECT * FROM TicketSkips WHERE UserId = '10478855687068'
SELECT * FROM TicketSkips WHERE TicketId = '21'

Insert

The TicketId and Reason fields are required to insert. Allowed for Agents.

INSERT INTO TicketSkips (TicketId, Reason) VALUES ('22', 'This is the skipped ticket.')

To get the TicketIds of deleted tickets, run this query:

GETDELETED FROM TicketSkips

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned upon creation.
TicketId	Integer	False	Tickets.Id	ID of the skipped ticket.
UserId	Long	True	Users.Id	ID of the skipping agent.
Ticket	String	True		The skipped ticket object.
Reason	String	False		Reason for skipping the ticket.
CreatedAt	Datetime	True		Time the skip was created.
UpdatedAt	Datetime	True		Time the skip was last updated.

Tickets_Collaborators

The Collaborator id of users currently CC'ed on the ticket.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	False	Tickets.Id	Automatically assigned when the ticket is created.
CollaboratorId [KEY]	Long	False	Collaborators.Id	The ids of users currently cc-ed on the ticket.

Tickets_Followers

The ids of agents currently following the ticket.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	False	Tickets.Id	Automatically assigned when the ticket is created.
FollowerId [KEY]	Long	False	Users.Id	Agents currently following the ticket.

Tickets_Followups

The ids of the followups created from ticket.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	False	Tickets.Id	Automatically assigned when the ticket is created.
FollowupId [KEY]	Integer	False	Tickets.Id	Closed tickets only. The ids of the followups created from this ticket.

Tickets_Macros

List of macros to be recorded in the ticket audit.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	False	Tickets.Id	Automatically assigned when the ticket is created.
MacroId [KEY]	Long	False	Macros.Id	POST requests only. List of macro IDs to be recorded in the ticket audit.

Tickets_SatisfactionRatings

The satisfaction rating of the ticket, if it exists, or the state of satisfaction.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	False	Tickets.Id	Automatically assigned when the ticket is created.
SatisfactionRatingComment	String	False		Comment of satisfaction rating for the ticket.
SatisfactionRatingId	Long	False	SatisfactionRatings.Id	Id of satisfaction rating for the ticket.
SatisfactionRatingScore	String	False		Score of satisfaction rating for the ticket.

Tickets_SharingAgreements

The sharing agreements used for ticket.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	False	Tickets.Id	Automatically assigned when the ticket is created.
SharingAgreementId [KEY]	Long	False	SharingAgreements.Id	The ids of the sharing agreements used for this ticket.

Tickets_Tags

The tags applied to the ticket.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	False	Tickets.Id	Automatically assigned when the ticket is created.
Tag [KEY]	String	False		The array of tags applied to this ticket.

Tickets_Viasources

List ViaSources for the Ticket.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	False	Tickets.Id	Automatically assigned when the ticket is created.
ViaSourceFrom	String	False		The ticket's source via from.
ViaSourceRel [KEY]	String	False		The ticket's source via relation.
ViaSourceTo	String	False		The ticket's source via to.

Topics

Query, Insert, Update and Delete Topics in Zendesk.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	False		Automatically assigned when the topic is created.
Url	String	False		The API url of the topic.
HtmlUrl	String	False		The community url of the topic.
Name	String	False		The name of the topic.
Description	String	False		The description of the topic. By default an empty string.
Position	Integer	False		The position of the topic relative to other topics in the community.
FollowerCount	Integer	False		The number of users following the topic.
ManageableBy	String	False		The set of users who can manage this topic. 使用できる値は次のとおりです。staff, managers
UserSegmentId	Long	False		The id of the user segment to which this topic belongs.
CreatedAt	Datetime	False		When the topic was created.
UpdatedAt	Datetime	False		When the topic was last updated.

Translations

Create, Update, Delete and Query the Translations in Zendesk. This table is deprecated, and is being replaced by the ArticleTranslations, CategoryTranslations, and SectionTranslations tables.

Table Specific Information

Select

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

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'

Insert

To create a translation for a given source (such as an article, section, or category), the affiliated Ids of the source, as well as the 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 Translation')

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

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

Update

You must specify the affiliated id of the source and Locale for UPDATEs. 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

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


Name	Type	Description
ArticleId	Long	Id of the associated article.
SectionId	Long	Id of the associated section.
CategoryId	Long	Id of the associated category.

TriggerCategories

Create, update, delete, and query Trigger Categories in Zendesk.

Table Specific Information

Select

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

SELECT * FROM TriggerCategories WHERE Id = '10498753811996'

Insert

The Name field is required to insert.

INSERT INTO TriggerCategories (Name, Position) VALUES ('Test CData', 2)

Update

You must specify the Id of the TriggerCategory to update. All fields that are not readonly (readonly="false" in the table) are optional.

UPDATE TriggerCategories SET Name = 'Updated Test' WHERE Id = '10498983125788'

Delete

You must specify the Id of the TriggerCategory to delete it.

DELETE FROM TriggerCategories WHERE Id = '10498983125788'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Automatically assigned when creating trigger categories.
Name	String	False		The name of the trigger category.
Position	Integer	False		The position of the trigger category.
CreatedAt	Datetime	True		The time at which the trigger category was created.
UpdatedAt	Datetime	True		The time at which the trigger category was last updated.

Triggers

Create, update, delete, and query Triggers in Zendesk.

Table Specific Information

Select

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

SELECT * FROM Triggers WHERE Id = '123'

SELECT * FROM Triggers WHERE Active = true

SELECT * FROM Triggers ORDER BY Position

SELECT * FROM Triggers ORDER BY CreatedAt

SELECT * FROM Triggers ORDER BY UpdatedAt

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

INSERT INTO Triggers (Title, ConditionsAll, Actions) VALUES ('Roger Wilco', '[{ \"field\": \"status\", \"operator\": \"is\", \"value\": \"open\" }, { \"field\": \"priority\", \"operator\": \"less_than\", \"value\": \"high\" }]', '[{ \"field\": \"group_id\", \"value\": \"20455932\" }]')

Update

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

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

Delete

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

DELETE FROM Triggers WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when created.
Title	String	False		The title of the trigger.
Active	Boolean	False		Whether the trigger is active.
Position	Integer	False		Position of the trigger, determines the order they will execute in.
ConditionsAll	String	False		An object that describes the conditions under which the trigger will execute.
ConditionsAny	String	False		An object that describes the conditions under which the trigger will execute.
Actions	String	False		An object describing what the trigger will do.
Description	String	False		The description of the trigger.
CreatedAt	Datetime	True		The time the trigger was created.
UpdatedAt	Datetime	True		The time of the last update of the trigger.

UserFields

Create, update, delete, and query User Fields.

Table Specific Information

Select

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

SELECT * FROM UserFields WHERE Id = '123'

Insert

The Type, Title, and Key fields are required to insert. Types of custom fields that can be created are: text (default when no Type is specified), textarea, checkbox, tagger (dropdown), date, integer, decimal, and regex. When Type is regex, RegexpForValidation is also required. When Type is tagger, CustomFieldOptions is also required. Allowed for admins.

Understand the following behavior when creating a dropdown field:

To create a new option, pass a null Id along with name and value.

    INSERT INTO UserFields (Type, Title, Key) VALUES ('text', 'Support description', 'support_description')

    INSERT INTO UserFields (Type, Title, Key, RegexpForValidation) VALUES ('regexp', 'TestRegExp', 'test_regexp', '\\b([0-9]{4})-(1[0-2]|0?[1-9])-(3[0-1]|[1-2][0-9]|0?[1-9])\\b')

    INSERT INTO UserFields (Type, Title, Key, CustomFieldOptions) VALUES ('tagger', 'TestDropdown', 'test_dropdown', '[{"id": null, "name": "Option 1", "value": "option_1"}, {"id": null, "name": "Option 2", "value": "option_2"}, {"id": null, "name": "Option 3", "value": "option_3"}]')

You can also create Lookup Relationships. A lookup relationship field is a custom field whose type is "lookup". This type of custom field gives you the ability to create a relationship from a source object to a target object. To create lookup relationship fields, Type, Key and RelationshipTargetType columns are required. The Type column value must be "lookup". A suitable combination of Field, Operator and Value is required for insertion in RelationshipFilterAll and RelationshipFilterAny. Here is a list of the possible combinations: "https://developer.zendesk.com/documentation/ticketing/reference-guides/conditions-reference/#shared-conditions".

INSERT INTO UserFieldsRelationshipFilterAll#temp(Field, Operator, Value) VALUES ('status', 'less_than', 'solved')
INSERT INTO UserFieldsRelationshipFilterAny#temp(Field, Operator, Value) VALUES ('status', 'less_than', 'solved')
INSERT INTO UserFields (Type, Title, Key, RelationshipTargetType, RelationshipFilterAll, RelationshipFilterAny) VALUES ('lookup', 'Support description', 'support_description5', 'zen:ticket', 'UserFieldsRelationshipFilterAll#temp', 'UserFieldsRelationshipFilterAny#temp')

Update

You must specify the Id of the ticket field to update. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for admins.

Understand the following behavior when updating a dropdown field:

To update an existing option, pass its Id along with name and value.
All options must be passed on update. Options that are not passed will be removed; as a result, these values will be removed from any users.
To reorder an option, reposition it in the CustomFieldOptions array relative to the other options.
To remove an option, omit it from the list of options upon update.

UPDATE UserFields SET Title = 'Support description' WHERE Id = '123'

For ticket fields of type tagger (dropdown) use the CustomFieldOptions column to update the options. For type regexp use RegexpForValidation to update the regular expression.

Delete

You must specify the Id of the user field to delete it. Allowed for admins.

DELETE FROM UserFields WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned upon creation.
Key	String	False		A unique key that identifies this custom field. Required on create.This is used for updating the field and referencing in placeholders.After a field is created, you cannot change its key.
Type	String	False		Type of the custom field: checkbox, date, decimal, dropdown, integer, regexp, text, or textarea. After a field is created, you cannot change its type.
Title	String	False		The title of the custom field.
RawTitle	String	False		The dynamic content placeholder, if present, or the title value, if not.
Description	String	False		User-defined description of this field's purpose.
RawDescription	String	False		The dynamic content placeholder, if present, or the description value, if not.
Position	Integer	False		Ordering of the field relative to other fields.
Active	Boolean	False		If true, this field is available for use.
System	Boolean	True		If true, only active and position values of this field can be changed.
RegexpForValidation	String	False		Regular expression field only. The validation pattern for a field value to be deemed valid.
CreatedAt	Datetime	True		The time the ticket field was created.
UpdatedAt	Datetime	True		The time of the last update of the ticket field.
Tag	String	False		Optional for custom field of type checkbox; not presented otherwise.
CustomFieldOptions	String	False		Required and presented for a custom field of type dropdown.
Url	String	True		The URL for this resource.
RelationshipTargetType	String	False		A representation of what type of object the field references. Options are zen:user, zen:organization, zen:ticket, and zen:custom_object:CUSTOM_OBJECT_KEY. For example: zen:custom_object:apartment.
RelationshipFilterAll	String	False		A filter definition that allows your autocomplete to filter down results with Logical AND.
RelationshipFilterAny	String	False		A filter definition that allows your autocomplete to filter down results with Logical OR.

UserIdentities

Create, update, delete, and query User Identities.

Table Specific Information

Select

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

SELECT * FROM UserIdentities WHERE UserId = '123'

SELECT * FROM UserIdentities WHERE UserId = '123' AND Id = '345'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Insert

The Type, Value, and UserId fields are required to insert. Allowed for agents.

INSERT INTO UserIdentities (Type, Value, UserId) VALUES ('email', '[email protected]', '123')

Update

You must specify the Id of the identity and UserId to update. Allowed for agents. Update allows you to do the following: Set the specified identity as verified (but you cannot unverify a verified identity). Note: Primary should be true.

UPDATE UserIdentities SET Verified = true WHERE UserId = '123' AND Id = '456'

Update the value of the specified identity:

UPDATE UserIdentities SET Value = '[email protected]' WHERE UserId = '123' AND Id = '456'

Delete

You must specify the Id of the identity and UserId to delete an user identity. Users must have at least one identity after deletion. Allowed for agents.

DELETE FROM UserIdentities WHERE UserId = '123' AND Id = '456'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned on creation.
UserId [KEY]	Long	False	Users.Id	The id of the user.
Type	String	False		One of email, twitter, facebook, google, or phone_number.
Value	String	False		The identifier for this identity, such as an email address.
Verified	Boolean	False		If the identity has been verified.
Primary	Boolean	True		If the identity is the primary identity. Writable only when creating, not when updating.
CreatedAt	Datetime	True		The time the ticket field was created.
UpdatedAt	Datetime	True		The time of the last update of the ticket field.
UndeliverableCount	Integer	True		The time of the last update of the ticket field.
DeliverableState	String	True		The time of the last update of the ticket field.
Url	String	True		The URL for this resource.

Users

Create, update, delete, and query Users in Zendesk.

Table Specific Information

Select

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

SELECT * FROM Users WHERE Id = '123'

SELECT * FROM Users WHERE Id IN ('123', '456')

SELECT * FROM Users WHERE GroupId = '123'

SELECT * FROM Users WHERE OrganizationId = '123'

SELECT * FROM Users WHERE Role = 'agent'

SELECT * FROM Users WHERE PermissionSet = 'roleid'

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 field is required to insert. Allowed for agents, with restrictions on certain actions.

INSERT INTO Users (Name, Email) VALUES ('Roger Wilco', '[email protected]')

To insert multiple users, see Batch Processing for an example.

If you need to create agents with a specific role, the Role parameter only accepts three possible values: "end-user", "agent", and "admin". Therefore, set the Role to "agent" as well as add a new parameter called "custom_role_id" and give it the actual desired role Id from your Zendesk Support account. This applies to the built-in "light-agent" role of Zendesk Support as well.

INSERT INTO Users (Name, Email, Role, CustomRoleId) VALUES ('Roger Wilco', '[email protected]', 'agent', '123456')

The user can also be added to a named organization.

INSERT INTO Users (Name, Email, Organization) VALUES ('Roger Wilco', '[email protected]', 'VIP Customers')

Update

You must specify the Id of the user to update. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for agents, with restrictions on certain actions. Agents can only update end users. Administrators can update end users, agents, and administrators.

UPDATE Users SET Name = 'Roger Wilco II' WHERE Id = '123'

To make the same change to multiple users, use the following SQL statement:

UPDATE Users SET OrganizationId = '1' WHERE Id IN ('123', '456')

To make different changes to multiple users, see Batch Processing for an example.

Delete

You must specify the Id of the user to delete it. Allowed for agents, with restrictions on certain actions.

DELETE FROM Users WHERE Id = '123'

You can delete many tickets simultaneously by providing their Ids:

DELETE FROM Users WHERE Id IN ('123', '456')

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the ticket is created.
Email	String	False		The primary email address of the user. Writeable on create only. On update, a secondary email is added.
Name	String	False		The name of the user.
Role	String	False		The role of the user. Possible values are end-user, agent, or admin.
Active	Boolean	True		False if the user has been deleted.
OrganizationId	Long	False	Organizations.Id	The id of the organization the user is associated with.
Alias	String	False		An alias displayed to end users.
Verified	Boolean	False		If the identity of the user has been verified or not.
ChatOnly	Boolean	True		Whether or not the user is a chat-only agent.
CreatedAt	Datetime	True		The time the user was created.
UpdatedAt	Datetime	True		The time the user was last updated.
CustomRoleId	Long	False		A custom role if the user is an agent on the Enterprise plan.
RoleType	String	True		The role id of the user. 0 for custom agents, 1 for light agent and 2 for chat agent.
DefaultGroupId	Long	False		The id of the default group of the user. Can only be set on create, not on update.
Details	String	False		Any details you want to store about the user, such as an address.
ExternalId	String	False		A unique identifier from another system.
LastLoginAt	Datetime	True		The last time the user signed in to Zendesk Support.
Locale	String	True		The locale of the user.
LocaleId	Long	False		The language identifier of the user.
Moderator	Boolean	False		Designates whether the user has forum moderation capabilities.
Notes	String	False		Any notes you want to store about the user.
OnlyPrivateComments	Boolean	False		True if the user can only create private comments.
Phone	String	False		The primary phone number of the user.
Photo	String	True		photo attachment.
PhotoThumbnails	String	True		photo thumbnails.
PhotoInline	Boolean	True		If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false.
RestrictedAgent	Boolean	False		If the agent has any restrictions; false for admins and unrestricted agents, true for other agents.
Shared	Boolean	True		If the user is shared from a different Zendesk Support instance. Ticket sharing accounts only.
SharedAgent	Boolean	True		If the user is a shared agent from a different Zendesk Support instance. Ticket sharing accounts only.
Signature	String	False		The signature of the user. Only agents and admins can have signatures.
Suspended	Boolean	False		If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal.
Tags	String	False		The tags of the user. Only present if your account has user tagging enabled.
TicketRestriction	String	False		Specifies which tickets the user has access to. Possible values are: organization, groups, assigned, requested, null.
TimeZone	String	False		The time zone of the user.
TwoFactorAuthEnabled	Boolean	True		If two factor authentication is enabled.
Url	String	False		The API url of the user.
GroupName	String	False
Organization	String	False		The name of the organization the user is associated with.
GroupId	String	False		The name of the group the user belongs to.
PermissionSet	String	False		Used for custom roles in the Enterprise plan. You can only filter by one role id per request.

UserSegments

Create, Update, Delete and Query the User Segments in Zendesk. A user segment defines who can view the content of a section or topic.

Table Specific Information

Select

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

SELECT * FROM UserSegments WHERE Id = '19236906991121'
SELECT * FROM UserSegments WHERE UserId = '19128124956177'

Insert

The Name and UserType columns are required to insert. All fields that are not readonly (readonly="false" in the table) are optional for insert. Allowed for Help Center managers.

INSERT INTO UserSegments (Name, OrTags, UserType, GroupIds, Tags) VALUES ('Test', 'abcd', 'staff', '19236839815825;19236761830161', 'vip;test')

Update

You must specify the Id of the UserSegment to update. All fields that are not readonly (readonly="false" in the table) are optional for insert. Allowed for Help Center managers.

UPDATE UserSegments SET Name = 'UpdatedName' WHERE Id = '19236906991121'

Delete

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

DELETE FROM UserSegments WHERE Id = '19236906991121'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the user segment is created.
BuiltIn	Boolean	True		Whether the user segment is built-in. Built-in user segments cannot be modified.
Name	String	False		User segment name (localized to the locale of the current user for built-in user segments).
OrTags	String	False		A user must have at least one tag in the list to have access. For insertion and updation provide these values separated by semicolon.
GroupIds	String	False		The ids of the groups that have access. For insertion and updation provide these values separated by semicolon.
OrganizationIds	String	False		The ids of the organizations that have access. For insertion and updation provide these values separated by semicolon.
Tags	String	False		All the tags a user must have to have access. For insertion and updation provide these values separated by semicolon.
UserType	String	False		The set of users who can view content. The UserType can be 'signed_in_users' for only authenticated users and 'staff' for only agents and Help Center managers.
CreatedAt	Datetime	True		When the user segment was created.
UpdatedAt	Datetime	True		When the user segment was last updated.

Pseudo-Columns

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


Name	Type	Description
UserId	Long	Id of the User.

Views

Create, update, delete and query views in Zendesk.

Table Specific Information

Select

The following queries are processed server-side while other filters are processed client-side by the Sync App. Allowed for agents.

SELECT * FROM Views WHERE Id = '123'

SELECT * FROM Views WHERE GroupId = '123'

SELECT * FROM Views WHERE Access = 'Shared'

SELECT * FROM Views WHERE Active = true

SELECT * FROM Views ORDER BY CreatedAt

SELECT * FROM Views ORDER BY UpdatedAt

SELECT * FROM Views WHERE Id in (18578482641937, 18578439448081)

Insert

The Title and ConditionsAll columns are required to insert. A suitable combination of Field, Operator and Value is required for insertion in ConditionsAll and ConditionsAny. Here is a list of the possible combinations: "https://developer.zendesk.com/documentation/ticketing/reference-guides/conditions-reference/". Allowed for agents.

INSERT INTO ViewsConditionsAll#temp(Field, Operator, Value) VALUES('status', 'less_than', 'solved')
INSERT INTO ViewsConditionsAny#temp(Field, Operator, Value) VALUES('assignee_id', 'is', '18211830670225')
INSERT INTO Views(Title,ConditionsAll, ConditionsAny, ExecutionColumns, ExecutionGroupBy, ExecutionGroupOrder, ExecutionSortBy, ExecutionSortOrder) VALUES('Test title', 'ViewsConditionsAll#temp', 'ViewsConditionsAny#temp', 'status;requester;asignee', 'asignee', 'desc', 'status', 'desc')

Update

You must specify the Id of the view to update it. ConditionsAll and ConditionsAny aggregate columns support duplicate values in the object, so in order to update these fields, you must specifty the whole aggregate object. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for agents.

INSERT INTO ViewsConditionsAll#temp(Field, Operator, Value) VALUES('status', 'less_than', 'solved')
INSERT INTO ViewsConditionsAny#temp(Field, Operator, Value) VALUES('assignee_id', 'is', '18211830670225')
UPDATE Views SET Title='Updated Title', ConditionsAll='ViewsConditionsAll#temp', ConditionsAny='ViewsConditionsAny#temp' WHERE Id='18551415691665'

To update multiple Views.

INSERT INTO Views#temp(Id, Position) VALUES(18578482641937, 5)
INSERT INTO Views#temp(Id, Position) VALUES(18578439448081, 6)
UPDATE VIEWS(Id, Position) Select Id, Position FROM Views#temp

Delete

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

DELETE FROM Views WHERE Id = '123'

To delete multiple Views.

INSERT INTO Views#temp(Id) VALUES(18578482641937)
INSERT INTO Views#temp(Id) VALUES(18578439448081)
DELETE FROM Views WHERE EXISTS Select Id FROM Views#temp

Note: There is a limitation on the API side in the case of Bulk Update and Bulk Delete. When you try to update or delete multiple records with at least one invalid Id, the API will throw a 404 not found exception. Due to this limitation, the LastResultInfo#temp for this table shows an empty resultset.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the ticket is created.
Title	String	False		The title of the view.
Active	Boolean	False		Useful for determining if the view should be displayed.
SlaId	Long	False	SlaPolicies.Id	If the view is for an SLA, shows the id.
RestrictionId	Long	True		The id of the restricion (who may access this account. Will be null when everyone in the account can access it).
RestrictionType	String	False		The type of the restricion (who may access this account. Will be null when everyone in the account can access it).
RestrictionIds	String	False		The numeric IDs of a single or more groups. Recommended for 'Group' type.
Position	Integer	False		The position of the view.
ExecutionGroupBy	String	False		Group the tickets by a column in the View columns table. The subject and submitter columns are not supported.
ExecutionGroupOrder	String	False		Group the tickets by a column in the View columns table either by specifying asc or desc.
ExecutionSortBy	String	False		Sort the tickets by a column in the View columns table. The subject and submitter columns are not supported.
ExecutionSortOrder	String	False		Sort the tickets by a column in the View columns table either by specifying asc or desc.
ExecutionGroup	String	False		When present, the structure indicating how the tickets are grouped.
ExecutionSort	String	False		The column structure of the field used for sorting.
ExecutionColumns	String	False		The ticket fields to display. For Insert, give the list of value separated by semi-colon.
ExecutionFields	String	False		Execution is an object describing how the view should be executed.
ExecutionCustomFields	String	False		Execution is an object describing how the view should be executed.
ConditionsAll	String	False		Logical AND. Tickets must fulfill all of the conditions to be considered matching.Conditions is an object describing how the view is constructed.
ConditionsAny	String	False		Logical OR. Tickets may satisfy any of the conditions to be considered matching.Conditions is an object describing how the view is constructed.
CreatedAt	Datetime	True		The time the view was created.
UpdatedAt	Datetime	True		The time of the last update of the view.
Access	String	False		Only views with given access. May be personal, shared, or account.
GroupId	Long	False	Groups.Id	The group id the view belongs to. Used to query the table.
Default	Boolean	False		If true, the view is a default view.
Description	String	False		The description of the view.
RawTitle	String	False		The raw title of the view.
Url	String	True		Url.

Votes

Create, Delete and Query the Votes in Zendesk. Votes represents positive and negative opinions of users about articles, article comments, posts or post comments.

Table Specific Information

Select

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

SELECT * FROM Votes WHERE UserId = '19128124956177'
SELECT * FROM Votes WHERE ArticleId = '19206579478289'
SELECT * FROM Votes WHERE Locale = 'en-us' AND ArticleId = '19206579478289'
SELECT * FROM Votes WHERE ArticleId = '19206579478289' AND CommentId = '19244072685969'
SELECT * FROM Votes WHERE Locale = 'en-us' AND ArticleId = '19206579478289' AND CommentId = '19244072685969'
SELECT * FROM Votes WHERE PostId = '19206579516945'
SELECT * FROM Votes WHERE PostId = '19206579516945' AND CommentId = '19244379733521'

Insert

The Value field is required to insert. Allowed for End-users.

To create a vote for a given Article:

INSERT INTO Votes (ArticleId, Value) VALUES ('19206579478289', 1)

To create a vote for a given Article comment:

INSERT INTO Votes (ArticleId, CommentId, Value) VALUES ('19206579478289', '19244072685969', 1)

To create a vote for a given Post:

INSERT INTO Votes (PostId, Value) VALUES ('19206579516945', -1)

To create a vote for a given Post Comment:

INSERT INTO Votes (PostId, CommentId, Value) VALUES ('19206579516945', '19244379733521', -1)

Delete

You must specify the Id of the Vote to delete it. Allowed for Agents and End-users.

DELETE FROM Votes WHERE Id = '19243214837905'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the vote is created.
UserId	Long	True	Users.Id	The id of the user who cast this vote.
ItemId	Long	True		The id of the item for which this vote was cast.
ItemType	String	True		The type of the item. Can be Article, Comment, Post or PostComment.
Value	Integer	False		The value of the vote. Specify 1 for up and -1 for down. 使用できる値は次のとおりです。1, -1
Url	String	True		The ids of user segments that have edit privileges. For insertion and updation provide these values separated by semicolon.
CreatedAt	Datetime	True		The time at which the vote was created.
UpdatedAt	Datetime	True		The time at which the vote was last updated.

Pseudo-Columns

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


Name	Type	Description
Locale	String	The locale value.
ArticleId	Long	The Id of the Article.
CommentId	Long	The Id of the Article Comment or Post Comment.
PostId	Long	The Id of the Post.

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

Zendesk Connector for CData Sync ビュー


Name	Description
AccessLogs	Query access logs in Zendesk.
ActivityStream	Query ActivityStreams in Zendesk.
AppLocations	Query AppLocations in Zendesk.
Apps	Query Apps in Zendesk.
Attachments	Show ticket attachments in Zendesk.
AuditLogs	Query audit logs in Zendesk.
Calls	A complete list of information on inbound and outbound calls from your Zendesk Talk instance.
Collaborators	Query Collaborators in Zendesk.
CustomObjectField	The view specifies all the attributes of a custom object property.
JobStatus	A status record is created when somebody kicks off a job such as updating multiple tickets. You can access the job status data for an hour after a particular job is created, after which the data is no longer available.
Locales	Query Locales in Zendesk.
MonitoredTwitterHandles	Query Monitored Twitter handles in Zendesk.
OrganizationFieldsRelationshipFilterAll	Query OrganizationFields RelationshipFilterAll Filter with Logical AND.
OrganizationFieldsRelationshipFilterAny	Query OrganizationFields RelationshipFilterAny Filter with Logical OR.
Requests	Query Requests in Zendesk.
Requests_Collaborators	The Collaborator ids of users currently CC'ed on the ticket.
ResourceCollections	Query Resource Collections in Zendesk.
SatisfactionReasons	Query the Satisfaction Reasons in Zendesk.
SideConversationEvents	Query Side Conversations events in Zendesk. The messages that make up a side conversation are recorded as events.
SideConversationEventsMessage	Query Side Conversations events message in Zendesk.
SideConversationEventsMessageTo	Query the list of participants, the message was sent to.
SideConversationParticipants	Query Side Conversation Participants in Zendesk.
SlaPoliciesFilterAll	Query SlaPolicies Filter with Logical AND.
SlaPoliciesFilterAny	Query SlaPolicies Filter with Logical OR.
SlaPoliciesMetrics	Query SlaPoliciesMetrics that describes the metric targets for each value of the priority field.
TargetFailures	Query Target failures in Zendesk.
TicketEmailCCs	Query any users cc'd on the ticket in Zendesk.
TicketFieldsRelationshipFilterAll	Query TicketFields RelationshipFilterAll Filter with Logical AND.
TicketFieldsRelationshipFilterAny	Query TicketFields RelationshipFilterAny Filter with Logical OR.
TicketRelatedInformation	Query Ticket related information in Zendesk.
UserEvents	Query events for a given Zendesk user.
UserFieldsRelationshipFilterAll	Query UserFields RelationshipFilterAll Filter with Logical AND.
UserFieldsRelationshipFilterAny	Query UserFields RelationshipFilterAny Filter with Logical OR.
UserRelatedInformation	Query UserRelatedInformation in Zendesk.
UserSubscriptions	Query the user subscriptions in Zendesk.
ViewsConditionsAll	Query views conditions with logical AND.
ViewsConditionsAny	Query views conditions with logical OR.

AccessLogs

Query access logs in Zendesk.

Table Specific Information

Select

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

SELECT * FROM AccessLogs

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.

Columns


Name	Type	References	Description
Id [KEY]	String		Unique identifier for the access log.
UserId	Long		ID of the user who made the request.
Status	Integer		HTTP status code of the response.
Method	String		HTTP method of the request. Possible values: GET, POST, PUT, DELETE.
IpAddress	String		IP address of the user who made the request.
Timestamp	Datetime		ISO 8601 formatted string representing the time of the request.
Url	String		URL of the request.
Graphql	String		Optional details if the request was a GraphQL query.

ActivityStream

Query ActivityStreams in Zendesk.

Table Specific Information

Select

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

SELECT * FROM ActivityStream WHERE Id = '123'

SELECT * FROM ActivityStream WHERE Since = '2017-02-15 10:15:25'

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.

Columns


Name	Type	References	Description
Id [KEY]	Long		Automatically assigned upon creation.
Title	String		Description of this activity.
Verb	String		The type of activity. Can be tickets.assignment, tickets.comment, or tickets.priority_increase.
UserId	Long	Users.Id	The user this activity pertains to.
ActorId	Long	Users.Id	The user this activity pertains to.
CreatedAt	Datetime		When this locale was created.
UpdatedAt	Datetime		When this locale last got updated.
Url	String		The API url of this activity.

AppLocations

Query AppLocations in Zendesk.

Table Specific Information

Select

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

SELECT * FROM AppLocations WHERE Id = '123'

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.

Columns


Name	Type	References	Description
Id [KEY]	Long		Internal location ID.
Name	String		The unique location key.
ProductCode	Integer		Internal product ID.
HostApplication	String		The unique host application key.
Orderable	Boolean		True if reordering has any effect.

Apps

Query Apps in Zendesk.

Table Specific Information

Select

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

SELECT * FROM Apps
SELECT * FROM Apps WHERE Id = 1

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.

Columns


Name	Type	References	Description
Id [KEY]	Integer		The id of the app.
Name	String		The name of the app.
State	String		Publication state for the app on the Zendesk Marketplace.
Version	String		The version of the app.
FrameworkVersion	String		The app framework version for which the app was written.
Parameters	String		The parameters for the app.
Plans	String		Payment plans for the app.
RatingTotalCount	Integer		Total count of the ratings of the app.
RatingAvergae	Integer		Average rating of the app.
RatingCount	String		Rating count of the app.
SingleInstall	Boolean		Whether or not this app can only be installed once.
DefaultLocale	String		The default locale for translations for the app.
FeatureColor	String		Hexadecimal color value used to feature the app on the Zendesk Marketplace.
GoogleAnalyticsCode	String		Universal Google Analytics (UA-) tracking id for the app's detail page on the Zendesk Marketplace.
RemoteInstallationUrl	String		URL for the app's installation instructions.
Products	String		Zendesk products supported by the app.
Categories	String		Zendesk Marketplace categories to which the app belongs.
Collections	String		Zendesk Marketplace collections to which the app belongs.
StripePublishableKey	String		Publishable key for the app developer's Stripe account.
CreatedAt	Datetime		When the app was created.
UpdatedAt	Datetime		When the app was last updated.
TermsConditionsUrl	String		URL for the app's terms and conditions.
AppOrganizationId	Integer		Organization Id that submitted the app to the Zendesk Marketplace.
AppOrganizationName	String		Organization name that submitted the app to the Zendesk Marketplace.
AppOrganizationEmail	String		Organization email that submitted the app to the Zendesk Marketplace.
AppOrganizationWebsite	String		Organization website that submitted the app to the Zendesk Marketplace.
AppOrganizationCountryCode	String		Organization country code that submitted the app to the Zendesk Marketplace.
AppOrganizationStripeAccountId	String		Organization Stripe account id that submitted the app to the Zendesk Marketplace.
Locations	String		Location ids for the app.
DatePublished	Datetime		When the app was published on the Zendesk Marketplace.
HasThirdPartyPricing	Boolean		Third-party pricing information for the app.
ThirdPartyPricingUrl	String		Third-party pricing url for the app.
OwnerId	Long		The app developer id corresponding to the app.
AuthorName	String		The app author's name.
AuthorEmail	String		The app author's email.
AuthorUrl	String		The app author's URL.
ShortDescription	String		The short description of the app in the Zendesk Marketplace.
LongDescription	String		The app's long description in the Zendesk Marketplace.
InstallationInstructions	String		Instructions for installing the app.
RawLongDescription	String		The raw long description for the app in the Zendesk Marketplace.
RawInstallationInstructions	String		The raw installation instructions.
Visibility	String		The app is a private app, which is only visible to your account, or a public app. An example value is 'private'.
Promoted	Boolean		Whether or not the app is a promoted app in the Zendesk Marketplace.
Featured	Boolean		Whether or not the app is featured in the Zendesk Marketplace.
Paid	Boolean		If true, the app is a paid app.
Deprecated	Boolean		If true, the app is deprecated.
Obsolete	Boolean		If true, the app is obsolete.
Installable	Boolean		Whether or not the app can be installed.
MarketingOnly	Boolean		If true, the app is an integration app.
SmallIcon	String		The url for the small logo for the app.
LargeIcon	String		The large icon url for an app.
Screenshots	String		Screenshots for the app when displayed in the Zendesk Marketplace.
InstallationCount	Integer		Current number of installations of the app.

Pseudo-Columns

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


Name	Type	Description
Owned	Boolean		Boolean value that needs to be set when you want to lists the apps owned by the current account.

Attachments

Show ticket attachments in Zendesk.

Table Specific Information

Select

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

SELECT * FROM Attachments WHERE TicketId = '123'
 
SELECT * FROM Attachments WHERE AttachmentId = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns


Name	Type	References	Description
AttachmentId [KEY]	Long		Automatically assigned when the ticket is created.
TicketId	Integer	Tickets.Id	The id of the ticket the comment belongs to.
CommentId	Long	TicketComments.Id	The id of the comment the attachment belongs to.
FileName	String		The name of the form.
ContentUrl	String		A full URL where the attachment image file can be downloaded.
ContentType	String		The content type of the image.
Size	Integer		The size of the image file in bytes.
Inline	Boolean		If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false.

Pseudo-Columns

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


Name	Type	Description
UpdatedAt	Datetime		The time of the attachment was updated.

AuditLogs

Query audit logs in Zendesk.

Table Specific Information

Select

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

SELECT * FROM AuditLogs
SELECT * FROM AuditLogs WHERE Id = '13963723114908'

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.

Columns


Name	Type	References	Description
Id [KEY]	Long		The id automatically assigned upon creation.
ActorId	Long		Id of the user or system that initiated the change.
SourceId	Long		The id of the item being audited.
ActorName	String		Name of the user or system that initiated the change.
ActionLabel	String		Localized string of action field.
SourceType	String		Item type being audited.
SourceLabel	String		The name of the item being audited.
Action	String		Type of change made. Possible values are create, destroy, exported, login, and update.
ChangeDescription	String		The description of the change that occurred.
IpAddress	String		The IP address of the user doing the audit.
CreatedAt	Datetime		The time the audit got created.
Url	String		The URL to access the audit log.

Calls

A complete list of information on inbound and outbound calls from your Zendesk Talk instance.

Table Specific Information

Select

The Sync App will use the Zendesk API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Sync App.

StartTime supports the '=' comparison.

For example, the following queries are processed server side.

SELECT * FROM Calls WHERE starttime = '2022-09-01'

Columns


Name	Type	References	Description
Id	Long		Call id.
AgentId	Long		The id of the first agent who picked up the call.
CallCharge	String		Total charge for the call. String representation of a decimal number with six decimal places.
CallGroupId	Long		The id number of the group the call was last placed in before completion.
CallRecordingConsent	String		Call recording consent value configured for the phone number. Allowed values are always, opt_in, opt_out or never.
CallRecordingConsentAction	String		Call recording consent option selected by the caller. Allowed values are caller_opted_in, caller_opted_out or null.
CallRecordingConsentKeypress	String		Keypress the caller chose to give their call recording consent option. Allowed values are 3 or null.
Callback	Boolean		True if the call was initiated by a callback request from the customer.
CallbackSource	String		The source of the callback request. Allowed values are null, queue or web_widget.
CompletionStatus	String		Status of the call. Allowed values are completed, abandoned_in_queue, abandoned_in_ivr, abandoned_in_voicemail, abandoned_on_hold or pending_voicemail.
ConsultationTime	String		Sum of how long in seconds agents consulted with each other while the customer was on hold.
CreatedAt	Datetime		When the call object was created.
CustomerId	Long		Customer Id.
CustomerRequestedVoicemail	Boolean		The customer requested to be directed to voicemail instead of waiting for an agent to answer.
DefaultGroup	Boolean		The call was answered by an agent who is a member of the calls default group, if group routing is used.
Direction	String		Inbound or outbound. The agent or customer who initialized the call.
Duration	Integer		Call duration in seconds.
ExceededQueueWaitTime	Boolean		The customer exceeded the maximum queue wait time and did not speak with an agent.
HoldTime	Integer		Sum of how long in seconds the customer was placed on hold by an agent(s).
IvrAction	String		Menu action that was used by the caller in the IVR menu selection. Possible values: null (if IVR is not used), menu, voicemail, group, phone_number, textback, invalid (returned for an invalid keypress).
IvrDestinationGroupName	String		Name of the group that received the call through IVR routing. null if IVR is disabled.
IvrHops	Integer		How many menu options the customer went through in IVR before talking to an agent. null if IVR is disabled.
IvrRoutedTo	String		Phone number where call was routed to by IVR. Example: +1311123456789. null if IVR is disabled.
IvrTimeSpent	Integer		How long in seconds the customer spent in IVR. Null if IVR is disabled.
MinutesBilled	Integer		Minutes billed.
Line	String		Line.
LineId	Long		Line Id.
NotRecordingTime	Integer		How long in seconds spent not recording on the call.
OutsideBusinessHours	Boolean		The call was received outside business hours.
Overflowed	Boolean		True if the call overflowed.
OverflowedTo	String		The phone number that the call overflowed to. null if overflowed is false.
PhoneNumber	String		Talk phone associated with the call. If this a digital line, the digital line nickname. Example: +1311123456789.
PhoneNumberId	Integer		Talk phone number id.
QualityIssues	String		A summary of the call's quality issues related to the call provided to Zendesk from Twilio. Until the information is made available by Twilio, the array contains information_not_available. If there are no issues, the array contains none. Other possible values: one or more of silence, high_jitter, high_packet_loss, high_pdd, high_latency.
RecordingControlInteractions	Integer		The amount of times agents have paused or resumed a recording on the call.
RecordingTime	Integer		How long in seconds spent recording on the call.
TalkTime	Integer		Sum of how long in seconds the customer was in conference with an agent(s). If a call is not accepted by an agent this will be 0.
TicketId	Integer		The id of the ticket related to the call.
TimeToAnswer	Integer		How long in seconds the customer waited for an agent to answer after hearing the Available agents greeting.
UpdatedAt	Datetime		When the call object was last created.
Voicemail	Boolean		If true, the call was a voicemail.
WaitTime	Integer		How long in seconds the customer was in the call before an agent answered.
WrapUpTime	Integer		Sum of how long in seconds the agent(s) spent in wrap up.

Pseudo-Columns

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


Name	Type	Description
StartTime	Datetime		Start Time.

Collaborators

Query Collaborators in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Sync App:

SELECT * FROM Collaborators WHERE TicketId = '123'

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.

Columns


Name	Type	References	Description
Id [KEY]	Long		Automatically assigned when the ticket is created.
TicketId [KEY]	Integer	Tickets.Id	The id of the ticket.
Email	String		The primary email address of the collaborator. Writeable on create only. On update, a secondary email is added.
Name	String		The name of the collaborator.
Role	String		The role of the collaborator. Possible values are end-collaborator, agent, or admin.
Active	Boolean		False if the collaborator has been deleted.
OrganizationId	Long	Organizations.Id	The id of the organization the collaborator is associated with.
Alias	String		An alias displayed to end users.
Verified	Boolean		If the identity of the collaborator has been verified or not.
ChatOnly	Boolean		Whether or not the collaborator is a chat-only agent.
CreatedAt	Datetime		The time the collaborator was created.
UpdatedAt	Datetime		The time the collaborator was last updated.
CustomRoleId	Long	CustomAgentRoles.Id	A custom role if the collaborator is an agent on the Enterprise plan.
RoleType	String		The role id of the collaborator. 0 for custom agents, 1 for light agent and 2 for chat agent.
DefaultGroupId	Long	Groups.Id	The id of the default group of the collaborator. Can only be set on create, not on update.
Details	String		Any details you want to store about the collaborator, such as an address.
ExternalId	String		A unique identifier from another system.
LastLoginAt	Datetime		The last time the collaborator signed in to Zendesk Support.
Locale	String		The locale of the collaborator.
LocaleId	Long	Locales.Id	The language identifier of the collaborator.
Moderator	Boolean		Designates whether the collaborator has forum moderation capabilities.
Notes	String		Any notes you want to store about the collaborator.
OnlyPrivateComments	Boolean		True if the collaborator can only create private comments.
Phone	String		The primary phone number of the collaborator.
PhotoId	Long		Automatically assigned when the attachment is created.
PhotoFileName	String		The name of the image file.
PhotoContentUrl	String		A full URL where the attachment image file can be downloaded.
PhotoContentType	String		The content type of the image. Example value: image/png.
PhotoSize	Integer		The size of the image file in bytes.
PhotoThumbnailsId	Long		.
PhotoThumbnailsFileName	String		.
PhotoThumbnailsContentUrl	String		.
PhotoThumbnailsContentType	String		.
PhotoThumbnailsSize	Integer		.
PhotoInline	Boolean		If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false.
RestrictedAgent	Boolean		If the agent has any restrictions; false for admins and unrestricted agents, true for other agents.
Shared	Boolean		If the collaborator is shared from a different Zendesk Support instance. Ticket sharing accounts only.
SharedAgent	Boolean		If the collaborator is a shared agent from a different Zendesk Support instance. Ticket sharing accounts only.
Signature	String		The signature of the collaborator. Only agents and admins can have signatures.
Suspended	Boolean		If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end collaborator portal.
Tags	String		The tags of the collaborator. Only present if your account has collaborator tagging enabled.
TicketRestriction	String		Specifies which tickets the collaborator has access to. Possible values are: organization, groups, assigned, requested, null.
TimeZone	String		The time zone of the collaborator.
TwoFactorAuthEnabled	Boolean		If two factor authentication is enabled.
Url	String		The API url of the collaborator.

CustomObjectField

The view specifies all the attributes of a custom object property.

Select

The CustomObjectField view supports the ObjectName in the WHERE clause. This view supports the following operator: '='. For example:

SELECT * FROM CustomObjectField WHERE ObjectName = 'house'

Columns


Name	Type	References	Description
ObjectName [KEY]	String		A user-defined unique identifier.
FieldName	String		The name of the property.
Type	String		The type of the property. 使用できる値は次のとおりです。boolean, integer, number, string
Description	String		The description of the property.
Required	String		Indicates whether or not this property is required when you create a record.

JobStatus

A status record is created when somebody kicks off a job such as updating multiple tickets. You can access the job status data for an hour after a particular job is created, after which the data is no longer available.

Table Specific Information

Select

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

SELECT * FROM JobStatus WHERE Id = '123'

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.

Columns


Name	Type	References	Description
Id [KEY]	String		Automatically assigned when the job is queued.
Total	Integer		The total number of tasks this job is batching through.
Progress	Integer		Number of tasks that have already been completed.
Status	String		The current status. One of the following: queued, working, failed, completed, killed.
Message	String		Message from the job worker, if any.
Results	String		Result data from processed tasks.
Url	String		The URL to poll for status updates.

Locales

Query Locales in Zendesk.

Table Specific Information

Select

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

SELECT * FROM Locales

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.

Columns


Name	Type	References	Description
Id [KEY]	Long		Automatically assigned.
Name	String		Name of the locale.
Locale	String		The locale.
CreatedAt	Datetime		When this locale was created.
UpdatedAt	Datetime		When this locale last got updated.
Url	String		The API url of the locale.

MonitoredTwitterHandles

Query Monitored Twitter handles in Zendesk.

Table Specific Information

Select

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

SELECT * FROM MonitoredTwitterHandles WHERE Id = '123'

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.

Columns


Name	Type	References	Description
Id [KEY]	Long		Automatically assigned upon creation.
ScreenName	String		Name of the locale.
TwitterUserId	Long		The country's code.
CreatedAt	Datetime		The time the handle was created.
UpdatedAt	Datetime		The time of the last update of the handle.
AvatarUrl	String		The profile image url of the handle.
Name	String		The profile name of the handle.
AllowReply	Boolean		The profile image url of the handle.
CanReply	Boolean		If replies are allowed for this handle.
BrandId	Long	Brands.Id	What brand the handle is associated with.

OrganizationFieldsRelationshipFilterAll

Query OrganizationFields RelationshipFilterAll Filter with Logical AND.

Table Specific Information

Select

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

SELECT * FROM OrganizationFieldsRelationshipFilterAll WHERE TicketFieldId = '10676711527964'

Columns


Name	Type	References	Description
OrganizationFieldId	Long	OrganizationFields.Id	The Organization field id.
Field	String		The name of a ticket field.
Operator	String		A comparison operator.
Value	String		The value of a ticket field.

OrganizationFieldsRelationshipFilterAny

Query OrganizationFields RelationshipFilterAny Filter with Logical OR.

Table Specific Information

Select

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

SELECT * FROM OrganizationFieldsRelationshipFilterAny WHERE TicketFieldId = '10676711527964'

Columns


Name	Type	References	Description
OrganizationFieldId	Long	OrganizationFields.Id	The Organization field id.
Field	String		The name of a ticket field.
Operator	String		A comparison operator.
Value	String		The value of a ticket field.

Requests

Query Requests in Zendesk.

Table Specific Information

Select

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

SELECT * FROM Requests WHERE Id = '123'

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.

Columns


Name	Type	References	Description
Id [KEY]	Long		Automatically assigned when creating requests.
Subject	String		The value of the subject field for this request if the subject field is visible to end users; a truncated version of the description otherwise.
Description	String		The first comment on the request.
Status	String		The state of the request, new, open, pending, hold, solved, closed.
Priority	String		The priority of the request, low, normal, high, urgent.
Type	String		The type of the request, question, incident, problem, task.
OrganizationId	Long	Organizations.Id	The organization of the requester.
RequesterId	Long	Users.Id	The id of the requester.
AssigneeId	Long	Users.Id	The id of the assignee if the field is visible to end users.
GroupId	Long	Groups.Id	The id of the assigned group if the field is visible to end users.
CollaboratorIds	String		Who are currently CC'ed on the ticket.
ViaChannel	String		This tells you how the ticket or event was created. Examples: web, mobile, rule, system.
ViaSource	String		For some channels a source object gives more information about how or why the ticket or event was created.
IsPublic	Boolean		Is true if any comments are public, false otherwise.
DueAt	Date		When the task is due (only applies if the request is of type 'task').
CanBeSolvedByMe	Boolean		If true, end user can mark request as solved.
Solved	Boolean		Whether or not request is solved (an end user can set this if 'can_be_solved_by_me', above, is true for that user).
TicketFormId	Long	TicketForms.Id	The numeric id of the ticket form associated with this request if the form is visible to end users - only applicable for enterprise accounts.
Recipient	String		The original recipient e-mail address of the request.
FollowupSourceId	Integer	Tickets.Id	The id of the original ticket if this request is a follow-up ticket.
CreatedAt	Datetime		The time the request was created.
UpdatedAt	Datetime		The time of the last update of the request.
Url	String		The API url of this request.
CustomFields	String		Custom fields for the request.
CustomStatusId	Long		The custom ticket status id of the ticket.
EmailCcIds	String		The ids of users who are currently email CCs on the ticket.

Requests_Collaborators

The Collaborator ids of users currently CC'ed on the ticket.

Columns


Name	Type	References	Description
Id	Long	Requests.Id	Automatically assigned when creating requests.
CollaboratorId	Long	Collaborators.Id	The id of users currently CC'ed on the ticket.

ResourceCollections

Query Resource Collections in Zendesk.

Table Specific Information

Select

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

SELECT * FROM ResourceCollections
SELECT * FROM ResourceCollections WHERE Id = '310043820'

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.

Columns


Name	Type	References	Description
Id [KEY]	Long		Id for the resource collection. Automatically assigned upon creation.
Resources	String		Array of resource metadata objects.
CreatedAt	Datetime		When the resource collection was created.
UpdatedAt	Datetime		Last time the resource collection was updated.

SatisfactionReasons

Query the Satisfaction Reasons in Zendesk.

Table Specific Information

Select

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

SELECT * FROM SatisfactionReasons WHERE Id = '10500025760540'

Columns


Name	Type	References	Description
Id [KEY]	Long		Automatically assigned when creating trigger categories.
ReasonCode	Integer		An account-level code for referencing the reason. Custom reasons are assigned an auto-incrementing integer (non-system reason codes begin at 1000).
Value	String		Translated value of the reason in the account locale.
RawValue	String		The dynamic content placeholder, if present, or the current value, if not.
Url	String		API URL for the resource.
CreatedAt	Datetime		The time the reason was created.
UpdatedAt	Datetime		The time the reason was updated.
DeletedAt	Datetime		The time the reason was deleted.

SideConversationEvents

Query Side Conversations events in Zendesk. The messages that make up a side conversation are recorded as events.

Table Specific Information

Select

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

SELECT * FROM SideConversationEvents WHERE TicketId = 2 AND SideConversationId = '5d133b65-576c-11ee-bcb2-bdce8f618e59'

Columns


Name	Type	References	Description
Id [KEY]	String		Automatically assigned when the event is created.
TicketId	Integer	Tickets.Id	The parent ticket id of the side conversation.
SideConversationId	String	SideConversations.Id	The id of the side conversation the event belongs to.
ActorEmail	String		The email address of the participant.
ActorName	String		The name of the participant.
ActorUserId	Long		If the participant is an agent, the agent's user id.
ActorSlackWorkspaceId	String		If the participant is a Slack user or channel, the Slack workspace id.
ActorSlackChannelId	String		If the participant is a Slack channel, the Slack channel id.
ActorSupportGroupId	String		If the participant is a Support ticket, the support group id.
ActorSupportAgentId	String		If the participant is a Support ticket, the support agent id.
ActorMSTeamsChannelId	String		If the participant is a Microsoft teams channel, the Teams channel id.
Message	String		Events of type create and reply have a message.
CreatedAt	Datetime		The time the side conversation event was created.
Type	String		The type of event.
Updates	String		Events of type update have fields here.
via	String		The channel used when creating the event.
Url	String		The API url of the side conversation.

SideConversationEventsMessage

Query Side Conversations events message in Zendesk.

Table Specific Information

Select

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

SELECT * FROM SideConversationEventsMessage WHERE TicketId = 2 AND SideConversationId = '5d133b65-576c-11ee-bcb2-bdce8f618e59'

Columns


Name	Type	References	Description
SideConversationEventsId	String	SideConversationEvents.Id	Side Conversation Events Id.
TicketId	Integer	Tickets.Id	The parent ticket id of the side conversation.
SideConversationId	String	SideConversations.Id	The id of the side conversation the event belongs to.
Subject	String		The subject of the message.
PreviewText	String		A plain text string describing the message.
Body	String		The plain text version of the body of the message.
HtmlBody	String		The HTML version of the body of the message.
FromUserId	Long		If the participant is an agent, the agent's user id.
FromEmail	String		The name of the participant.
FromName	String		The email address of the participant.
To	String		The list of participants the message was sent to.
ExternalIds	String		A key-value object where all values are strings. Used for metadata.

SideConversationEventsMessageTo

Query the list of participants, the message was sent to.

Table Specific Information

Select

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

SELECT * FROM SideConversationEventsMessageTo WHERE TicketId = 2 AND SideConversationId = '5d133b65-576c-11ee-bcb2-bdce8f618e59'

Columns


Name	Type	References	Description
SideConversationEventsId	String	SideConversationEvents.Id	Side Conversation Events Id.
TicketId	Integer	Tickets.Id	The parent ticket id of the side conversation.
SideConversationId	String	SideConversations.Id	The id of the side conversation the event belongs to.
UserId	Long		If the participant is an agent, the agent's user id.
Email	String		The email address of the participant.
Name	String		The name of the participant.
SlackWorkspaceId	String		If the participant is a Slack user or channel, the Slack workspace id.
SlackChannelId	String		If the participant is a Slack channel, the Slack channel id.
SupportGroupId	String		If the participant is a Support ticket, the support group id.
SupportAgentId	String		If the participant is a Support ticket, the support group id.
MSTeamsChannelId	String		If the participant is a Microsoft teams channel, the Teams channel id.

SideConversationParticipants

Query Side Conversation Participants in Zendesk.

Table Specific Information

Select

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

SELECT * FROM SideConversationParticipants WHERE TicketId = 1
SELECT * FROM SideConversationParticipants WHERE TicketId = 1 AND SideConversationId = '5d133b65-576c-11ee-bcb2-bdce8f618e59'

Columns


Name	Type	References	Description
SideConversationId	String	SideConversations.Id	Side Conversation Id.
TicketId	Integer	Tickets.Id	The parent ticket id of the side conversation.
UserId	Long		If the participant is an agent, the agent's user id.
Email	String		The email address of the participant.
Name	String		The name of the participant.
SlackWorkspaceId	String		If the participant is a Slack user or channel, the Slack workspace id.
SlackChannelId	String		If the participant is a Slack channel, the Slack channel id.
SupportGroupId	String		If the participant is a Support ticket, the support group id.
SupportAgentId	String		If the participant is a Support ticket, the support group id.
MSTeamsChannelId	String		If the participant is a Microsoft teams channel, the Teams channel id.

SlaPoliciesFilterAll

Query SlaPolicies Filter with Logical AND.

Table Specific Information

Select

The following queries are processed server-side while other filters are processed client-side within the Sync App.

SELECT * FROM SlaPoliciesFilterAll
SELECT * FROM SlaPoliciesFilterAll WHERE SlaPolicyId = '123'

Columns


Name	Type	References	Description
SlaPolicyId	Long		SlaPolicy id.
Field	String		The name of a ticket field.
Operator	String		A comparison operator.
Value	String		The value of a ticket field.

SlaPoliciesFilterAny

Query SlaPolicies Filter with Logical OR.

Table Specific Information

Select

The following queries are processed server-side while other filters are processed client-side within the Sync App.

SELECT * FROM SlaPoliciesFilterAny
SELECT * FROM SlaPoliciesFilterAny WHERE SlaPolicyId = '123'

Columns


Name	Type	References	Description
SlaPolicyId	Long		SlaPolicy id.
Field	String		The name of a ticket field.
Operator	String		A comparison operator.
Value	String		The value of a ticket field.

SlaPoliciesMetrics

Query SlaPoliciesMetrics that describes the metric targets for each value of the priority field.

Table Specific Information

Select

The following queries are processed server-side while other filters are processed client-side within the Sync App.

SELECT * FROM SlaPoliciesMetrics
SELECT * FROM SlaPoliciesMetrics WHERE SlaPolicyId = '123'

Columns


Name	Type	References	Description
SlaPolicyId [KEY]	Long		SlaPolicy id.
BusinessHours	Boolean		Boolean value that returns whether the metric targets are being measured in business hours or calendar hours.
Metric	String		The definition of the time that is being measured.
Priority	String		Priority that a ticket must match.
Target	Integer		The time within which the end-state for a metric should be met.

TargetFailures

Query Target failures in Zendesk.

Table Specific Information

Select

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

SELECT * FROM TargetFailures
SELECT * FROM TargetFailures WHERE Id = 1

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.

Columns


Name	Type	References	Description
Id [KEY]	Long		The ID of the target failure.
StatusCode	Integer		HTTP status code of the target failure.
TargetName	String		Name of the target failure.
ConsecutiveFailureCount	Integer		Number of times the target failed consecutively.
CreatedAt	Datetime		Time of the failure.
RawRequest	String		The raw message of the target request.
RawResponse	String		The raw response of the failure.

TicketEmailCCs

Query any users cc'd on the ticket in Zendesk.

Table Specific Information

Select

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

SELECT * FROM TicketEmailCCs where TicketId = '2826'

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.

Columns


Name	Type	References	Description
TicketId	Long	Tickets.id	The id of the Ticket.
UserId	String	Users.id	The id of the User.
Name	String		Name of the User.

TicketFieldsRelationshipFilterAll

Query TicketFields RelationshipFilterAll Filter with Logical AND.

Table Specific Information

Select

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

SELECT * FROM TicketFieldsRelationshipFilterAll WHERE TicketFieldId = '10676711527964'

Columns


Name	Type	References	Description
TicketFieldId	Long	TicketFields.Id	The Ticket field id.
Field	String		The name of a ticket field.
Operator	String		A comparison operator.
Value	String		The value of a ticket field.

TicketFieldsRelationshipFilterAny

Query TicketFields RelationshipFilterAny Filter with Logical OR.

Table Specific Information

Select

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

SELECT * FROM TicketFieldsRelationshipFilterAny WHERE TicketFieldId = '10676711527964'

Columns


Name	Type	References	Description
TicketFieldId	Long	TicketFields.Id	The Ticket field id.
Field	String		The name of a ticket field.
Operator	String		A comparison operator.
Value	String		The value of a ticket field.

TicketRelatedInformation

Query Ticket related information in Zendesk.

Table Specific Information

Select

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

SELECT * FROM TicketRelatedInformation where TicketId = '2826'

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.

Columns


Name	Type	References	Description
TicketId	Long	Tickets.id	The id of the Ticket.
TopicId	String		Related topic in the Web portal (deprecated feature).
JiraIssueIds	String		Jira issues Id.
FollowupSourceIds	String		Sources to follow up.
FromArchive	Boolean		Is true if the current ticket is archived.
Incidents	Integer		A count of related incident occurrences.
Url	String		Url.
Twitter	String		X (formerly Twitter) information associated with the ticket.

UserEvents

Query events for a given Zendesk user.

Table Specific Information

Select

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

SELECT * FROM UserEvents where UserId = '18921855007122'

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.

Columns


Name	Type	References	Description
Id [KEY]	String		ID of the event.
UserId	Long	Users.id	The id of the User.
Type	String		Event name.
Source	String		Application which sent the event.
Description	String		An event description.
CreatedAt	Datetime		ISO-8601 compliant date-time reflecting the time the event was created. If not set, the API sets the value when it receives the event.
ReceivedAt	Datetime		ISO-8601 compliant date-time reflecting the time the event was received.
Properties	String		A custom JSON object with details about the event. Must comply with the JSON Schema specification.

UserFieldsRelationshipFilterAll

Query UserFields RelationshipFilterAll Filter with Logical AND.

Table Specific Information

Select

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

SELECT * FROM UserFieldsRelationshipFilterAll WHERE UserFieldId = '19067693577105'

Columns


Name	Type	References	Description
UserFieldId	Long	UserFields.Id	The User field id.
Field	String		The name of a ticket field.
Operator	String		A comparison operator.
Value	String		The value of a ticket field.

UserFieldsRelationshipFilterAny

Query UserFields RelationshipFilterAny Filter with Logical OR.

Table Specific Information

Select

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

SELECT * FROM UserFieldsRelationshipFilterAny WHERE UserFieldId = '19067693577105'

Columns


Name	Type	References	Description
UserFieldId	Long	UserFields.Id	The User field id.
Field	String		The name of a ticket field.
Operator	String		A comparison operator.
Value	String		The value of a ticket field.

UserRelatedInformation

Query UserRelatedInformation in Zendesk.

Table Specific Information

Select

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

SELECT * FROM UserRelatedInformation WHERE UserId = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns


Name	Type	References	Description
UserId	Long	Users.id	The id of the user.
AssignedTickets	Integer		Count of assigned tickets.
RequestedTickets	Integer		Count of requested tickets.
CcdTickets	Integer		Count of collaborated tickets.
OrganizationSubscriptions	Integer		Count of organization subscriptions.
Topics	Integer		Count of topics (Web portal only).
TopicComments	Integer		Count of comments on topics (Web portal only).
Votes	Integer		Count of votes (Web portal only).
Subscriptions	Integer		Count of subscriptions (Web portal only).
EntrySubscriptions	Integer		Count of entry subscriptions (Web portal only).
ForumSubscriptions	Integer		Count of forum subscriptions (Web portal only).

UserSubscriptions

Query the user subscriptions in Zendesk.

Table Specific Information

Select

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

SELECT * FROM UserSubscriptions WHERE UserId = '123'

Columns


Name	Type	References	Description
Id [KEY]	Long		Automatically assigned when the subscription is created.
UserId	Long	Users.Id	The Id of the User.
FollowedId	Long		The id of the user being followed.
FollowerId	Long		The id of the user doing the following.

ViewsConditionsAll

Query views conditions with logical AND.

Table Specific Information

Select

The following queries are processed server-side while other filters are processed client-side within the Sync App.

SELECT * FROM ViewsConditionsAll WHERE ViewId = '18521247306513'

Columns


Name	Type	References	Description
ViewId [KEY]	Long		View id.
Active	Boolean		Useful for determining if the view should be displayed.
Access	String		Only views with given access. May be personal, shared, or account.
GroupId	Long		The group id the view belongs to. Used to query the table.
Field	String		The name of a ticket field.
Operator	String		A comparison operator.
Value	String		The value of a ticket field.

ViewsConditionsAny

Query views conditions with logical OR.

Table Specific Information

Select

The following queries are processed server-side while other filters are processed client-side within the Sync App.

SELECT * FROM ViewsConditionsAny WHERE ViewId = '18521247306513'

Columns


Name	Type	References	Description
ViewId [KEY]	Long		View id.
Active	Boolean		Useful for determining if the view should be displayed.
Access	String		Only views with given access. May be personal, shared, or account.
GroupId	Long		The group id the view belongs to. Used to query the table.
Field	String		The name of a ticket field.
Operator	String		A comparison operator.
Value	String		The value of a ticket field.

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

プロパティ	説明
AuthScheme	Zendesk にUser /（Password / APIToken）で接続するか、OAuth で接続するか。
URL	URL は、Zendesk Support のURL です。
User	認証するZendesk ユーザーアカウントのユーザーID を指定します。
Password	認証するユーザーアカウントのパスワードを指定します。
ApiToken	現在の認証ユーザーのAPI トークン。

OAuth

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（コンシューマーシークレットとも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

SSL

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Firewall

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

Proxy

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

Schema

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

Miscellaneous

プロパティ	説明
IncludeCustomObjects	If set to true, the provider will display custom objects among the other views and make them available for use.
IncludeDeleted	Set this property to true, to include deleted Tickets when using Incremental API.
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Pagesize	Zendesk から取得されるデータのページごとに返される結果の数。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UseIncrementalAPI	Set this property to true, to make use of the Zendesk Incremental API.
UseParallelPaging	Determines whether to use parallel pagination.
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

プロパティ	説明
AuthScheme	Zendesk にUser /（Password / APIToken）で接続するか、OAuth で接続するか。
URL	URL は、Zendesk Support のURL です。
User	認証するZendesk ユーザーアカウントのユーザーID を指定します。
Password	認証するユーザーアカウントのパスワードを指定します。
ApiToken	現在の認証ユーザーのAPI トークン。

AuthScheme

Zendesk にUser /（Password / APIToken）で接続するか、OAuth で接続するか。

解説

Basic：Basic ユーザー / Password 認証を使用する場合に設定。ドライバーは、APIToken よりもPassword を優先して認証に使用します。
OAuth：OAuth 認証を実行する場合に設定。
APIToken：Basic ユーザー / APIToken 認証を使用する場合に設定。

URL

URL は、Zendesk Support のURL です。

解説

URL は、Zendesk Support のURL です。例：https://{subdomain}.zendesk.com

User

認証するZendesk ユーザーアカウントのユーザーID を指定します。

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

Password

認証するユーザーアカウントのパスワードを指定します。

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

ApiToken

現在の認証ユーザーのAPI トークン。

解説

The User and ApiToken are together used to authenticate with the server.

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（コンシューマーシークレットとも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

OAuthClientId

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

OAuthClientSecret

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（コンシューマーシークレットとも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：


説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

Firewall

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

FirewallType

provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note：デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。


プロトコル	デフォルトポート	説明
TUNNEL	80	Sync App がZendesk への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4	1080	Sync App がZendesk への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	Sync App がZendesk にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

FirewallServer

ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallPort

プロキシベースのファイアウォールで使用するTCP ポートを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallUser

プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallPassword

プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Proxy

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

ProxyAutoDetect

provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。

解説

この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

ProxyServer

HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

ProxyPort

クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

ProxyAuthScheme

ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。

解説

認証タイプは次のいずれかです。

BASIC：Sync App はHTTP BASIC 認証を行います。
DIGEST：Sync App はHTTP DIGEST 認証を行います。
NTLM：Sync App はNTLM トークンを取得します。
NEGOTIATE：Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
NONE：ProxyServer が認証を必要としない場合に設定します。

"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyUser

ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。


ProxyAuthScheme の値	ProxyUser に設定する値
BASIC	プロキシサーバーに登録されているユーザーのユーザー名。
DIGEST	プロキシサーバーに登録されているユーザーのユーザー名。
NEGOTIATE	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。`user@domain` または`domain\user` の形式で指定。
NTLM	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。`user@domain` または`domain\user` の形式で指定。
NONE	ProxyPassword 接続プロパティは設定しないでください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

ProxyPassword

ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。


ProxyAuthScheme の値	ProxyPassword に設定する値
BASIC	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
DIGEST	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
NEGOTIATE	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NTLM	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NONE	ProxyPassword 接続プロパティは設定しないでください。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

ProxySSLType

ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。


AUTO	デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyExceptions

ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

LogModules

ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

解説

このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。

例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。複数のモジュールを含めるには、次のように名前をセミコロンで区切ります：INFO;EXEC;SSL。

Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。

利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログの「高度なログの記録」セクションを参照してください。

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。

解説

Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\Zendesk Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます：


プラットフォーム	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

Tables

レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。

解説

データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

Views

レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

解説

データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

プロパティ	説明
IncludeCustomObjects	If set to true, the provider will display custom objects among the other views and make them available for use.
IncludeDeleted	Set this property to true, to include deleted Tickets when using Incremental API.
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Pagesize	Zendesk から取得されるデータのページごとに返される結果の数。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UseIncrementalAPI	Set this property to true, to make use of the Zendesk Incremental API.
UseParallelPaging	Determines whether to use parallel pagination.
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

IncludeCustomObjects

If set to true, the provider will display custom objects among the other views and make them available for use.

解説

If set to true, the Sync App will display custom objects among other views. Retrieving custom views is a costly operation, so this property defaults to 'false'.

IncludeDeleted

Set this property to true, to include deleted Tickets when using Incremental API.

解説

This property has effect only on the Tickets table.

MaxRows

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

Other

特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

解説

このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。複数のプロパティをセミコロン区切りのリストで定義できます。

Note： 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット


DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

Pagesize

Zendesk から取得されるデータのページごとに返される結果の数。

解説

ほとんどのテーブルで、サポートする最大値が100であることに注意してください。

PseudoColumns

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

解説

このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

解説

このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

UseIncrementalAPI

Set this property to true, to make use of the Zendesk Incremental API.

解説

Set this property to true, to make use of the Zendesk Incremental API. This property has effect only on the Tickets, TicketMetrics and Calls table and disables all server side criteria.

UseParallelPaging

Determines whether to use parallel pagination.

解説

Enabling this property retrieves a maximum of 10K records due to API limitations. This applies to these tables:

ArticleAttachments
Automations
Collaborators
CustomAgentRoles
Groups
GroupsMemberShips
Holidays
Locale
Macros
MonitoredTwitterHandles
OrganizationFields
OrganizationMembership
Organizations
OrganizationSubscriptions
PostComments
Requests
Requests_Collaborators
SatisficationRatings
Schedules
Sessions
SharingAgreements
SlaPolicies
SupportAddress
TicketForms
TicketMetrics
Tickets_Collaborators
Tickets_Followers
Tickets_Followups
Tickets_Macros
Triggers
UserFields
UserIdentities
Users
Views

UserDefinedViews

カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

解説

このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Tickets WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。例：UserDefinedViews=C:\Path\To\UserDefinedViews.json。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

詳しくは、ユーザー定義ビューを参照してください。

Zendesk Connector for CData Sync

Zendesk Connector for CData Sync

概要

Zendesk バージョンサポート

接続の確立

Zendesk への接続を追加

Zendesk への接続

Zendesk への認証

API トークン認証

OAuth 認証

Basic 認証（レガシー）

高度な設定

SSL コンフィギュレーションのカスタマイズ

Firewall またはProxy 経由の接続

HTTP プロキシ

その他のプロキシ

高度な機能

ユーザー定義ビュー

SSL の設定

ファイアウォールとプロキシ

クエリ処理

ログ

SSL の設定

SSL 設定のカスタマイズ

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

その他のプロキシ

データモデル

クエリ処理の使用

ストアドプロシージャ

テーブル

Zendesk Connector for CData Sync テーブル

AccountSettings

Table Specific Information

Select

Update

Columns

ArticleAttachments

Table Specific Information

Select

Delete

Columns

Pseudo-Columns

ArticleComments

Table Specific Information

Select

Insert

Update

Delete

Columns

Pseudo-Columns

ArticleLabels

Table Specific Information

Select

Insert

Delete

Columns

Pseudo-Columns

Articles

Table Specific Information

Select

Insert

Update

Delete

Columns

Pseudo-Columns

ArticleTranslations

Columns

Attributes

Table Specific Information

Select

Insert

Update

Delete

Columns

AttributeValues

Table Specific Information

Select

Insert