はじめに

このページでは、CData Cloud でのFreshdesk への接続の確立のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Freshdesk への接続

接続の確立は、CData Cloud にデータベースを作成するためのFreshdesk への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してFreshdesk からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメントで詳しく説明します。

接続の確立

Database タブで対応するアイコンを選択して、Freshdesk に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Connecting to Freshdesk

Freshdesk makes use of basic authentication. To connect to data, set the following connection properties:

Domain: Set this to the domain associated with your Freshdesk account. For example, in your URL, https://{domainValue}.freshdesk.com, thus the connection string should be:
Domain=domainValue
APIKey: Set this to the API key associated with your Freshdesk account. To retrieve your API key, log in to your support Portal. Click the profile picture in the upper-right corner and select the profile settings page. The API key is available below the change password section to the right.

SSL の設定

SSL 設定のカスタマイズ

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

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

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

Firewall またはProxy 経由の接続

HTTP プロキシ

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

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

その他のプロキシ

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

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

データモデル

Overview

This section shows the available API objects and provides more information on executing SQL to Freshdesk APIs.

Key Features

The Cloud models Freshdesk entities as relational tables, allowing you to write SQL to query Freshdesk data.
Live connectivity to these objects means any changes to your Freshdesk account are immediately reflected when using the Cloud.

Tables

テーブル describes the available tables. Tables are statically defined to model Tickets, Conversations, Agents, and more.

テーブル

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

CData Cloud - Freshdesk テーブル


Name	Description
Agents	Update, delete, and query from agents table
CannedResponses	Create, update and query from CannedResponses table
CannedResponsesFolder	Query from CannedResponsesFolder table
Companies	Create, update, delete, and query from companies table
Contacts	Create, update, delete, and query from contacts table
Conversations	Delete, and query from conversations table
Groups	Create, update, delete, and query from groups table
Mailboxes	Create, update, delete, and query from Mailboxes table
Roles	Query from roles table
Skills	Create, update, delete, and query from skills table
SLAPolicies	Query, Create and Update SLAPolicies table
TicketCreationAutomationRules	Create, update, delete, and query from TicketCreationAutomationRules table
TicketFields	Query from ticketFields table
Tickets	Create, update, delete, and query from tickets table
TicketUpdatesAutomationRules	Create, update, delete, and query from TicketUpdatesAutomationRules table
TimeEntries	Create, update, delete, and query from TimeEntries table
TimeTriggersAutomationRules	Create, update, delete, and query from TimeTriggersAutomationRules table

Agents

Update, delete, and query from agents table

Table Specific Information

Select

The Cloud will use the Freshdesk API to process WHERE clause conditions built with the following columns and operators. Most of the columns support server side filtering with the following operators: =,>,<,<=,>=,AND,OR. The rest of the filter is executed client side within the Cloud. For example, the following query is processed server side:

SELECT * FROM Agents WHERE Id = 100

Note: To query Agents table, All Agent APIs other than the Currently Authenticated Agent API require admin privileges.

Update

Following is an example of how to update an agent:

UPDATE Agents SET GroupIdsAggregate = '111' WHERE Id = 100

Delete

Following is an example of how to delete an agent:

DELETE FROM Agents WHERE Id = 100

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Bigint	False	ID of the agent.
Available	Boolean	True	Indicates if agent is taking new tickets.
GroupIdsAggregate	String	False	Group IDs associated with the agent.
Occasional	Boolean	True	True if this is an occasional agent.
RoleIdsAggregate	String	False	Role IDs associated with the agent.
Signature	String	True	Signature of the agent in HTML format.
SkillIdsAggregate	String	True	Skill ids associated with the agent.
TicketScope	Integer	True	Ticket permission of the agent (1 -> Global Access, 2 -> Group Access, 3 -> Restricted Access).
AgentActive	Boolean	True	Whether or not the agent has been verified.
AgentEmail	String	True	Email address of the agent.
AgentJobTitle	String	True	Job title of the agent.
AgentLanguage	String	True	Language of the agent.
AgentLastLogin	Datetime	True	Last login date of the agent.
AgentMobile	String	True	Mobile phone number of the agent.
AgentName	String	True	Name of the agent.
AgentPhone	String	True	Telephone number of the agent.
AgentTimeZone	String	True	Time zone of the agent.
AgentCreatedAt	Datetime	True	Created at datetime of the agent.
AgentUpdatedAt	Datetime	True	Updated at datetime of the agent.
CreatedAt	Datetime	True	Agent creation timestamp.
UpdatedAt	Datetime	True	Agent updated timestamp.
AvailableSince	Datetime	True	Timestamp that denotes when the agent became available/unavailable.

CannedResponses

Create, update and query from CannedResponses table

Table Specific Information

Note: Only users with admin privileges can access the following Table.

Select

To query the CannedResponses table, FolderId should be mentioned in the WHERE clause. For example:

SELECT * FROM CannedResponses WHERE FolderId = 100

Insert

FolderId, Visibility, Title and ContentHTML are mandatory columns for Inserting into CannedResponses tables. For example:

INSERT INTO CannedResponses (Title, ContentHTML, Visibility, FolderId) VALUES (Sample response, 'this is also a new sample response', 0, 100)

Update

Following is an example to update a row in CannedResponses table:

UPDATE CannedResponses SET Title = 'Updated title' WHERE Id = 100

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Bigint	False	ID of the canned response.
Content	String	True	Plaintext version of the canned response content.
ContentHTML	String	False	HTML version of the canned response content.
Title	String	False	Title of the canned response.
FolderId	Bigint	False	Id of CannedResponseFolder containing this canned response.
Visibility	Int	False	Denotes the visibility of the canned response. Possible values are: 0- If it is visible to all agents, 1- If it is personal.
CreatedAt	Datetime	True	Canned response creation timestamp.
UpdatedAt	Datetime	True	Canned response updated timestamp.

CannedResponsesFolder

Query from CannedResponsesFolder table

Table Specific Information

Note: Only users with admin privileges can access the following Table.

Select

Following is an example to select all entries from CannedResponsesFolder table:

SELECT * FROM CannedResponsesFolder

You can also select a specific entry from CannedResponsesFolder table:

SELECT * FROM CannedResponsesFolder WHERE Id = 100

Insert

Name is a mandatory columns for Inserting into CannedResponsesFolder table.

INSERT INTO CannedResponsesFolder (Name) VALUES (directoryA)

Update

Following is an example to update CannedResponsesFolder:

UPDATE CannedResponsesFolder SET Name = 'updated name' WHERE Id = 100

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Bigint	False	ID of the canned response folder.
Name	String	False	Name of the canned response folder.
Personal	Boolean	False	Set true if the folder can be accessed only by you.
ResponsesCount	Int	False	Number of canned responses in the folder.
CreatedAt	Datetime	True	Canned response folder creation timestamp.
UpdatedAt	Datetime	True	Canned response folder updated timestamp.

Companies

Create, update, delete, and query from companies table

Table Specific Information

Select

The Cloud will use the Freshdesk API to process WHERE clause conditions built with the following columns and operators. Most of the columns support server side filtering with the following operators: =,>,<,<=,>=,AND,OR. The rest of the filter is executed client side within the Cloud. For example, the following query is processed server side:

SELECT * FROM Companies WHERE CreatedAt >= '2017-10-01' AND CreatedAt <= '2017-10-07'

The API allows only a subset of columns to be used as filter criteria in the WHERE clause. The following columns can be used:

Id
DomainAggregate
CreatedAt
UpdatedAt

Note: To filter all companies created on a specific day (e.g: 2019-09-23), query should be structured as:

WHERE CreatedAt >= '2019-09-22' AND CreatedAt <= '2019-09-24'

Insert

Name is mandatory for creating a new company. Following is an example of creating a new company:

INSERT INTO Companies (Name, Description) VALUES ('Example', 'Example description of new company')

Update

Following is an example of how to update a company:

