Zoho CRM への接続を追加

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

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

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

Zoho CRM への接続

• Region：Zoho CRM サーバーURL のドメインに関連付けられたリージョン。
• Schema：Zoho CRM のバージョン（v2、v2.1、またはv4）。Zoho CRM のバージョンごとに独自のデータモデルがあります。

Zoho CRM への認証

デスクトップ経由で自分のローカルデータに認証を行う場合（非ブラウザ接続）は、CData が提供する埋め込みOAuth アプリケーションを使用します。

Sync App はすでにZoho CRM にOAuth アプリケーションとして登録されています。そのため、デスクトップアプリケーションを介したローカルデータへの接続には自動的に組み込みアプリケーションが使用されます。

OAuth 交換の繰り返しを避け、ローカルデータにアクセスするたびにOAuthAccessToken を手動で設定する必要がないようにするには、InitiateOAuth をGETANDREFRESH に設定します。

Note： Zoho CRM Sync App はパフォーマンスを向上させるためにデフォルトでUseServerSideFiltering がTrue に設定されていますが、この設定は誤った結果を返す場合があります。

ネットワーク経由で共有データに認証を行う場合（ブラウザ接続）は、カスタムOAuth アプリケーションを使用します。すべてのOAuth フローで、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。

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

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

カスタムOAuth アプリケーションの作成についての情報と、埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、カスタムOAuth アプリケーションの作成 を参照してください。

Zoho CRM で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

アクセストークンの期限が切れたときは、Sync App は自動でアクセストークンをリフレッシュします。

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

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

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

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

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

1. ExpiresIn 期間（ が返す）が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
2. 次の接続プロパティを設定します。
   • OAuthClientId：アプリケーション設定のクライアントId。
   • OAuthClientSecret：アプリケーション設定のクライアントシークレット。

3. RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
4. 新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

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

ユーザー定義ビュー

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

SSL の設定

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

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

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

クエリ処理

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

ログ

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 はZoho CRM モジュールをリレーショナルテーブルとしてモデル化します。

サポート対象の各API バージョン、v2、v2.1、v4 には、それぞれ独自のデータモデルが割り当てられています。

CData Sync App データモデル

バッチ操作

ZohoCRM のAPI がサポートする最大バッチサイズは100であるため、BatchSize 接続プロパティの推奨値も同じくこの値です。これより大きな値を使用してもSync App のパフォーマンスが向上することはないため、推奨されません。

CData Sync App models Zoho CRM Modules as relational tables.

Zoho CRM APIs

The Zoho CRM Sync App supports the following APIs to query data from the source.

• Query API : Uses COQL to query data from Zoho CRM. To use this API, set UseCOQL to True.
• Bulk API : Uses the Bulk API to query data from Zoho CRM. To use this API, set UseCOQL to False and APIType to Bulk.
• REST API : Uses REST endpoints to query data from Zoho CRM. To use this API, set UseCOQL to False and APIType to REST.

API Limitations

V2 of Zoho CRM imposes limits on the maximum number of rows and columns that interfacing tools such as the CData Sync App can retrieve from its APIs.

The limits vary based on whether you're using the Query API, Bulk API, or REST API. These limits are:

• Query API: Maximum of 100,000 rows and 50 columns.
• Bulk API: Over 100,000 rows and no more than 200 columns.
• REST API: Maximum of 10,000 rows (no column limit).

API Metadata

The columns and values retrieved from tables and views vary based on whether you're using the Query API, Bulk API, or REST API. These variations are:

• Query API
  • For Lookup type columns, the *_Id is displayed and has a value, but *_Name doesn't appear.
  • For *Owner and *ModifiedBy columns, *_Id, *_firstname, and *_lastname are displayed and have values, but *_Name doesn't appear.
• Bulk API
  • For Lookup type columns, the *_Id and _Name are displayed, but only *_Id has a value.
  • For *Owner and *ModifiedBy columns, *_Id, *_Name, *_firstname, and *_lastname are displayed, but *_Name has no value.