UPDATE Companies SET Description = 'New description' WHERE Id = 786

Delete

Following is an example of how to delete from Companies table:

DELETE FROM Companies WHERE Id = 786

Columns


Name	Type	ReadOnly	Description
AccountTier	String	False	Classification based on how much value the company brings to your business.
CreatedAt	Datetime	True	Company creation timestamp.
Description	String	False	Description of the company.
DomainsAggregate	String	False	Domains associated with the company.
HealthScore	String	False	The strength of your relationship with the company.
Id [KEY]	Bigint	False	ID of the company.
Industry	String	False	The industry the company serves in.
Name	String	False	Name of the company.
Note	String	False	Any notes about the company.
RenewalDate	Date	False	Date when your contract or relationship with the company is due for renewal.
UpdatedAt	Datetime	True	Company updated timestamp.

Contacts

Create, update, delete, and query from contacts table

Table Specific Information

Select

The Cloud uses the Freshdesk API to process WHERE clause conditions built with the following columns and operators. Most of the columns support-server side filtering with the following operators: =,>,<,<=,>=,AND,OR. The rest of the filter is executed client-side within the Cloud.

For example, the following query is processed server-side:

SELECT * FROM Contacts WHERE Active = false AND (Email = '[email protected]' OR CompanyId = 1)

The API allows only a subset of columns to be used as filter criteria in the WHERE clause. The following columns can be used:

Id
Active
CompanyId
Email
Language
Tag
TimeZone
CreatedAt
UpdatedAt

Note: To filter all contacts created on a specific day (e.g: 2019-09-23), query should be structured as:

WHERE CreatedAt >= '2019-09-22' AND CreatedAt <= '2019-09-24'

Additional Filtering

You can use the SearchEmail column to search by secondary or alternate emails. When included in a query, the value provided is returned in the results for clarity. If no search term is specified, the column is empty.

For example:

SELECT * FROM Contacts WHERE SearchEmail='@outlook.com'

Do not combine Email and SearchEmail in the same WHERE clause.

Insert

Name and Email are mandatory for creating a new contact. The following is an example of creating a new contact:

INSERT INTO Contacts (Name, Email, Language) VALUES ('Example', '[email protected]', 'English')

Update

The following is an example of how to update a contact:

UPDATE Contacts SET Active = true WHERE Id = 786

Delete

The following is an example of how to delete a contact:

DELETE FROM Contacts WHERE Id = 786

Columns


Name	Type	ReadOnly	Description
Active	Boolean	False	True if contact has been verified.
Address	String	False	Address of the contact.
CompanyId	Bigint	False	Id of primary company of the contact.
CreatedAt	Datetime	True	Contact creation timestamp.
Deleted	Boolean	False	True if the contact has been deleted.
Description	String	False	A short description of the contact.
Email	String	False	Email of the contact.
Id [KEY]	Bigint	False	ID of the contact.
JobTitle	String	False	Job title of the contact.
Language	String	False	Language of the contact.
Name	String	False	Name of the contact.
OtherEmailsAggregate	String	False	Additional emails associated with the contact.
Phone	String	False	Telephone number of the contact.
Mobile	String	False	Mobile number of the contact.
TimeZone	String	False	Time zone of the contact.
Tag	String	False	Tag associated with the contact.
UpdatedAt	Datetime	True	Contact updated timestamp.
ViewAllTickets	Boolean	False	True if the contact can see all tickets that are associated with the company to which he belong.
State	String	False	State of the contact.
SearchEmail	String	False	Column used to search by primary or secondary emails. Returns the search term when used in a query (empty otherwise). Do not combine with Email in the same filter.

Conversations

Delete, and query from conversations table

Table Specific Information

Select

To query the Conversations table, TicketId should be mentioned in the WHERE clause. For example:

SELECT * FROM Conversations WHERE TicketId = 100

Note: The Conversations table can only be filtered on TicketId.

Delete

Following is an example of how to delete from the Conversations table:

DELETE FROM Conversations WHERE Id = 786

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Bigint	False	ID of the conversation.
Body	String	False	Content of the conversation in HTML.
BodyText	String	False	Content of the conversation.
FromEmail	String	False	Email address the message was sent from.
Incoming	Boolean	False	True if a particular conversation should appear as being created from outside (i.e., not through web portal)
Private	Boolean	False	True if the note is private
SupportEmail	String	False	Email address from which replies are sent.
Source	Integer	False	Denotes the type of conversation.
TicketId	Integer	False	Ticket id to which conversation is added.
ToEmailsAggregate	String	False	Email addresses of agents/users who need to be notified about this conversation
UserId	Bigint	False	ID of the agent who added conversation.
CreatedAt	Datetime	True	Conversation creation timestamp.
UpdatedAt	Datetime	True	Conversation updated timestamp.

Groups

Create, update, delete, and query from groups table

Table Specific Information

Select

The Cloud will use the Freshdesk API to process WHERE clause conditions built with the following columns and operators. Most of the columns support server side filtering with the following operators: =,>,<,<=,>=,AND,OR. The rest of the filter is executed client side within the Cloud. For example, the following query is processed server side:

SELECT * FROM Groups WHERE Id = 100

Note: Only users with admin privileges can access this Table.

Insert

Name is a mandatory column for inserting into Groups table. For example:

INSERT INTO Groups (Name, Description, AutoTicketAssign) VALUES ('Example', 'Example Description...', false)

Update

Following is an example of how to update a group:

UPDATE Groups SET Description = 'New description...' WHERE Id = 100

Delete

Following is an example of how to delete from Groups table:

DELETE FROM Groups WHERE Id = 786

Columns


Name	Type	ReadOnly	Description
AgentIdsAggregate	String	False	IDs of the agents in the group.
AutoTicketAssign	Integer	False	Whether automatic ticket assignment is enabled or not, and which type.
BusinessHourId	Bigint	False	Unique ID of the business hour of the group.
CreatedAt	Datetime	True	Group created timestamp.
Description	String	False	Description of the group.
EscalateTo	Bigint	False	ID of user to whom an escalation email is sent.
Id [KEY]	Bigint	False	ID of the group.
Name	String	False	Name of the group.
UnassignedFor	String	False	Time after which escalation email is sent.
UpdatedAt	Datetime	True	Group updated timestamp.

Mailboxes

Create, update, delete, and query from Mailboxes table

Table Specific Information

Note: Only users with admin privileges can access the following Table.

Select

Following is an example to select all entries from Mailboxes table:

SELECT * FROM Mailboxes

The API allows only a subset of columns to be used as filter criteria in the WHERE clause. The filters listed can also be combined using AND OR. The following columns can be used:

Id
SupportEmail
ForwardEmail
ProductId
GroupId
Active

Insert

SupportEmail and MailboxType are mandatory to Insert into Mailboxes table. For instance:

INSERT INTO Mailboxes (SupportEmail, Name, MailboxType) VALUES ('[email protected]', 'Test', 'freshdesk_mailbox')

Update

Following is an example of how to update Mailboxes table:

UPDATE Mailboxes SET Name = 'Test mailbox' WHERE Id = 786

Delete

Following is an example of how to delete from the Mailboxes table:

DELETE FROM Mailboxes WHERE Id = 786

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Bigint	False	Unique ID of the email mailbox.
AccessType	String	False	Denotes if the mailbox is to be used for incoming, outgoing or both.Takes the values 'incoming', 'outgoing' or 'both'.
Active	Boolean	True	True if the mailbox is verified and activated.
Authentication	String	False	Denotes the type of authentication that should be used authenticate the mailbox. It can be plain/login/CRAM-MD5.
CustomMailbox	String	False	Mandatory if the mailbox is of the type custom mailbox. This field contains the incoming and/or outgoing configurations of the mailbox based on what access type is set.
DefaultReplyEmail	Boolean	False	True if the email associated to a product, is the primary email.
DeleteFromServer	Boolean	False	If set to true, Freshdesk is given the permission to delete the email from the mailbox after the ticket is created.
FailureCode	String	True	Denotes the failure message if any in the custom incoming mailbox.
ForwardEmail	String	True	Denotes the email address to which your support emails gets forwarded.
FreshdeskMailbox	String	True	If the mailbox is of the type Freshdesk mailbox this field contains the forward email to which your support emails gets forwarded.
GroupId	Bigint	False	Denotes the group ID to which the email is associated.
Incoming	String	False	Contains the incoming configuration of the custom mailbox.
MailServer	String	False	Denotes the server used by incoming and/or outgoing configurations of the mailbox.
MailboxType	String	False	Denotes if the mailbox uses a Freshdesk mailbox or a custom mailbox setup by the customer. It takes the values 'freshdesk_mailbox' or 'custom_mailbox'.
Name	String	False	Name of the email mailbox.
Outgoing	String	True	Contains the outgoing configuration of the custom mailbox.
Password	String	False	Denotes the password that will be used to authenticate the custom mailbox.
Port	Int	False	Denotes the port used by incoming and/or outgoing configurations of the mailbox.
ProductId	Bigint	False	Denotes the product ID to which the email is associated.
SupportEmail	String	False	Denotes your support email address.
UseSSL	Boolean	False	Denotes if the incoming and/or outgoing configuration should use ssl while authenticating the mailbox.
Username	String	False	username.
CreatedAt	Datetime	True	Mailbox creation timestamp.
UpdatedAt	Datetime	True	Mailbox updated timestamp.

Roles

Query from roles table

Table Specific Information

Select

The Cloud will use the Freshdesk API to process WHERE clause conditions built with the following columns and operators. Most of the columns support server side filtering with the following operators: =,>,<,<=,>=,AND,OR. The rest of the filter is executed client side within the Cloud. For example, the following query is processed server side:

SELECT * FROM Roles WHERE Id = 100

Note: Only users with admin privileges can access the following Table. Following is an example of selecting a role:

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Bigint	False	Role ID.
Description	String	False	Description of the role.
Name	String	False	Name of the role.
Default	Boolean	False	Indicates if role is default.
CreatedAt	Datetime	True	Role creation timestamp.
UpdatedAt	Datetime	True	Role updated timestamp.

Skills

Create, update, delete, and query from skills table

Table Specific Information

Select

Following is an example to select all entries from Skills table:

SELECT * FROM Skills

You can also select a specific entry from Skills table:

SELECT * FROM Skills WHERE Id = 73000001322

Insert

Name is mandatory for creating a new skill. Following is an example of creating a new skill:

INSERT INTO Skills (Name) VALUES ('Example')

Update

Following is an example of how to update a skill:

UPDATE Skills SET Name = 'New name' WHERE Id = 73000001322

Delete

Following is an example of how to delete from Skills table:

DELETE FROM Skills WHERE Id = 73000001322

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Bigint	False	ID of the skill.
Name	String	False	Name of the skill.
Rank	String	True	Position/Rank of the skill.
Agents	String	False	Agents associated with the skill.
MatchType	String	True	Match type for conditions.
Conditions	String	False	Conditions of the skill.
CreatedAt	Datetime	True	Skills creation timestamp.
UpdatedAt	Datetime	True	Skills updated timestamp.

SLAPolicies

Query, Create and Update SLAPolicies table

Table Specific Information

Note: Only users with admin privileges can access the following Table.

Select

Following is an example to select all entries from SLAPolicies table:

SELECT * FROM SLAPolicies

You can also select a specific entry from SLAPolicies table:

SELECT * FROM SLAPolicies WHERE Id = 100

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Bigint	False	Business hour ID.
active	Boolean	False	True if the SLA policy is active.
Description	String	False	Description of the business hour.
IsDefault	Boolean	False	True if this is the default business hour.
Name	String	False	Name of the business hour.
Position	Int	False	Denotes the order of the SLA policy. If you have configured multiple SLA policies, the first one with matching conditions will be applied to a ticket.
SLATarget	String	False	Key value pair containing the object and the array of object IDs denoting the priorities and the applicable conditions. 'priority_4' - urgent, 'priority_3' - high, 'priority_2' - medium, 'priority_1' - low is mandatory and needs to be passed in the same order.
ApplicableTo	String	False	Key value pair containing the 'company_ids', 'group_ids', 'sources', 'ticket_types', 'product_ids' denoting the conditions based on which the SLA policy is to be applied. One of them is mandatory
Escalation	String	False	Nested collection of key value pairs containing the 'response' and 'resolution' denoting who to escalate to and when. One of them is mandatory
CreatedAt	Datetime	True	Creation timestamp.
UpdatedAt	Datetime	True	Updated timestamp.

TicketCreationAutomationRules

Create, update, delete, and query from TicketCreationAutomationRules table

Table Specific Information

Note: Only users with admin privileges can access the following Table.

Select

Following is an example to select all entries from TicketCreationAutomationRules table:

SELECT * FROM TicketCreationAutomationRules

The API allows only a subset of columns to be used as filter criteria in the WHERE clause. The filters listed can also be combined using AND OR. The following columns can be used:

Id

Insert

Name, Actions, and Conditions are mandatory to Insert into TicketCreationAutomationRules table. For instance:

INSERT INTO TicketCreationAutomationRules (Name, Actions, Conditions) VALUES ('Test', '[{"field_name": "status", "value": 5}]', '[{"name": "condition_set_1", "match_type": "any", "properties": [{"field_name": "to_email", "resource_type": "ticket", "operator": "contains", "value": ["@lyftron.com"]}]}]')

Update

Following is an example of how to update TicketCreationAutomationRules table:

UPDATE TicketCreationAutomationRules SET Name = 'Test2' WHERE Id = '2043002030021'

Delete

Following is an example of how to delete from the TicketCreationAutomationRules table:

DELETE FROM TicketCreationAutomationRules WHERE Id = '2043002030021'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Bigint	False	Unique ID of the TicketCreationAutomationRule.
Actions	String	False	Actions of the TicketCreationAutomationRule.
Active	Boolean	False	Active of the TicketCreationAutomationRule.
AffectedTicketsCount	Int	False	AffectedTicketsCount of the TicketCreationAutomationRule.
Conditions	String	False	Conditions of the TicketCreationAutomationRule.
Name	String	False	Name of the TicketCreationAutomationRule.
Outdated	Boolean	True	Outdated of the TicketCreationAutomationRule.
Position	Int	False	Position of the TicketCreationAutomationRule.
Summary	String	True	Summary of the TicketCreationAutomationRule.
CreatedAt	Datetime	True	TicketCreationAutomationRule creation timestamp.
UpdatedAt	Datetime	True	TicketCreationAutomationRule updated timestamp.

TicketFields

Query from ticketFields table

Table Specific Information

Note: Users whose credentials (identified by the API key) are used to access the Table should be authorised to either view the ticket fields or create a new ticket.

Select

The Cloud will use the Freshdesk API to process WHERE clause conditions built with the following columns and operators. Most of the columns support client side filtering with the following operators: =,>,<,<=,>=,AND,OR. The rest of the filter is executed server side within the Cloud. For example, the following query is processed server side:

SELECT * FROM TicketFields WHERE Type = 'default_requester'

The Freshdesk API allows only the following column(s) to be used as filter criteria in the WHERE clause:

Type

Insert

Label, LabelForCustomers and Type are mandatory columns for Inserting into TicketFields table.

INSERT INTO TicketFields (Label, LabelForCustomers, Type) VALUES ('labelA', 'labelA', custom_text)

Update

Following is an example to update TicketFields:

UPDATE TicketFields SET Label = 'updated label' WHERE Id = 100

Delete

Following is an example to delete a TicketFields:

DELETE FROM TicketFields WHERE Id = 100

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Bigint	True	ID of the ticket field.
Choices	String	False	List of values supported by the field.
CreatedAt	Datetime	True	Ticket field creation timestamp.
CustomersCanEdit	Boolean	False	Set to true if the field can be updated by customers.
Default	Boolean	True	Set to true if the field is not a custom field.
Description	String	True	Description of the ticket field
DisplayedToCustomers	Boolean	False	Set to true if the field is displayed in the customer portal.
Label	String	False	Display name for the field (as seen by agents).
LabelForCustomers	String	False	Display name for the field (as seen in the customer portal).
Name	String	True	Name of the ticket field.
NestedTicketFields	String	True	Applicable only for dependent fields, this contain details of nested fields.
PortalCc	Boolean	True	Applicable only for the requester field. Set to true if customer can add additional requesters to a ticket.
PortalCcTo	String	True	Applicable only if portal_cc is set to true. Value will be 'all' when a customer can add any requester to the CC list and 'company' when a customer can add only company contacts to the CC list.
Position	Integer	False	Position in which the ticket field is displayed in the form.
RequiredForAgents	Boolean	False	Set to true if the field is mandatory for Agents.
RequiredForClosure	Boolean	False	Set to true if the field is mandatory for closing the ticket.
RequiredForCustomers	Boolean	False	Set to true if the field is mandatory in the customer portal.
Type	String	False	For custom ticket fields, type of value associated with the field will be given (Available values are: custom_text, custom_paragraph, custom_checkbox, custom_number, custom_date, custom_decimal, nested_field, custom_dropdown, encrypted_text, secure_text)
UpdatedAt	Datetime	True	Ticket field updated timestamp.

Tickets

Create, update, delete, and query from tickets table

Table Specific Information

Select

The Cloud will use the Freshdesk API to process WHERE clause conditions built with the following columns and operators. Most of the columns support server side filtering with the following operators: =,>,<,<=,>=,AND,OR. The rest of the filter is executed client side within the Cloud. For example, the following query is processed server side:

SELECT * FROM Tickets WHERE Status = 2 AND (Priority = 1 OR Type = 'Other')

The API allows only a subset of columns to be used as filter criteria in the WHERE clause. The following columns can be used:

Id
AgentId
GroupId
Priority
Status
Tag
Type
DueBy
FirstResponseDueBy
CreatedAt
UpdatedAt

Insert

Email, Subject, Description, GroupId, Status and Priority are mandatory columns for Inserting/Creating a new ticket.

Every ticket uses fixed numerical values to denote its Status and Priority. Numerical values are given as:

Status:

Open = 2
Pending = 3
Resolved = 4
Closed = 5

Priority:

Low = 1
Medium = 2
High = 3
Urgent = 4

A new ticket can be inserted as following:

INSERT INTO Tickets (Description, Subject, Email,  GroupId, Status, Priority) VALUES ('Details about the issue...', 'New support needed...', '[email protected]', 12345, 3, 2)

Update

Following is an example to update a ticket:

UPDATE Tickets SET Priority = 1 WHERE Id = 100

Delete

Following is an example to delete a ticket:

DELETE FROM Tickets WHERE Id = 100

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	False	Unique ID of the ticket.
AssociationType	String	False	Association type of the ticket.
Archived	Boolean	False	Whether or not the ticket has been archived.
Attachments	String	False	attachments associated with ticket.
CcEmailsAggregate	String	False	Email address added in cc field.
CompanyId	Bigint	False	ID of the company to which ticket belongs.
CreatedAt	Datetime	False	Ticket creation timestamp.
CustomFields	String	False	Key value pairs containing the names and values of custom fields
Deleted	Boolean	False	Whether or not the ticket has been deleted.
Description	String	False	HTML content of the ticket.
DescriptionText	String	False	Text content of the ticket.
DueBy	Datetime	False	Timestamp that denotes when the ticket is due to be resolved.
Email	String	False	Email address of the requester.
EmailConfigId	Bigint	False	ID of the email config used for the ticket.
FacebookId	String	False	Facebook ID of the requester.
FirstResponseDueBy	Datetime	False	Time when first response is due.
FirstReSponseEscalated	Boolean	False	If ticket has been escalated as result of response.
FwdEmailsAggregate	String	False	Email address while forwarding a ticket.
GroupId	Bigint	False	Group ID to which the ticket has been assigned.
IsEscalated	Boolean	False	If ticket has been escalated for some reason.
Name	String	False	Name of the requester.
Phone	String	False	Phone number of the requester.
Priority	Integer	False	Priority of the ticket.
ProductId	Bigint	False	ID of the product associated with the ticket.
ReplyCcEmailsAggregate	String	False	Email address added while replying.
RequesterId	Bigint	False	ID of the requester of the ticket.
ResponderId	Bigint	False	ID of the agent assigned to the ticket.
Source	Integer	False	Channel throught which ticket was created.
Spam	Boolean	False	If ticket has been marked as spam.
Status	Integer	False	Status of the ticket.
Subject	String	False	Subject of the ticket.
TagsAggregate	String	False	Tags associated with ticket.
ToEmailsAggregate	String	True	Email address to which ticket was sent.
Type	String	False	Category/type of the ticket.
UpdatedAt	Datetime	True	Ticket updated timestamp.
AgentRespondedAt	Datetime	True	Timestamp for when agent last responded to the ticket
RequesterRespondedAt	Datetime	True	Timestamp for when Customer last responded to the ticket
FirstRespondedAt	Datetime	True	Timestamp for when agent first responded to the ticket
StatusUpdatedAt	Datetime	True	Timestamp for when status of the ticket was updated
ReopenedAt	Datetime	True	Timestamp for when the ticket was reopened
ResolvedAt	Datetime	True	Timestamp for when the ticket was resolved
ClosedAt	Datetime	True	Timestamp for when the ticket was closed
PendingSince	Datetime	True	Timestamp since the ticket is pending

TicketUpdatesAutomationRules

Create, update, delete, and query from TicketUpdatesAutomationRules table

Table Specific Information

Note: Only users with admin privileges can access the following Table.

Select

Following is an example to select all entries from TicketUpdatesAutomationRules table:

SELECT * FROM TicketUpdatesAutomationRules

The API allows only a subset of columns to be used as filter criteria in the WHERE clause. The filters listed can also be combined using AND OR. The following columns can be used:

Id

Insert

Name, Actions, Conditions, Performer, and Events are mandatory to Insert into TicketUpdatesAutomationRules table. For instance:

INSERT INTO TicketUpdatesAutomationRules (Name, Actions, Conditions, Performer, Events) VALUES ('Test', '[{"field_name": "status", "value": 5}]', '[{"name": "condition_set_1", "match_type": "any", "properties": [{"field_name": "to_email", "resource_type": "ticket", "operator": "contains", "value": ["@lyftron.com"]}]}]', '{"type": 1}', '[{"field_name": "reply_sent"}]')

Update

Following is an example of how to update TicketUpdatesAutomationRules table:

UPDATE TicketUpdatesAutomationRules SET Name = 'Test2' WHERE Id = '2043002030021'

Delete

Following is an example of how to delete from the TicketUpdatesAutomationRules table:

DELETE FROM TicketUpdatesAutomationRules WHERE Id = '2043002030021'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Bigint	False	Unique ID of the TicketUpdatesAutomationRule.
Actions	String	False	Actions of the TicketUpdatesAutomationRule.
Active	Boolean	False	Active of the TicketUpdatesAutomationRule.
AffectedTicketsCount	Int	False	AffectedTicketsCount of the TicketUpdatesAutomationRule.
Conditions	String	False	Conditions of the TicketUpdatesAutomationRule.
Events	String	False	Events of the TicketUpdatesAutomationRule.
Name	String	False	Name of the TicketUpdatesAutomationRule.
Outdated	Boolean	True	Outdated of the TicketUpdatesAutomationRule.
Performer	String	False	Performer of the TicketUpdatesAutomationRule.
Position	Int	False	Position of the TicketUpdatesAutomationRule.
Summary	String	True	Summary of the TicketUpdatesAutomationRule.
CreatedAt	Datetime	True	TicketUpdatesAutomationRule creation timestamp.
UpdatedAt	Datetime	True	TicketUpdatesAutomationRule updated timestamp.