• REST API
  • For Lookup type columns, the *_Id and _Name are displayed and both have values.
  • For *Owner and *ModifiedBy columns, *_Id, *_Name, *_firstname, and *_lastname are displayed, but *_firstname and *_lastname have no values.

Using Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to the Zoho CRM APIs and then processes the rest of the query within the Sync App. The following sections document API limitations and requirements.

Tables

The Sync App connects to Zoho CRM and retrieves the list of テーブル and the metadata for the tables by calling the appropriate Web services. Any changes you make to your Zoho CRM account, such as adding a custom module, adding a custom field, or changing the data type of a field, occur immediately when you connect using the Sync App. テーブル shows an example, based on the Zoho CRM development environment, of what the entities in your account may look like.

Note: The Bulk API is not supported by the Notes table. Due to this, if you are using the Bulk API, the Sync App will instead use the REST API (with its associated limitations) when working with notes data.

Views

Most ビュー are defined in static configuration files. Custom Views are not. Instead, custom views are dynamically retrieved by connecting to Zoho CRM, calling the appropriate Web service, and retrieving the list of custom views from the metadata returned. Any changes you make to your Zoho CRM account, such as adding a new custom view, occur immediately when you connect using the Sync App.

To use Custom Views, set the IncludeCustomViews property to true. Its default value is false since custom views introduce an overhead when retrieving the list of tables and views.

Criteria applied in the custom view (either when creating it or when editing it in the UI) will be preserved in CData Zoho CRM Sync App. Nonetheless, further filtering on records is available at any time.

To use Relative Views set the IncludeRelatedLists property to true. Its default value is false since related views introduce an overhead when retrieving the list of tables and views.

EntityId is required to fetch the related module data. This field refers to the parent module Id.

Stored Procedures

ストアドプロシージャ provides additional capabilities in the Zoho CRM API, including working with files.

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

Zoho CRM Connector for CData Sync テーブル

Create, update, delete, and query information regarding accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side. The rest of the filter is executed client-side within the Sync App.

Insert

INSERT INTO Accounts(AccountName) VALUES('my name') 

Required fields: AccountName.