TimeEntries

Create, update, delete, and query from TimeEntries table

Table Specific Information

Select

Following is an example to select all entries from TimeEntries table:

SELECT * FROM TimeEntries

The API allows only a subset of columns to be used as filter criteria in the WHERE clause. The following columns can be used:

AgentId
Billable
ExecutedAt

Insert

TicketId is mandatory to INSERT into the TimeEntries table. For instance:

INSERT INTO TimeEntries (TicketId, Note, AgentId) VALUES ('255', 'Invoice Information', '122')

Note:

The TicketId is required field to INSERT into TimeEntries table.
Default value for Billable is true.
If the TimeSpent attribute and the TimerRunning attribute are not specified, then the TimerRunning attribute will automatically be set to 'true'.
If the StartTime is specified and the TimerRunning attribute is not specified, then the TimerRunning attribute will automatically be set to 'true'.
The StartTime cannot be greater than the current time.
The StartTime cannot be given in the query if the TimerRunning attribute is set to 'false'

Update

Following is an example of how to update TimeEntries table:

UPDATE TimeEntries SET Billable = 'true' WHERE Id = 786

Note:

The StartTime cannot be updated if the timer is already running.
The StartTime cannot be be updated unless the timer_running attribute is updated from 'true' to 'false'.
The StartTime cannot be greater than the current time.
The TimerRunning attribute cannot be set to the same value as before.
The AgentId cannot be updated if the timer is already running.

Delete

Following is an example of how to delete from the TimeEntries table:

DELETE FROM TimeEntries WHERE Id = 786

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Bigint	False	Unique ID of the time entry.
AgentId	Bigint	False	The ID of the agent to whom this time-entry is associated.
Billable	Boolean	False	Set to true if the time entry is billable.
ExecutedAt	Datetime	False	Time at which this time-entry was added/created.
Note	String	False	Description of the time entry.
StartTime	Datetime	False	The time at which the time-entry is added or the time of the last invoked 'start-timer' action using a toggle.
TicketId	Bigint	True	The ID of the ticket to which this time entry is associated.
TimeSpent	String	False	The duration in hh:mm format.
TimerRunning	Boolean	False	True if the timer is currently running.
CreatedAt	Datetime	True	Time Entry created timestamp.
UpdatedAt	Datetime	True	Time Entry updated timestamp.

TimeTriggersAutomationRules

Create, update, delete, and query from TimeTriggersAutomationRules table

Table Specific Information

Note: Only users with admin privileges can access the following Table.

Select

Following is an example to select all entries from TimeTriggersAutomationRules table:

SELECT * FROM TimeTriggersAutomationRules

The API allows only a subset of columns to be used as filter criteria in the WHERE clause. The filters listed can also be combined using AND OR. The following columns can be used:

Id

Insert

Name, Actions, and Conditions are mandatory to Insert into TimeTriggersAutomationRules table. For instance:

INSERT INTO TimeTriggersAutomationRules (Name, Actions, Conditions) VALUES ('Test', '[{"field_name": "status", "value": 5}]', '[{"name": "condition_set_1", "match_type": "any", "properties": [{"field_name": "to_email", "resource_type": "ticket", "operator": "contains", "value": ["@lyftron.com"]}]}]')

Update

Following is an example of how to update TimeTriggersAutomationRules table:

UPDATE TimeTriggersAutomationRules SET Name = 'Test2' WHERE Id = '2043002030021'

Delete

Following is an example of how to delete from the TimeTriggersAutomationRules table:

DELETE FROM TimeTriggersAutomationRules WHERE Id = '2043002030021'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Bigint	False	Unique ID of the TimeTriggersAutomationRule.
Actions	String	False	Actions of the TimeTriggersAutomationRule.
Active	Boolean	False	Active of the TimeTriggersAutomationRule.
AffectedTicketsCount	Int	False	AffectedTicketsCount of the TimeTriggersAutomationRule.
Conditions	String	False	Conditions of the TimeTriggersAutomationRule.
Name	String	False	Name of the TimeTriggersAutomationRule.
Outdated	Boolean	True	Outdated of the TimeTriggersAutomationRule.
Position	Int	False	Position of the TimeTriggersAutomationRule.
Summary	String	True	Summary of the TimeTriggersAutomationRule.
CreatedAt	Datetime	True	TimeTriggersAutomationRule creation timestamp.
UpdatedAt	Datetime	True	TimeTriggersAutomationRule updated timestamp.

ビュー

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

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

CData Cloud - Freshdesk ビュー


Name	Description
BusinessHours	Query from BusinessHours table
CustomObjects	Retrieve the available Custom Objects in FreshDesk.
Products	Query from products table
Surveys	Query from surveys table
TicketActivities	Query the TicketActivities view.
TicketProperties	Query the TicketProperties view.

BusinessHours

Query from BusinessHours table

Table Specific Information

Note: Only users with admin privileges can access the following Table.

Select

Following is an example to select all entries from BusinessHours table:

SELECT * FROM BusinessHours

You can also select a specific entry from BusinessHours table:

SELECT * FROM BusinessHours WHERE Id = 100

Columns


Name	Type	Description
Id [KEY]	Bigint	Business hour ID.
Description	String	Description of the business hour.
Name	String	Name of the business hour.
IsDefault	Boolean	True if this is the default business hour.
TimeZone	String	Denotes the time zone of the business hour.
business_hours	String	Collection of start time and end time of days of a week.
CreatedAt	Datetime	Business hour creation timestamp.
UpdatedAt	Datetime	Business hour updated timestamp.

CustomObjects

Retrieve the available Custom Objects in FreshDesk.

Table Specific Information

Select

Following is an example to select all entries from the CustomObjects table:

SELECT * FROM CustomObjects

You can also select a specific entry from the CustomObjects table:

SELECT * FROM CustomObjects WHERE Id = 11704

Columns


Name	Type	Description
Name	String	Name of the custom object.
Id [KEY]	Bigint	Id of the custom object.
Fields	String	Fields of the custom object.
Description	String	Description of the custom object.

Products

Query from products table

Table Specific Information

Note: Only users with admin privileges can access the following Table.

Select

Following is an example to select all entries from Products table:

SELECT * FROM Products

You can also select a specific entry from Products table:

SELECT * FROM Products WHERE Id = 100

Columns


Name	Type	Description
Id [KEY]	Bigint	Product ID.
Description	String	Description of the product.
Name	String	Name of the product.
CreatedAt	Datetime	Product creation timestamp.
UpdatedAt	Datetime	Product updated timestamp.

Surveys

Query from surveys table

Table Specific Information

Select

Following is an example to select all entries from Surveys table:

SELECT * FROM Surveys

You can also select a specific entry from Surveys table:

SELECT * FROM Surveys WHERE Id = 73000092562

Columns


Name	Type	Description
Id [KEY]	Bigint	Survey ID.
Title	String	Title of the survey.
Questions	String	Questions associated with the survey.
CreatedAt	Datetime	Survey creation timestamp.
UpdatedAt	Datetime	Survey updated timestamp.

TicketActivities

Query the TicketActivities view.

Table Specific Information

Select

Following is an example to select all entries from the TicketActivities table:

SELECT * FROM TicketActivities

Columns


Name	Type	Description
TicketId	Bigint	Ticket Id of the ticket activity.
PerformerId	Bigint	Performer Id of the ticket activity.
PerformerType	String	Performer Type of the ticket activity.
PerformedAt	Datetime	Performed At of the ticket activity.
Status	String	Status of the ticket activity.
AgentId	Bigint	Agent Id of the ticket activity.
Group	String	Status of the ticket activity.
Priority	String	Priority of the ticket activity.
RequesterId	Bigint	Requester Id of the ticket activity.
TicketType	String	Ticket Type of the ticket activity.
Source	String	Source of the ticket activity.

TicketProperties

Query the TicketProperties view.

Table Specific Information

Select

Following is an example to select all entries from the TicketProperties table:

SELECT * FROM TicketProperties

Columns


Name	Type	Description
TicketId	Bigint	Ticket Id of the ticket property.
Subject	String	Subject of the ticket property.
Status	String	Status of the ticket property.
Priority	String	Priority of the ticket property.
Source	String	Source of the ticket property.
TicketType	String	Ticket type of the ticket property.
AssociationType	String	Association type of the ticket property.
AgentName	String	Agent name of the ticket property.
ResolutionDueBy	Datetime	Resolution Due By of the ticket property.
FirstAssignedDate	Datetime	First Assigned Date of the ticket property.
CreatedDate	Datetime	Created Date of the ticket property.
FirstResponseDueBy	Datetime	First Response Due By of the ticket property.
AgentReplyCount	Bigint	Agent Reply Count of the ticket property.
CustomerReplyCount	Bigint	Customer Reply Count of the ticket property.
LastUpdatedDate	Datetime	Last Updated Date of the ticket property.
ResolvedDate	Datetime	Resolved Date of the ticket property.
ClosedDate	Datetime	Closed Date of the ticket property.
FirstResponseDate	Datetime	First Response Date of the ticket property.
ReferenceNumber	String	Reference Number of the ticket property.
RequesterName	String	Requester name of the ticket property.
RequesterEmail	String	Requester email of the ticket property.
RequesterType	String	Requester type of the ticket property.
RequesterLanguage	String	Requester language of the ticket property.
CompanyName	String	Company name of the ticket property.
GroupName	String	Group name of the ticket property.
AssignType	String	Assign type of the ticket property.
Product	String	Product of the ticket property.
FirstAssignedGroup	String	First Assigned Group of the ticket property.
LastUpdatedAgent	String	Last Updated Agent of the ticket property.
FirstAssignedAgent	String	First Assigned Agent of the ticket property.
AgentEmail	String	Agent email of the ticket property.
TicketsAge	Bigint	Tickets Age of the ticket property.
FirstResponseGroup	String	First Response Group of the ticket property.
FirstAssignTimeInCalendarHours	Bigint	First Assign Time In Calendar Hours of the ticket property.
FirstResponseTimeInCalendarHours	Bigint	First Response Time In Calendar Hours of the ticket property.
FirstResponseTimeInBusinessHours	Bigint	First Response Time In Business Hours of the ticket property.
IsSpam	Boolean	Is Spam of the ticket property.
ResolutionTimeInCalendarHours	Bigint	Resolution Time In Calendar Hours of the ticket property.
ResolutionTimeInBusinessHours	Bigint	Resolution Time In Business Hours of the ticket property.
NoOfGroupReassignsTillDate	Bigint	No Of Group Reassigns Till Date of the ticket property.
NoOfTimesReopened	Bigint	No Of Times Reopened of the ticket property.
IsTrash	Boolean	Is Trash of the ticket property.
LastAssignedDate	Datetime	Last Assigned Date of the ticket property.
FirstAssignTimeInBusinessHours	Bigint	First Assign Time In Business Hours of the ticket property.
NoOfAgentReassignsTillDate	Bigint	No Of Agent Reassigns Till Date of the ticket property.
AgentLanguage	String	Agent language of the ticket property.
AgentTimezone	String	Agent timezone of the ticket property.
InternalGroupName	String	Internal group name of the ticket property.
InternalAgentName	String	Internal agent name of the ticket property.
StatusSLATimer	Boolean	Status SLA Timer of the ticket property.
TicketsResolvedWithinFCR	String	Tickets Resolved Within FCR of the ticket property.
TicketsResolvedWithinSLA	String	Tickets Resolved Within SLA of the ticket property.
TicketsFirstRespondedWithinSLA	String	Tickets First Responded Within SLA of the ticket property.
FirstResponseAgent	String	First Response Agent of the ticket property.
TicketsNextRespondedWithinSLA	String	Tickets Next Responded Within SLA of the ticket property.
SkillName	String	Skill Name of the ticket property.
SurveyResultsEmotion	String	Survey Results Emotion of the ticket property.
SurveyResultsSurveyStatus	String	Survey Results Survey Status of the ticket property.
SurveyResultsChoices	String	Survey Results Choices of the ticket property.
SurveyResultsRespondedDate	Datetime	Survey Results Responded Date of the ticket property.
SurveyResultsSurveyName	String	Survey Results Survey Name of the ticket property.
SurveyResultsSentVia	String	Survey Results Sent Via of the ticket property.
SurveyResultsSurveyCreatedDate	Datetime	Survey Results Survey Created Date of the ticket property.
SurveyResultsQuestion	String	Survey Results Question of the ticket property.
SurveyResultsAgentName	String	Survey Results Agent Name of the ticket property.
SurveyResultsGroupName	String	Survey Results Group Name of the ticket property.
SurveyResultsCustomer	String	Survey Results Customer of the ticket property.
SurveyResultsDefaultSurvey	String	Survey Results Default Survey of the ticket property.
SurveyResultsSurveySentDate	Datetime	Survey Results Survey Sent Date of the ticket property.
SurveyUpdatedDate	Datetime	Survey Updated Date of the ticket property.
SurveySentDate	Datetime	Survey Sent Date of the ticket property.
SurveySurveyStatus	String	Survey Survey Status of the ticket property.
SurveySurveyName	String	Survey Survey Name of the ticket property.
SurveyDefaultSurvey	String	Survey Default Survey of the ticket property.
TicketThemeKeywords	String	Ticket Theme Keywords of the ticket property.
TicketThemeName	String	Ticket Theme Name of the ticket property.
TagName	String	Tag Name of the ticket property.
ContactsType	String	Contacts Type of the ticket property.
ContactsEmail	String	Contacts Email of the ticket property.
ContactsName	String	Contacts Name of the ticket property.
ContactsLanguage	String	Contacts Language of the ticket property.
ContactsTimeZone	String	Contacts Time Zone of the ticket property.
ContactsMobile	String	Contacts Mobile of the ticket property.
ContactsMobileNumber	String	Contacts Mobile Number of the ticket property.
CompanyIndustry	String	Company Industry of the ticket property.
CompanyRenewalDate	Datetime	Company Renewal Date of the ticket property.
CompanyAccountTier	String	Company Account Tier of the ticket property.
CompanyHealthScore	String	Company Health Score of the ticket property.
CannedResponseUsedAt	Datetime	Canned Response Used At of the ticket property.
CannedResponseTicketID	String	Canned Response Ticket ID of the ticket property.
CannedResponseCannedResponseTitle	String	Canned Response Canned Response Title of the ticket property.
CannedResponseNoteType	String	Canned Response Note Type of the ticket property.
CannedResponseAgent	String	Canned Response Agent of the ticket property.
CannedResponseAgentType	String	Canned Response Agent Type of the ticket property.
CannedResponseCannedResponseVisibility	String	Canned Response Canned Response Visibility of the ticket property.
CannedResponseCannedResponseCreatedAt	Datetime	Canned Response Canned Response Created At of the ticket property.
CannedResponseAgentGroup	String	Canned Response Agent Group of the ticket property.
CannedResponseFolder	String	Canned Response Folder of the ticket property.
CannedResponseCannedResponseUpdatedAt	Datetime	Canned Response Canned Response Updated At of the ticket property.
CannedResponseCannedResponseAuthor	String	Canned Response Canned Response Author of the ticket property.

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、Freshdesk の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにFreshdesk から関連するレスポンスデータを返します。

CData Cloud - Freshdesk ストアドプロシージャ


Name	Description
AttachToTicket	Create or update a ticket with attachments.
CreateNote	Create a note for a ticket.

AttachToTicket

Create or update a ticket with attachments.

To edit an existing ticket, supply a value for the Id column:

EXEC AttachToTicket Id = 100000 FullPath = 'C:/Users/Public/A.txt,C:/Users/Public/B.txt', FileName = 'Attachment1,Attachment2'

You can also supply ticket fields to update the ticket alongside adding attachments:

EXEC AttachToTicket Id = 100000, Status = 3, FullPath = 'C:/Users/Public/A.txt,C:/Users/Public/B.txt', FileName = 'Attachment1,Attachment2'

If you do not include a value for the Id column, the Cloud creates a new ticket with the provided values. At a minimum, you must provide an Email, Description, Subject, Status, and Priority. Other fields may be required for ticket creation based on the ticket rules set up on your Freshdesk account.

EXEC AttachToTicket Email = '[email protected]', Description = 'Sample Description', GroupId = 2222222222222, Status = 3, Subject = 'Testing', Priority = 3, FullPath = 'C:/Users/Public/A.txt,C:/Users/Public/B.txt', FileName = 'Attachment1,Attachment2'

Input


Name	Type	Required	Description
Id	String	False	The Id of the ticket. If specified, it is treated as an update. If not, specified, it is treated as an insert.
Email	String	False	The Email of the ticket.
Description	String	False	The Description of the ticket.
Subject	String	False	The Subject of the ticket.
Status	String	False	The Status of the ticket.
Priority	String	False	The Priority of the ticket.
GroupId	String	False	The GroupId of the ticket.
FullPath#	String	True	A comma-separated list of the full file paths of attachments to upload.
FileName#	String	True	A comma-separated list of the file names you would like to give the attachments.

CreateNote

Create a note for a ticket.

Input


Name	Type	Required	Description
Id	String	True	The Id of the ticket.
Attachments	String	False	The attachments. Specify File attachments in the following format: filename1,filecontent1;filename2,filecontent2.
Body	String	True	Content of the note in HTML.
Incoming	String	False	Should note appear as being created from outside. Default is False.
NotifyEmails	String	False	A comma-separated list of email addresses of agents/users who need to be notified about the note.
Private	String	False	should note be private. Default is True.
UserId	String	False	Id of the agent/user who is adding the note.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether the note was successfully created.

システムテーブル

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、Freshdesk のデータベースメタデータを返します。

sys_catalogs：利用可能なデータベースをリスト。
sys_schemas：利用可能なスキーマをリスト。
sys_tables：利用可能なテーブルおよびビューをリスト。
sys_tablecolumns：利用可能なテーブルおよびビューのカラムについて説明。
sys_procedures：利用可能なストアドプロシージャについて説明。
sys_procedureparameters：ストアドプロシージャパラメータについて説明。
sys_keycolumns：主キーおよび外部キーについて説明。
sys_indexes：利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

sys_connection_props：利用可能な接続プロパティについての情報を返す。
sys_sqlinfo：Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

sys_identity：バッチ処理または単一の更新に関する情報を返す。

sys_catalogs

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	データベース名。

sys_schemas

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas

Columns


Name	Type	Description
CatalogName	String	データベース名。
SchemaName	String	スキーマ名。

sys_tables

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables

Columns


Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベース。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	テーブル名またはビュー名。
TableType	String	テーブルの種類（テーブルまたはビュー）。
Description	String	テーブルまたはビューの説明。
IsUpdateable	Boolean	テーブルが更新可能かどうか。

sys_tablecolumns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、Tickets テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Tickets'

Columns


Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベースの名前。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	カラムを含むテーブルまたはビューの名前。
ColumnName	String	カラム名。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	カラムのストレージサイズ。
DisplaySize	Int32	指定されたカラムの通常の最大幅（文字数）。
NumericPrecision	Int32	数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	カラムのスケール（小数点以下の桁数）。
IsNullable	Boolean	カラムがNull を含められるかどうか。
Description	String	カラムの簡単な説明。
Ordinal	Int32	カラムのシーケンスナンバー。
IsAutoIncrement	String	カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn	String	生成されたカラムであるかどうか。
IsHidden	Boolean	カラムが非表示かどうか。
IsArray	Boolean	カラムが配列かどうか。
IsReadOnly	Boolean	カラムが読み取り専用かどうか。
IsKey	Boolean	sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType	String	スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。

sys_procedures

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures

Columns


Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベース。
SchemaName	String	ストアドプロシージャを含むスキーマ。
ProcedureName	String	ストアドプロシージャの名前。
Description	String	ストアドプロシージャの説明。
ProcedureType	String	PROCEDURE やFUNCTION などのプロシージャのタイプ。

sys_procedureparameters

ストアドプロシージャパラメータについて説明します。

次のクエリは、SampleProcedure ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SampleProcedure' AND Direction = 1 OR Direction = 2

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SampleProcedure' AND IncludeResultColumns='True'

Columns


Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベースの名前。
SchemaName	String	ストアドプロシージャを含むスキーマの名前。
ProcedureName	String	パラメータを含むストアドプロシージャの名前。
ColumnName	String	ストアドプロシージャパラメータの名前。
Direction	Int32	パラメータのタイプに対応する整数値：input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName	String	データ型の名前。
NumericPrecision	Int32	数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ（文字数）。
Length	Int32	文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale	Int32	数値データの小数点以下の桁数。
IsNullable	Boolean	パラメータがNull を含められるかどうか。
IsRequired	Boolean	プロシージャの実行にパラメータが必要かどうか。
IsArray	Boolean	パラメータが配列かどうか。
Description	String	パラメータの説明。
Ordinal	Int32	パラメータのインデックス。
Values	String	このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams	Boolean	パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath	Boolean	パラメータがスキーマ作成操作のターゲットパスかどうか。
Default	String	何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName	String	複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided	Boolean	プロシージャがネイティブのFreshdesk プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns


Name	Type	Description
IncludeResultColumns	Boolean	出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

sys_keycolumns

主キーおよび外部キーについて説明します。

次のクエリは、Tickets テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Tickets'

Columns


Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前
IsKey	Boolean	カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey	Boolean	カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName	String	主キーの名前。
ForeignKeyName	String	外部キーの名前。
ReferencedCatalogName	String	主キーを含むデータベース。
ReferencedSchemaName	String	主キーを含むスキーマ。
ReferencedTableName	String	主キーを含むテーブル。
ReferencedColumnName	String	主キーのカラム名。

sys_foreignkeys

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

カラム


名前	タイプ	説明
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前
PrimaryKeyName	String	主キーの名前。
ForeignKeyName	String	外部キーの名前。
ReferencedCatalogName	String	主キーを含むデータベース。
ReferencedSchemaName	String	主キーを含むスキーマ。
ReferencedTableName	String	主キーを含むテーブル。
ReferencedColumnName	String	主キーのカラム名。
ForeignKeyType	String	外部キーがインポート（他のテーブルを指す）キーかエクスポート（他のテーブルから参照される）キーかを指定します。

sys_primarykeys

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys

Columns


Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前。
KeySeq	String	主キーのシーケンス番号。
KeyName	String	主キーの名前。

sys_indexes

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


Name	Type	Description
CatalogName	String	インデックスを含むデータベースの名前。
SchemaName	String	インデックスを含むスキーマの名前。
TableName	String	インデックスを含むテーブルの名前。
IndexName	String	インデックス名。
ColumnName	String	インデックスに関連付けられたカラムの名前。
IsUnique	Boolean	インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary	Boolean	インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type	Int16	インデックスタイプに対応する整数値：statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder	String	並べ替え順序：A が昇順、D が降順。
OrdinalPosition	Int16	インデックスのカラムのシーケンスナンバー。

sys_connection_props

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