Any field which is not read-only (ReadOnly = false in the table below below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Accounts WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Accounts SET Description = 'Updated from API' WHERE Id = '3152079000000153079'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns

Pseudo-Columns

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

Delete, and query information regarding activities.

Table-Specific Information

Select

The Sync App uses the Zoho CRM 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.

• DueDate supports the '=' operator.
• ClosedTime supports the '=' operator.
• Location supports the '=, LIKE' operators.
• From supports the '=' operator.
• To supports the '=' operator.
• Check-InTime supports the '=' operator.
• Check-InComment supports the '=, LIKE'.
• Check-InSub-Locality supports the '=, LIKE' operators.
• Check-InCity supports the '=, LIKE' operators.
• Check-InState supports the '=, LIKE' operators.
• Check-InCountry supports the '=, LIKE' operators.
• ZipCode supports the '=, LIKE' operators.
• Check-InAddress supports the '=, LIKE' operators.
• CheckedInStatus supports the '=, LIKE' operators.
• CallStartTime supports the '=' operator.
• CallDuration supports the '=, LIKE' operators.
• CallResult supports the '=, LIKE' operators.
• Reminder supports the '=, LIKE' operators.
• CallStatus supports the '=, LIKE' operators.
• Subject supports the '=, LIKE' operators.
• CreatedTime supports the '=' operator.
• ModifiedTime supports the '=' operator.
• ActivityType supports the '=, LIKE' operators.
• Description supports the '=, LIKE' operators.

For example, the following queries are processed server side:

SELECT * FROM Activities WHERE Id = '3152079000000154214'

SELECT * FROM Activities WHERE Subject = 'event'

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Activities WHERE Id = '3152079000000156229'

Columns

Pseudo-Columns

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

Delete, and query information regarding attachments.

Table-Specific Information

Select

The Sync App uses the Zoho CRM 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.

SELECT * FROM Attachments 

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Attachments WHERE Id = '3152079000000431011'

Columns

Pseudo-Columns

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

Create, update, delete, and query information regarding calls.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Calls (Subject, ModuleName, RelatedTo_Id,CallType,CallStartTime) VALUES ('A test call', 'Accounts', '5768552000000433001','Outbound','May 20, 2023 12:00 AM')

Required fields: Subject, ModuleName, CallType, CallStartTime and ContactName_Id if ModuleName = Contacts and RelatedTo_Id if any other modulename is specified.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Calls WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Calls SET Subject = 'Updated from API' WHERE Id = '3152079000000484001'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns

Pseudo-Columns

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

Create, update, delete, and query information regarding campaigns.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Campaigns (CampaignName) VALUES ('a test campaign') 

Required fields: CampaignName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Campaigns WHERE Id = '3152079000000485001'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Campaigns SET CampaignName = 'Updated from API' WHERE Id = '3152079000000485001'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns

Pseudo-Columns

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

Create, update, delete, and query information regarding cases.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Cases (Email, Priority, Description) VALUES ('[email protected]', 'Medium', 'A simple test case')

Required fields: None.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Cases WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Cases SET Priority = 'Low' WHERE Id = '3152079000000473022'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns

Pseudo-Columns

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

Get, add, update, or delete the list of contact roles

Table-Specific Information

Select

SELECT * FROM ContactRoles

Insert

Insert INTO ContactRoles(SequenceNumber, Name) VALUES(8, 'TEST3')

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM ContactRoles WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE ContactRoles SET Name='Sales Lead 1' where Id= '2732548000006917001'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns

Create, update, delete, and query information regarding contacts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Contacts (FirstName, LastName, Email) VALUES ('John', 'Smith', '[email protected]')

Required fields: LastName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Contacts WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Contacts SET Description = 'John helped us in the past with setting up the servers.' WHERE Id = '3152079000000484021'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns

Pseudo-Columns

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

Get, add or update currencies to your organization.

Table-Specific Information

Select

The Sync App uses the Zoho CRM 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.

• Id supports '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Currencies WHERE Id = '1234';

Insert

INSERT INTO Currencies (ISO_Code, Name, ExchangeRate) VALUES ('1234', 'hello','1.000');

Bulk Insert operation:

INSERT INTO Currencies#TEMP (id, Name, Symbol, IsActive, ExchangeRate, FormatDecimalSeparator, FormatThousandSeparator, FormatDecimalPlaces, PrefixSymbol, ISO_Code) VALUES ('4150868000000236307', 'cdata1','$','true','1.0000','period','comma','2','true','2');

INSERT INTO Currencies#TEMP (id, Name, Symbol, IsActive, ExchangeRate, FormatDecimalSeparator, FormatThousandSeparator, FormatDecimalPlaces, PrefixSymbol, ISO_Code) VALUES ('1234', 'cdata','$','true','2.0000','period','comma','3','true','3');

INSERT INTO Currencies (id, Name, Symbol, IsActive, ExchangeRate, FormatDecimalSeparator, FormatThousandSeparator, FormatDecimalPlaces, PrefixSymbol, ISO_Code) SELECT id, Name, Symbol, IsActive, ExchangeRate, FormatDecimalSeparator, FormatThousandSeparator, FormatDecimalPlaces, PrefixSymbol, ISO_Code FROM currencies#TEMP; 

Required fields: Name, ISO_Code, ExchangeRate.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Update

UPDATE Currencies SET symbol = 'hello', FormatDecimalSeparator = 'period', FormatThousandSeparator = 'comma',FormatDecimalPlaces = '2',prefixsymbol = 'true',exchangerate = '1.0000' WHERE Id = '1234';

Bulk Update Operation:

UPDATE Currencies SET symbol = '$',FormatDecimalSeparator = 'period',FormatThousandSeparator = 'comma',FormatDecimalPlaces = '2';

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated. NOTE: if Id field is not specified in the query, PostData will be created for each id ( driver will execute bulk update operation for each currency id).

Columns

Create, update, delete, and query information regarding deals.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Deals (DealName, Stage) VALUES ('Converting company XYZ into our client.', 'Qualification')

Required fields: DealName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Deals WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Deals SET Description = 'Updated from API' WHERE Id = '3152079000000153079'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns

Pseudo-Columns

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

Create, update, delete, and query information regarding events.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Events (Title, `From`, To) VALUES ('A test event', '2018/05/29 18:00:00', '2018/05/29 20:30:00')

INSERT INTO Events (Title, `From`, To, ModuleName) VALUES ('A test event', '2018/05/29 18:00:00', '2018/05/29 20:30:00', 'Contacts')

INSERT INTO Events (Title, `From`, To, ModuleName, RelatedTo_Id) VALUES ('A test event', '2018/05/29 18:00:00', '2018/05/29 20:30:00', 'Contacts', '2788704000120533263')

Required fields: Title, From, To, ModuleName if RelatedTo_Id is specified..

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Events WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Events SET Description = 'Changed from the API.' WHERE Id = '3152079000000154219'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

NOTE: This table is supported only in v2.

Columns

Pseudo-Columns

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

Create, update, delete, and query information regarding invoices. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Invoices (Status, DueDate, Subject, ProductDetails) VALUES ('Created', '2018/06/06', 'An invoice for the purchase of products XYZ.', '[
            { 
              "product": { 
                "Product_Code": "12342321", 
                "name": "Egg", 
                "id": "3276571000000184076" 
              }, 
              "quantity": 1024, 
              "Discount": 0, 
              "total_after_discount": 1239.04, 
              "net_total": 1239.04, 
              "book": null, 
              "Tax": 0, 
              "list_price": 1.21, 
              "unit_price": 1.21, 
              "quantity_in_stock": -1024, 
              "total": 1239.04, 
              "id": "3276571000000184104", 
              "product_description": null, 
              "line_tax": [] 
            } 
          ]')

Required fields: Subject, InvoicedItems.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Invoices WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Invoices SET Description = 'Updated from API' WHERE Id = '3152079000000153079'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns

Pseudo-Columns

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

Create, update, delete, and query information regarding Leads.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Leads(FirstName, LastName, Title) VALUES('Alert', 'Bat', 'Mr')
INSERT INTO LEADS(FirstName, LastName, Email, Trigger) VALUES('Enthusiastic', 'Panda', '[email protected]', 'workflow,approval,blueprint')

Required fields: LastName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Leads WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Leads SET Description = 'Changed from the API.' WHERE Id = '3152079000000488014'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns

Pseudo-Columns

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

Create, update, delete, and query information regarding notes.

Table-Specific Information

Note: The Bulk API is not supported by the Notes table. Due to this, if you are using the Bulk API (UseCOQL set to False and APIType set to Bulk), the Sync App will instead use the REST API (with its associated limitations) when working with notes data. Refer to v2, v2.1, or v4 (in accordance with the value you set for Schema) to see the limits imposed by the REST API.

Select

The Sync App uses the Zoho CRM 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.

• NoteTitle supports the '=, LIKE' operators.
• NoteContent supports the '=, LIKE' operators.
• CreatedTime supports the '=' operator.
• ModifiedTime supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Notes WHERE Id = '3152079000000153079'

SELECT * FROM Notes WHERE NoteTitle = 'Deal details'

Insert

INSERT INTO Notes (ParentID_Id, ModuleName, NoteContent) VALUES ('3276571000000184007', 'Leads', 'Janet converted this lead.') 

Required fields: ParentID_Id (the Id of the item in which you are inserting the note to), ModuleName (the API name of the module you are inserting the note to), NoteContent.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Notes WHERE Id = '3152079000000488014'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Notes SET NoteTitle = 'Changed from the API.' WHERE Id = '3152079000000304003'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns

Pseudo-Columns

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

To fetch the details of all or a specific pipeline in the Deals module. It works only with ApiVersion=2.1.

Table-Specific Information

Select

The Sync App will use the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

For example, the following queries are processed server side:

SELECT * FROM Pipeline WHERE Id = '228122000000223002' AND LayoutId = '228122000000000173'

SELECT * FROM Pipeline WHERE  LayoutId = '228122000000000173'

Insert

Insert Into Pipeline (LayoutId,DisplayValue,default,maps) VALUES ('4917206000000318488','Test_pipee11','true','[\n" +
            "        {\n" +
            "          \"display_value\": \"Qualification\",\n" +
            "          \"sequence_number\": \"2\",\n" +
            "          \"id\": \"4917206000000006801\"\n" +
            "        },\n" +
            "        {\n" +
            "          \"display_value\": \"Needs Analysis\",\n" +
            "          \"sequence_number\": \"1\",\n" +
            "          \"id\": \"4917206000000006803\"\n" +
            "        }\n" +
            "      ]')

Required fields: LayoutId, DisplayValue, Default and maps.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Update

You must specify the Id and LayoutId in the WHERE clause when executing an update against this table.

UPDATE Pipeline Set DisplayValue = 'Pipeline_test12', default = 'false', maps = '[\n" +
            "        {\n" +
            "          \"display_value\": \"Qualification\",\n" +
            "          \"sequence_number\": \"2\",\n" +
            "          \"id\": \"4917206000000006801\"\n" +
            "        },\n" +
            "        {\n" +
            "          \"display_value\": \"Needs Analysis\",\n" +
            "          \"sequence_number\": \"1\",\n" +
            "          \"id\": \"4917206000000006803\"\n" +
            "        }\n" +
            "      ]' WHERE Id = '4917206000000357004' AND LayoutId = '4917206000000318488' ")

Required fields: Id,LayoutId.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Delete

The users can use the TransferAndDeltePipeline stored procedure to delete the pipeline.

Columns

Create, update, delete, and query information regarding price books. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO PriceBooks (PriceBookName, Active) VALUES ('pricebook_2018', true) 

Required fields: PriceBookName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM PriceBooks WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE PriceBooks SET Description = 'Changed from the API.' WHERE Id = '3152079000000488023'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns

Pseudo-Columns

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

Create, update, delete, and query information regarding products.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Products(ProductName, ProductActive) VALUES('C-3PO', true)

Required fields: ProductName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Products WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Products SET Description = 'Changed from the API.' WHERE Id = '3152079000000487023'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns

Pseudo-Columns

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

Create, update, delete, and query information regarding purchase orders. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO PurchaseOrders (Subject, ProductDetails) VALUES ('Purchase Order', '[
            { 
              "product": { 
                "Product_Code": "12342321", 
                "name": "Egg", 
                "id": "3276571000000184076" 
              }, 
              "quantity": 1024, 
              "Discount": 0, 
              "total_after_discount": 1239.04, 
              "net_total": 1239.04, 
              "book": null, 
              "Tax": 0, 
              "list_price": 1.21, 
              "unit_price": 1.21, 
              "quantity_in_stock": -1024, 
              "total": 1239.04, 
              "id": "3276571000000184104", 
              "product_description": null, 
              "line_tax": [] 
            } 
          ]')

Required fields: Subject, Purchase_Items

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM PurchaseOrders WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE PurchaseOrders SET Description = 'Changed from the API.' WHERE Id = '3152079000000492001'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns

Pseudo-Columns

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

Create, update, delete, and query information regarding quotes. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Quotes (Subject, QuotedItems) VALUES ('QuotedItems', '[
            { 
              "product": { 
                "Product_Code": "12342321", 
                "name": "Egg", 
                "id": "3276571000000184076" 
              }, 
              "quantity": 1024, 
              "Discount": 0, 
              "total_after_discount": 1239.04, 
              "net_total": 1239.04, 
              "book": null, 
              "Tax": 0, 
              "list_price": 1.21, 
              "unit_price": 1.21, 
              "quantity_in_stock": -1024, 
              "total": 1239.04, 
              "id": "3276571000000184104", 
              "product_description": null, 
              "line_tax": [] 
            } 
          ]')

Required fields: Subject, QuotedItems.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Quotes WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Quotes SET Description = 'Changed from the API.' WHERE Id = '3152079000000490009'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns

Pseudo-Columns

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

Create, update, delete, and query information regarding sales orders. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO SalesOrders (Subject, ProductDetails) VALUES ('Sales Order', '[
            { 
              "product": { 
                "Product_Code": "12342321", 
                "name": "Egg", 
                "id": "3276571000000184076" 
              }, 
              "quantity": 1024, 
              "Discount": 0, 
              "total_after_discount": 1239.04, 
              "net_total": 1239.04, 
              "book": null, 
              "Tax": 0, 
              "list_price": 1.21, 
              "unit_price": 1.21, 
              "quantity_in_stock": -1024, 
              "total": 1239.04, 
              "id": "3276571000000184104", 
              "product_description": null, 
              "line_tax": [] 
            } 
          ]')

Required fields: Subject, OrderedItems

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM SalesOrders WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE SalesOrders SET Description = 'Changed from the API.' WHERE Id = '3152079000000493027'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns

Pseudo-Columns

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

Create, update, delete, and query information regarding solutions.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Sync App.

Insert

INSERT INTO Solutions (SolutionTitle, Status) VALUES ('Converting from XML to JSON', 'Created')

Required fields: SolutionTitle.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Solutions WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Solutions SET Question = 'Changed from the API.' WHERE Id = '3152079000000492018'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns

Pseudo-Columns

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

Create, update, delete, and query information regarding tasks.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Tasks(Subject, Status) VALUES ('Finish sending emails to potential leads.', 'Created')

INSERT INTO Tasks(Subject, Status, ModuleName) VALUES ('Finish sending emails to potential leads.', 'Created', 'Contacts')

INSERT INTO Tasks(Subject, Status, ModuleName, RelatedTo_Id) VALUES ('Finish sending emails to potential leads.', 'Created', 'Contacts', '2788704000120533263')

Required fields: Subject, ModuleName if RelatedTo_Id is specified.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Tasks WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Tasks SET Status = 'In progress' WHERE Id = '3152079000000492026'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns

Pseudo-Columns

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

Create, update, delete, and query information regarding vendors.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Vendors(VendorName, Email, Website) VALUES('XYZVendor', '[email protected]', 'vendeverything.xyz') 

Required fields: VendorName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Vendors WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Vendors SET Description = 'Changed from the API' WHERE Id = '3152079000000492032'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns

Pseudo-Columns

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

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

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

Zoho CRM Connector for CData Sync ビュー

Query information regarding performed actions.

Table-Specific Information

Select

The Sync App uses the Zoho CRM 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.

Note : ActionsPerformed cannot be queried until it is enabled from the UI.

SELECT * FROM ActionsPerformed

Columns

Pseudo-Columns

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

Query information regarding histories for a particular custom field.

Table-Specific Information

Select

The Sync App uses the Zoho CRM 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.

• ModuleName supports the '=' operator.
• EntityId supports the '=' operator.
• FieldName supports the '=' operator.
• HistoryName supports the '=' operator.

All columns used in the criteria are required. Use FieldName to specify the actual name of the tracked custom field and HistoryName to specify the name of the history tracking section. If you want to retrieve data for a specific entity of a module specify EntityId in the criteria. For example, the following query is processed server side:

SELECT * FROM [CustomFieldHistoryTracking] WHERE ModuleName = 'Leads' AND FieldName = 'pickListField' AND HistoryName = 'Pick List 1'

SELECT * FROM [CustomFieldHistoryTracking] WHERE ModuleName = 'Leads' AND FieldName = 'pickListField' AND HistoryName = 'Pick List 1' AND EntityId = '12345665'

Columns

To get the field metadata for the specified module.

View-Specific Information

Select

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

• ModuleName supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Fields WHERE ModuleName = 'Deals'

Columns

Query information regarding product details. Not available in free and standard ZohoCRM accounts.

View-Specific Information

Select

The Sync App uses the Zoho CRM 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.

• InvoiceId supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM InvoiceProductDetails WHERE InvoiceId = '3152079000000301143'

NOTE: ProductDetails has been changed to InvoicedItems after v2

Columns

To get the layouts metadata for the specified module.

View-Specific Information

Select

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

• ModuleName supports the '=' operator.

For example, the following queries are processed server-side:

SELECT * FROM Layouts WHERE ModuleName = 'Deals'

Columns