Name	Type	Description
Name	String	接続プロパティ名。
ShortDescription	String	簡単な説明。
Type	String	接続プロパティのデータ型。
Default	String	明示的に設定されていない場合のデフォルト値。
Values	String	可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value	String	設定した値またはあらかじめ設定されたデフォルト。
Required	Boolean	プロパティが接続に必要かどうか。
Category	String	接続プロパティのカテゴリ。
IsSessionProperty	String	プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity	String	プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName	String	キャメルケースの短縮形の接続プロパティ名。
Ordinal	Int32	パラメータのインデックス。
CatOrdinal	Int32	パラメータカテゴリのインデックス。
Hierarchy	String	このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible	Boolean	プロパティが接続UI に表示されるかどうかを通知します。
ETC	String	プロパティに関するその他のさまざまな情報。

sys_sqlinfo

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。


名前	説明	有効な値
AGGREGATE_FUNCTIONS	サポートされている集計関数。	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	COUNT 関数がサポートされているかどうか。	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	識別子をエスケープするための開始文字。	[
IDENTIFIER_QUOTE_CLOSE_CHAR	識別子をエスケープするための終了文字。	]
SUPPORTED_OPERATORS	サポートされているSQL 演算子。	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	サポートされている外部結合の種類。	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	外部結合がサポートされているかどうか。	YES, NO
SUBQUERIES	サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	サポートされている文字列関数。	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	サポートされている数値関数。	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	サポートされている日付および時刻関数。	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	レプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNS	レプリケーション中に更新判断のカラムとして使用するかどうかを、（指定された順に）チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN	識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTION	プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。	YES, NO
DIALECT	使用するSQL ダイアレクトを示します。
KEY_PROPERTIES	Uniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMAS	プロバイダー用に複数のスキームが存在するかどうかを示します。	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	プロバイダー用に複数のカタログが存在するかどうかを示します。	YES, NO
DATASYNCVERSION	このドライバーにアクセスするために必要な、CData Sync のバージョン。	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	このドライバーのCData Sync カテゴリ。	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	API で提供されている以上の、追加SQL 機能がサポートされているかどうか。	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	バッチ操作がサポートされているかどうか。	YES, NO
SQL_CAP	このドライバーでサポートされているすべてのSQL 機能。	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERY	ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。	YES, NO
PSEUDO_COLUMNS	利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS	値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	レプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTION	サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATE	レプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERY	レプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTION	サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTID	CheckCache 構文を親キーカラムに対して実行するかどうかを示します。	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	スキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデルセクションを参照してください。

Columns


Name	Type	Description
NAME	String	SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE	String	サポートされるSQL またはSQL 構文の詳細。

sys_identity

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity

Columns


Name	Type	Description
Id	String	データ変更処理から返された、データベース生成Id。
Batch	String	バッチの識別子。1 は単一処理。
Operation	String	バッチ内の処理の結果：INSERTED、UPDATED、またはDELETED。
Message	String	SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

sys_information

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns


Name	Type	Description
Product	String	製品名。
Version	String	製品のバージョン番号。
Datasource	String	製品が接続するデータソースの名前。
NodeId	String	製品がインストールされているマシンの固有識別子。
HelpURL	String	製品のヘルプドキュメントのURL。
License	String	製品のライセンス情報。（この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。）
Location	String	製品のライブラリが格納されているファイルパスの場所。
Environment	String	製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersion	String	本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategory	String	CData Sync 機能のカテゴリ（例：Source、Destination）。

接続文字列オプション

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

Authentication

プロパティ	説明
Domain	Domain is used for accessing your Freshdesk account.
APIKey	The API key used for accessing your Freshdesk account.

SSL

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

Logging

プロパティ	説明
Verbosity	ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema

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

Miscellaneous

プロパティ	説明
FetchTicketsUpdatedSince	Use FetchTicketsUpdatedSince to query tickets older than 30 days. Note: TicketStats must be set to True.
IgnoreSurplusResults	Use IgnoreSurplusResults to ignore results beyond 300 which have same CreatedAt value.
IncludeCustomObjects	Whether to include custom objects or not.
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
RowScanDepth	Set this property to control the number of rows scanned when TypeDetectionScheme is set to RowScan.
TicketPropertiesURL	Use TicketPropertiesURL to query ticket properties.
TicketsOrderByField	Determines which ticket field to order by.
TicketsOrderByType	Determines which ticket field to order by.
TicketStats	Use TicketsStats to retrieve stats attributes of a ticket, which are not normally available.
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
TypeDetectionScheme	Determines how to determine the data type of columns.

Authentication

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

プロパティ	説明
Domain	Domain is used for accessing your Freshdesk account.
APIKey	The API key used for accessing your Freshdesk account.

Domain

Domain is used for accessing your Freshdesk account.

データ型

string

デフォルト値

""

解説

Domain is used for accessing your Freshdesk account. For example, in your URL: https://{domainValue}.freshdesk.com, thus connection string should be:

Domain=domainValue

APIKey

The API key used for accessing your Freshdesk account.

データ型

string

デフォルト値

""

解説

The API key used for accessing your Freshdesk account. The API key can be found in Freshdesk by going to Profile Settings -> API Key.

SSL

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

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

SSLServerCert

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

データ型

string

デフォルト値

""

解説

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`

Note：'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

Logging

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

プロパティ	説明
Verbosity	ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。より高いVerbosity レベルは主にデバッグを目的としています。各レベルの詳細については、ログを参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

Schema

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

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

BrowsableSchemas

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

データ型

string

デフォルト値

""

解説

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

Miscellaneous

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

プロパティ	説明
FetchTicketsUpdatedSince	Use FetchTicketsUpdatedSince to query tickets older than 30 days. Note: TicketStats must be set to True.
IgnoreSurplusResults	Use IgnoreSurplusResults to ignore results beyond 300 which have same CreatedAt value.
IncludeCustomObjects	Whether to include custom objects or not.
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
RowScanDepth	Set this property to control the number of rows scanned when TypeDetectionScheme is set to RowScan.
TicketPropertiesURL	Use TicketPropertiesURL to query ticket properties.
TicketsOrderByField	Determines which ticket field to order by.
TicketsOrderByType	Determines which ticket field to order by.
TicketStats	Use TicketsStats to retrieve stats attributes of a ticket, which are not normally available.
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
TypeDetectionScheme	Determines how to determine the data type of columns.

解説

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

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください：

*=*

RowScanDepth

Set this property to control the number of rows scanned when TypeDetectionScheme is set to RowScan.

データ型

string

デフォルト値

"30"

解説

Determines the number of rows used to determine the column data types.

int

デフォルト値

60

解説

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

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note： このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

TypeDetectionScheme

Determines how to determine the data type of columns.

Possible Values

None, RowScan

データ型

string

デフォルト値

"RowScan"

解説


None	Setting TypeDetectionScheme to None will return all columns as the string type.
RowScan	Setting TypeDetectionScheme to RowScan will scan rows to heuristically determine the data type. The RowScanDepth determines the number of rows to be scanned.

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Cloud

Freshdesk - CData Cloud

概要

主要機能

はじめに

Freshdesk への接続

CData Cloud サービスからデータにアクセス

接続の確立

Connecting to Freshdesk

SSL の設定

SSL 設定のカスタマイズ

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

Firewall またはProxy 経由の接続

HTTP プロキシ

その他のプロキシ

データモデル

Overview

Key Features

Tables

テーブル

CData Cloud - Freshdesk テーブル

Agents

Table Specific Information

Select

Update

Delete

Columns

CannedResponses

Table Specific Information

Select

Insert

Update

Columns

CannedResponsesFolder

Table Specific Information

Select

Insert

Update

Columns

Companies

Table Specific Information

Select

Insert

Update

Delete

Columns

Contacts

Table Specific Information

Select

Additional Filtering

Insert

Update

Delete

Columns

Conversations

Table Specific Information

Select

Delete

Columns

Groups

Table Specific Information

Select

Insert

Update

Delete

Columns

Mailboxes

Table Specific Information

Select

Insert

Update

Delete

Columns

Roles

Table Specific Information

Select

Columns

Skills

Table Specific Information

Select