CData Sync App は、Zoho CRM データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Zoho CRM コネクタはCData Sync アプリケーションから使用可能で、Zoho CRM からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App アプリケーションの接続 ページに移動し、接続の追加 パネルで対応するアイコンを選択して、Zoho CRM への接続を作成します。Zoho CRM アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからZoho CRM コネクタをダウンロードおよびインストールします。
必須プロパティは[設定]タブにリストされています。[Advanced]タブには、通常は必要ない接続プロパティが表示されます。
Sync App はすでにZoho CRM にOAuth アプリケーションとして登録されています。そのため、デフォルトでは、自動的に埋め込みクレデンシャル を使用して接続します。
独自のカスタムOAuth アプリを使用したい場合は、カスタムクレデンシャル を参照してください。
Zoho CRM Sync App はパフォーマンスを向上させるためにデフォルトでUseServerSideFiltering がTrue に設定されていますが、誤った結果が返される場合があります。
このセクションでは、Zoho CRM Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、Zoho CRM にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
CData Sync App はZoho CRM モジュールをリレーショナルテーブルとしてモデル化します。
Sync App は、Zoho CRM API にできるだけ多くのSELECT 構文処理をオフロードし、残りのクエリをSync App 内で処理します。次のセクションでは、API の制限と要件を説明します。 Sync App がクライアントサイドのインメモリ処理でAPI 制限を回避する方法の詳細については、SupportEnhancedSQL を参照してください。
Sync App は、Zoho CRM に接続し、適切なWeb サービスを呼び出してテーブル のリストとテーブルのメタデータを取得します。Sync App を使用して接続すると、カスタムモジュールの追加、カスタムフィールドの追加、フィールドのデータ型の変更など、Zoho CRM アカウントに対して行う変更は即座に反映されます。 テーブル は、Zoho CRM 開発環境に基づいて、アカウントのエンティティがどのように見えるかの例を示しています。
ほとんどのビュー は、静的なコンフィギュレーションファイルで定義されます。一方、カスタムビューはそうではありません。 これらは、Zoho CRM に接続し、適切なWeb サービスを呼び出して返されたメタデータからカスタムビューのリストを取得することで動的に取得されます。 Sync App を使用して接続すると、新しいカスタムビューの追加など、Zoho CRM アカウントに対して行う変更は即座に反映されます。
[Custom Views]を使用するには、プロパティIncludeCustomViews を'true' に設定する必要があります。カスタムビューは、テーブルとビューのリストを取得するときにオーバーヘッドが発生するため、デフォルト値は'false' です。
カスタムビューに適用されたクライテリア(作成時またはUI での編集時)は、CData Zoho CRM Sync App に保持されます。それにもかかわらず、レコードのさらなるフィルタリングはいつでも利用できます。
To use Relative Views you must set property IncludeRelatedLists to 'true'. Its default value is 'false' since related views introduce an overhead when retrieving the list of tables and views.
EntityId column is a required field to fetch the related module data and this field refers to the parent module Id.
ストアドプロシージャ は、ファイルの操作など、Zoho CRM API の追加機能を提供します。
Sync App はZoho CRM のデータを、標準のSQL ステートメントを使用してクエリできるテーブルのリストにモデル化します。
一般的には、Zoho CRM テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。
Name | Description |
Accounts | Create, update, delete, and query information regarding accounts. |
Activities | Delete, and query information regarding activities. |
Attachments | Delete, and query information regarding attachments. |
Calls | Create, update, delete, and query information regarding calls. |
Campaigns | Create, update, delete, and query information regarding campaigns. |
Cases | Create, update, delete, and query information regarding cases. |
Contacts | Create, update, delete, and query information regarding contacts. |
Currencies | Get, add or update currencies to your organization. |
Deals | Create, update, delete, and query information regarding deals. |
Events | Create, update, delete, and query information regarding events. |
Invoices | Create, update, delete, and query information regarding invoices. Not available in free and standard ZohoCRM accounts. |
Leads | Create, update, delete, and query information regarding Leads. |
Notes | Create, update, delete, and query information regarding notes. |
Pipeline | To fetch the details of all or a specific pipeline in the Deals module. It works only with ApiVersion=2.1. |
PriceBooks | Create, update, delete, and query information regarding price books. Not available in free and standard ZohoCRM accounts. |
Products | Create, update, delete, and query information regarding products. |
PurchaseOrders | Create, update, delete, and query information regarding purchase orders. Not available in free and standard ZohoCRM accounts. |
Quotes | Create, update, delete, and query information regarding quotes. Not available in free and standard ZohoCRM accounts. |
SalesOrders | Create, update, delete, and query information regarding sales orders. Not available in free and standard ZohoCRM accounts. |
Solutions | Create, update, delete, and query information regarding solutions. |
Tasks | Create, update, delete, and query information regarding tasks. |
Vendors | Create, update, delete, and query information regarding vendors. |
Create, update, delete, and query information regarding accounts.
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 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.
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Accounts WHERE Id = '3152079000000153079'
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.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for this record. |
AccountOwner_Id | String | False |
The Id of the account owner for the account. |
AccountOwner_FirstName | String | False |
The First Name of the account owner for the account. |
AccountOwner_LastName | String | False |
The Last Name of the account owner for the account. |
Rating | String | False |
The rating for the account. |
AccountName | String | False |
The name of the account. |
Phone | String | False |
The phone of the account. |
AccountSite | String | False |
The site for the account. |
Fax | String | False |
The fax of the account. |
ParentAccount_Id | String | False |
The Id of the parent account of the account. |
Website | String | False |
The website of the account. |
AccountNumber | Long | False |
The account number of the account. |
TickerSymbol | String | False |
The ticker symbol of the account |
AccountType | String | False |
The type of the account. |
Ownership | String | False |
The ownership of the account. |
Industry | String | False |
The industry of the account. |
Employees | Int | False |
The number of employess the account has. |
AnnualRevenue | Double | False |
The annual revenue of the account. |
SICCode | Int | False |
The SIC code of the account |
Tag | String | False |
The tag of the account. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The Id of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Id of the User who modified the record. |
CreatedTime | Datetime | False |
The time when the record was created. |
ModifiedTime | Datetime | False |
The time when the record was modified. |
LastActivityTime | Datetime | False |
The time of the last activity for the account. |
BillingStreet | String | False |
The billing street of the account. |
ShippingStreet | String | False |
The shipping street of the account. |
BillingCity | String | False |
The billing city of the account. |
ShippingCity | String | False |
The shipping city of the account. |
BillingState | String | False |
The billing state of the account. |
ShippingState | String | False |
The shipping state of the account. |
BillingCode | String | False |
The billing code of the account. |
ShippingCode | String | False |
The shipping code of the account. |
BillingCountry | String | False |
The billing country of the account. |
ShippingCountry | String | False |
The shipping country of the account. |
Description | String | False |
The description of the account. |
History | String | False |
The history of the account. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String |
Used to search for a specific word in records. |
DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
Converted | Boolean |
Set to true to return only converted records. |
Approved | Boolean |
Set to true to return only approved records. |
CustomViewId | String |
The custom view Id to be used for filtering this record. |
Delete, and query information regarding activities.
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.
For example, the following queries are processed server side:
SELECT * FROM Activities WHERE Id = '3152079000000154214' SELECT * FROM Activities WHERE Subject = 'event'
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Activities WHERE Id = '3152079000000156229'
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for this record. |
ActivityOwner_Id | String | False |
The Id of the activity owner. |
ActivityOwner_Name | String | True |
The name of the activity owner. |
Subject | String | False |
The subject of the activity. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
CreatedBy_Name | String | True |
The name of the user who created the record. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_Name | String | True |
The name of the User who modified the record. |
CreatedAt | Datetime | False |
The time when the record was created. |
ModifiedAt | Datetime | False |
The time when the record was modified. |
ActivityType | String | False |
The type of the activity. |
ContactName_Id | String | False |
The Id of the contact. |
ContactName_Name | String | True |
The name of the contact. |
RelatedTo_Id | String | False |
The Id to whom this activity is related to. |
RelatedTo_Name | String | True |
The name to whom this activity is related to. |
Description | String | False |
The description of the activity. |
DueDate | Date | False |
The due date of the activity. |
Status | String | False |
The status of the activity. |
Priority | String | False |
The priority of the activity. |
SendNotificationEmail | Bool | False |
Wheter to send a notification email for this activity or not |
Repeat | String | False |
If this is a repeat activity or not. |
ClosedTime | Datetime | False |
The closed time of the activity. |
Location | String | False |
The location where this activity will take place. |
From | Datetime | False |
The start time of the activity. |
Allday | Bool | False |
Whether this activity will take all day or not. |
To | Datetime | False |
The end time of the activity. |
Participants | Long | False |
The number of participants in this activity. |
Check_InTime | Datetime | True |
The time when check in has to happen. |
Check_InBy_Id | String | False |
The Id of the user who is checking in. |
Check_InBy_Name | String | True |
The name of the user who is checking in. |
Check_InComment | String | True |
The comment of the check in for the activity. |
Check_InSub_Locality | String | True |
The sub-locality where the check in for this activity will happen. |
Check_InCity | String | True |
The city where the check in for this activity will happen. |
Check_InState | String | True |
The state where the check in for this activity will happen. |
Check_InCountry | String | True |
The country where the check in for this activity will happen. |
Latitude | String | True |
The latitude where the check in for this activity will happen. |
Longitude | String | True |
The longitude where the check in for this activity will happen. |
ZipCode | String | True |
The zip code where the check in for this activity will happen. |
Check_InAddress | String | True |
The address where the check in for this activity will happen. |
CheckedInStatus | String | True |
The status of the checked in for this activity. |
CallPurpose | String | False |
The purpose of the call for this activity. |
CallType | String | False |
The type of the call for this activity. |
CallStartTime | Datetime | False |
The start time of the call for this activity. |
CallDuration | String | False |
The duration of the call for this activity. |
CallDuration_inseconds_ | Int | False |
The duration of the call in seconds for this activity. |
CallResult | String | False |
The result of the call for this activity. |
Billable | Bool | False |
Whether this activity is billable or not. |
CTIEntry | Bool | False |
Whether this activity is a CTI entry or not. |
Reminder | String | False |
A reminder set for this activity. |
CallStatus | String | False |
The status of the call for this activity. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String |
Used to search for a specific word in records. |
DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
Converted | Boolean |
Set to true to return only converted records. |
Approved | Boolean |
Set to true to return only approved records. |
CustomViewId | String |
The custom view Id to be used for filtering this record. |
Delete, and query information regarding attachments.
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.
For example, the following queries are processed server side:
SELECT * FROM Attachments WHERE Id = '3152079000000153079' SELECT * FROM Attachments WHERE FileName = 'Koala.jpg'
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Attachments WHERE Id = '3152079000000431011'
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for this record. |
AttachmentOwner_Id | String | False |
The Id of the attachment owner. |
AttachmentOwner_Name | String | True |
The name of the attachment owner. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_Name | String | True |
The name of the User who modified the record. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
CreatedBy_Name | String | True |
The name of the user who created the record. |
CreatedAt | Datetime | False |
The time when the record was created. |
ModifiedAt | Datetime | False |
The time when the record was modified. |
FileName | String | False |
The name of the file of the attachment. |
Size | String | False |
The size of the attachment. |
ParentID_Id | String | False |
The Id of the parent of the attachment. |
ParentID_Name | String | True |
The name of the parent of the attachment. |
ModuleName | String | False |
The name of the module this attachment belongs to. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String |
Used to search for a specific word in records. |
DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
Converted | Boolean |
Set to true to return only converted records. |
Approved | Boolean |
Set to true to return only approved records. |
CustomViewId | String |
The custom view Id to be used for filtering this record. |
Create, update, delete, and query information regarding calls.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
INSERT INTO Calls (Subject) VALUES ('A test call') INSERT INTO Calls (Subject, ModuleName) VALUES ('A test call', 'Contacts') INSERT INTO Calls (Subject, ModuleName, RelatedTo_Id) VALUES ('A test call', '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.
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Calls WHERE Id = '3152079000000153079'
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.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for this record. |
ContactName_Id | String | False |
The Id of the contact of the call. |
ContactName_FirstName | String | False |
The First Name of the contact of the call. |
ContactName_LastName | String | False |
The Last Name of the contact of the call. |
Subject | String | False |
The subject of the call. |
CallPurpose | String | False |
The purpose of the call. |
RelatedTo_Id | String | False |
The Id of the person this call was related to. |
CallType | String | False |
The type of the call. |
CallStartTime | Datetime | False |
The time of the start of the call. |
CallDuration | String | False |
The duration of the call. |
CallDuration_inseconds_ | Int | False |
The duration of the call in seconds. |
Description | String | False |
The description of the call. |
CallResult | String | False |
The result of the call. |
Billable | Bool | False |
Whether this call was billable or not. |
CallOwner_Id | String | False |
The Id of the owner of the call. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
CreatedTime | Datetime | False |
The time when the record was created. |
Tag | String | False |
The tags of the call. |
ModifiedTime | Datetime | False |
The time when the record was modified. |
Reminder | String | False |
The reminder set for this call. |
CallStatus | String | True |
The status of the call. |
ModuleName | String | False |
The name of the module this call belongs to. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String |
Used to search for a specific word in records. |
DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
Converted | Boolean |
Set to true to return only converted records. |
Approved | Boolean |
Set to true to return only approved records. |
CustomViewId | String |
The custom view Id to be used for filtering this record. |
Create, update, delete, and query information regarding campaigns.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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.
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Campaigns WHERE Id = '3152079000000485001'
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.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for this record. |
CampaignOwner_Id | String | False |
The Id of the campaign owner. |
CampaignOwner_FirstName | String | False |
The First Name of the campaign owner. |
CampaignOwner_LastName | String | False |
The Last Name of the campaign owner. |
Type | String | False |
The type of the campaign. |
CampaignName | String | False |
The name of the campaign. |
Status | String | False |
The status of the campaign. |
StartDate | Date | False |
The date of the start of the campaign. |
EndDate | Date | False |
The date of the end of the campaign. |
ExpectedRevenue | Double | False |
The expected revenue from this campaign. |
BudgetedCost | Double | False |
The budgeted cost of the campaign. |
ActualCost | Double | False |
The actual cost of the campaign. |
ExpectedResponse | Long | False |
The expected response from this campaign. |
Numberssent | Long | False |
The number of sent campaigns. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
CreatedTime | Datetime | False |
The time when the record was created. |
ModifiedTime | Datetime | False |
The time when the record was modified. |
Tag | String | False |
The tags for this campaign. |
Description | String | False |
The description of this campaign. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String |
Used to search for a specific word in records. |
DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
Converted | Boolean |
Set to true to return only converted records. |
Approved | Boolean |
Set to true to return only approved records. |
CustomViewId | String |
The custom view Id to be used for filtering this record. |
Create, update, delete, and query information regarding cases.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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.
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Cases WHERE Id = '3152079000000153079'
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.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for this record. |
CaseOwner_Id | String | False |
The Id of the owner of the case. |
CaseOwner_FirstName | String | False |
The First Name of the owner of the case. |
CaseOwner_LastName | String | False |
The Last Name of the owner of the case. |
CaseNumber | String | False |
The number of the case. |
Status | String | False |
The status of the case. |
ProductName_Id | String | False |
The Id of the product concerning this case. |
Priority | String | False |
The priority of the case. |
Type | String | False |
The type of the case. |
CaseReason | String | False |
The reason this case was opened. |
CaseOrigin | String | False |
The origin of this case. |
Subject | String | False |
The subject of the case. |
RelatedTo_Id | String | False |
The Id to what this case is related to. |
No_ofcomments | Int | True |
The number of comments in this case. |
AccountName_Id | String | False |
The Id of the account of this case. |
ReportedBy | String | False |
By whom this case was reported. |
DealName_Id | String | False |
The Id of the deal this case concerns. |
String | False |
The email of the person opening this case. | |
Tag | String | False |
The tags concerning this case. |
Phone | String | False |
The phone of the person opening this case. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
CreatedTime | Datetime | False |
The time when the record was created. |
ModifiedTime | Datetime | False |
The time when the record was modified. |
Description | String | False |
The description of this case. |
InternalComments | String | False |
The internal comments of this case. |
Solution | String | False |
The solution of this case. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String |
Used to search for a specific word in records. |
DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
Converted | Boolean |
Set to true to return only converted records. |
Approved | Boolean |
Set to true to return only approved records. |
CustomViewId | String |
The custom view Id to be used for filtering this record. |
Create, update, delete, and query information regarding contacts.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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.
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Contacts WHERE Id = '3152079000000153079'
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.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for this record. |
ContactOwner_Id | String | False |
The Id of the owner of the contact. |
ContactOwner_FirstName | String | False |
The First Name of the owner of the contact. |
ContactOwner_LastName | String | False |
The Last Name of the owner of the contact. |
LeadSource | String | False |
The source of the lead. |
FirstName | String | False |
The first name of the contact. |
LastName | String | False |
The last name of the contact. |
AccountName_Id | String | False |
The id of the account concerning this contact. |
VendorName_Id | String | False |
The Id of the vendor concerning this account. |
String | False |
The email of the contact. | |
Title | String | False |
The title of the contact. |
Department | String | False |
The Department of the contact. |
Phone | String | False |
The phone of the contact. |
HomePhone | String | False |
The home phone of the contact. |
OtherPhone | String | False |
A different phone number of the contact. |
Fax | String | False |
The fax of the contact. |
Mobile | String | False |
The mobile of the contact. |
DateofBirth | Date | False |
The date of birth of the contact. |
Tag | String | False |
A list of tags of the contact. |
Assistant | String | False |
The assistant of the contact. |
AsstPhone | String | False |
The phone number of the assistant of the contact. |
ReportsTo | String | False |
To whom the contact reports to. |
EmailOptOut | Bool | False |
Whether this contact has opted out from receiving emails. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
SkypeID | String | False |
The Skype ID of the contact. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
CreatedTime | Datetime | False |
The time when the record was created. |
ModifiedTime | Datetime | False |
The time when the record was modified. |
FullName | String | False |
The full name of the contact. |
Salutation | String | False |
The salutation the contact likes to be referenced as. |
SecondaryEmail | String | False |
The secondary email of the contact. |
LastActivityTime | Datetime | False |
The time of the contact's last activity. |
String | False |
The twitter handle of the contact. | |
MailingStreet | String | False |
The mailing street of the contact. |
OtherStreet | String | False |
The other street of the contact. |
MailingCity | String | False |
The mailing city of the contact. |
OtherCity | String | False |
The other city of the contact. |
MailingState | String | False |
The mailing state of the contact. |
OtherState | String | False |
The other state of the contact. |
MailingZip | String | False |
The mailing zip of the contact. |
OtherZip | String | False |
The other zip of the contact. |
MailingCountry | String | False |
The mailing country of the contact. |
OtherCountry | String | False |
The other country of the contact. |
Description | String | False |
The description of the contact. |
MostRecentVisit | Datetime | False |
The most recent visit of the contact. |
FirstVisit | Datetime | False |
The first visit of the contact. |
Referrer | String | False |
The referrer of the contact. |
FirstPageVisited | String | False |
The first page the contact has visited. |
NumberOfChats | Int | False |
The number of chats the contact has had. |
AverageTimeSpent_Minutes_ | String | False |
The average time in minutes the contact has spent. |
DaysVisited | Int | False |
The number of days the contact has visited. |
VisitorScore | Long | False |
The visitor score of the contact. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String |
Used to search for a specific word in records. |
DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
Converted | Boolean |
Set to true to return only converted records. |
Approved | Boolean |
Set to true to return only approved records. |
CustomViewId | String |
The custom view Id to be used for filtering this record. |
Get, add or update currencies to your organization.
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.
For example, the following queries are processed server side:
SELECT * FROM Currencies WHERE Id = '1234';
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 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).
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
Represents the unique ID of the currency. |
Name | String | False |
Represents the name of the currency. |
Symbol | String | False |
Represents the symbol of the currency. |
IsActive | Boolean | False |
Represents the status of the currency. |
ExchangeRate | Double | False |
Represents the exchange rate of the currency. |
FormatDecimalSeparator | String | False |
The decimal separator separates the integer part of the currency from its fractional part. |
FormatThousandSeparator | String | False |
The thousand separator separates groups of thousands in a currency. |
FormatDecimalPlaces | String | False |
Represents the number of decimal places allowed for the currency. |
ModifiedByName | String | True |
Represents the name of the user who last modified the currency details. |
ModifiedByid | String | True |
Represents the ID of the user who last modified the currency details. |
PrefixSymbol | Boolean | False |
Represents if the currency has a prefix symbol. |
IsBase | Boolean | True |
Represents if the currency is the base currency. |
CreatedAt | Datetime | True |
Represents the date and time at which the currency was created. |
ModifiedAt | Datetime | True |
Represents the date and time at which the currency was last modified. |
ISO_Code | String | False |
Represents the ISO code of the currency. |
Create, update, delete, and query information regarding deals.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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.
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Deals WHERE Id = '3152079000000153079'
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.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for this record. |
DealOwner_Id | String | False |
The Id of the deal owner. |
DealOwner_FirstName | String | False |
The First Name of the deal owner. |
DealOwner_LastName | String | False |
The Last Name of the deal owner. |
Amount | Double | False |
The amount of the deal. |
DealName | String | False |
The name of the deal. |
ClosingDate | Date | False |
The closing date of the dal. |
AccountName_Id | String | False |
The Id of the account who created the deal. |
Stage | String | False |
The stage in which the deal is in. |
Type | String | False |
The type of the deal. |
Probability_ | Int | False |
The probability this deal has of being closed. |
NextStep | String | False |
The next step of the deal. |
ExpectedRevenue | Double | True |
The expected revenue from the deal. |
LeadSource | String | False |
The source of the deal. |
CampaignSource_Id | String | False |
The Id of the campaign source concerning this deal. |
ContactName_Id | String | False |
The Id of the contact regarding this deal. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
CreatedTime | Datetime | False |
The time when the record was created. |
Tag | String | False |
A list of tags regarding this deal. |
ModifiedTime | Datetime | False |
The time when the record was modified. |
LastActivityTime | Datetime | False |
The last activity time of this deal. |
LeadConversionTime | Int | False |
The time it took for this lead to convert. |
SalesCycleDuration | Int | False |
The duration of sales cycles it took for this deal. |
OverallSalesDuration | Int | False |
The overal sales duration of this deal. |
Description | String | False |
The descrption of this deal. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String |
Used to search for a specific word in records. |
DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
Converted | Boolean |
Set to true to return only converted records. |
Approved | Boolean |
Set to true to return only approved records. |
CustomViewId | String |
The custom view Id to be used for filtering this record. |
Create, update, delete, and query information regarding events.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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.
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Events WHERE Id = '3152079000000153079'
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.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for this record. |
Title | String | False |
The title of the event. |
Location | String | False |
The location of the event. |
From | Datetime | False |
The starting time of the event. |
Allday | Bool | False |
Whether the even will be going on for the whole day or not. |
To | Datetime | False |
The end time of the event. |
Host_Id | String | False |
The Id of the host of the event. |
Host_FirstName | String | False |
The First Name of the host of the event. |
Host_LastName | String | False |
The Last Name of the host of the event. |
ContactName_Id | String | False |
The Id of the contact of the event. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
Description | String | False |
The description of the event. |
RelatedTo_Id | String | False |
The Id to whom this event is related to. |
Repeat | String | False |
Whether this is a recurring activity or not. |
CreatedTime | Datetime | False |
The time when the record was created. |
ModifiedTime | Datetime | False |
The time when the record was modified. |
Check_InTime | Datetime | True |
The time of the check in for this event. |
Check_InBy_Id | String | False |
The Id of the person who checked in for this event. |
Check_InComment | String | True |
The check in comment for this event. |
Check_InSub_Locality | String | True |
The sub locality of the check in for this event. |
Reminder | String | False |
A reminder set for this event. |
Check_InCity | String | True |
The city where the check in for this event will be held at. |
Check_InState | String | True |
The state where the check in for this event will be held at. |
Check_InCountry | String | True |
The country where the check in for this event will be held at. |
Latitude | String | True |
The latitude of where the event will take place. |
Longitude | String | True |
The longitude of where the event will take place. |
ZipCode | String | True |
The ZIP code of where the event will take place. |
Check_InAddress | String | True |
The address of the check in for this event. |
CheckedInStatus | String | True |
The check in status for this event. |
Tag | String | False |
A list of tags for this event. |
ModuleName | String | False |
The name of the module this event belongs to. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String |
Used to search for a specific word in records. |
DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
Converted | Boolean |
Set to true to return only converted records. |
Approved | Boolean |
Set to true to return only approved records. |
CustomViewId | String |
The custom view Id to be used for filtering this record. |
Create, update, delete, and query information regarding invoices. Not available in free and standard ZohoCRM accounts.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
INSERT INTO Invoices (Status, DueDate, Subject) VALUES ('Created', '2018/06/06', 'An invoice for the purchase of products XYZ.') 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: None.
Any field which is not read-only (ReadOnly = false in the table below) can be inserted.
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Invoices WHERE Id = '3152079000000153079'
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.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for this record. |
InvoiceOwner_Id | String | False |
The Id of the owner of this invoice. |
InvoiceOwner_FirstName | String | False |
The First Name of the owner of this invoice. |
InvoiceOwner_LastName | String | False |
The Last Name of the owner of this invoice. |
InvoiceNumber | String | False |
The number of this invoice. |
Subject | String | False |
The subject of this invoice. |
SalesOrder_Id | String | False |
The Id of the sales order linked to this invoice. |
InvoiceDate | Date | False |
The date listed in the invoice. |
PurchaseOrder | String | False |
The purchase order linked with this invoice. |
DueDate | Date | False |
The date when this invoice is due at. |
ExciseDuty | Double | False |
The amount of excise duty for this invoice. |
SalesCommission | Double | False |
The amount of sales commission for this invoice. |
Status | String | False |
The status of the invoice. |
AccountName_Id | String | False |
The Id of the account linked with this invoice. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
ContactName_Id | String | False |
The Id of the contact linked with this invoice. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
CreatedTime | Datetime | False |
The time when the record was created. |
ModifiedTime | Datetime | False |
The time when the record was modified. |
Tag | String | False |
A list of tags related to this invoice. |
BillingStreet | String | False |
The billing street of the invoice. |
ShippingStreet | String | False |
The shipping street of the invoice. |
BillingCity | String | False |
The billing city of the invoice. |
ShippingCity | String | False |
The shipping city of the invoice. |
BillingState | String | False |
The billing state of the invoice. |
ShippingState | String | False |
The shipping state of the invoice. |
BillingCode | String | False |
The billing code of the invoice. |
ShippingCode | String | False |
The shipping code of the invoice. |
BillingCountry | String | False |
The billing country of the invoice. |
ShippingCountry | String | False |
The shippingcountry of the invoice. |
ProductDetails | String | False |
A json aggregate of the product details for this invoice. |
SubTotal | Double | True |
The subtotal of this invoice. |
Discount | Double | False |
The discount applied to this invoice. |
Tax | Double | True |
The tax applied to this invoice. |
Adjustment | Double | False |
The adjustment applied to this invoice. |
GrandTotal | Double | True |
The grand total of this invoice. |
TermsandConditions | String | False |
The terms and conditions of this invoice. |
Description | String | False |
The description of this invoice. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String |
Used to search for a specific word in records. |
DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
Converted | Boolean |
Set to true to return only converted records. |
Approved | Boolean |
Set to true to return only approved records. |
CustomViewId | String |
The custom view Id to be used for filtering this record. |
InvoicedItems | String |
Invoiced Items SubForm. This column can only be used for Insert and Update. |
Create, update, delete, and query information regarding Leads.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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.
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Leads WHERE Id = '3152079000000153079'
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.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for this record. |
LeadOwner_Id | String | False |
The Id of the lead owner. |
LeadOwner_FirstName | String | False |
The First Name of the lead owner. |
LeadOwner_LastName | String | False |
The Last Name of the lead owner. |
Company | String | False |
The company of the lead. |
FirstName | String | False |
The first name of the lead. |
LastName | String | False |
The last name of the lead. |
Title | String | False |
The designation of the lead. |
String | False |
The email of the lead. | |
Phone | String | False |
The phone number of the lead. |
Fax | String | False |
The fax number of the lead. |
Mobile | String | False |
The mobile number of the lead. |
Website | String | False |
The website of the lead. |
LeadSource | String | False |
The source of the lead. |
LeadStatus | String | False |
The status of the lead. |
Industry | String | False |
The induystr in which the lead is in. |
No_ofEmployees | Int | False |
The number of employees in the lead's company. |
AnnualRevenue | Double | False |
The annual revenue of the lead. |
Rating | String | False |
The rating of the lead. |
Tag | String | False |
A list of tag related to the lead. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
EmailOptOut | Bool | False |
Whether the lead has opted out of emails or not. |
SkypeID | String | False |
The skype id of the lead. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
CreatedTime | Datetime | False |
The time when the record was created. |
ModifiedTime | Datetime | False |
The time when the record was modified. |
FullName | String | False |
The full name of the lead. |
Salutation | String | False |
The salutation that the lead likes to be referred to. |
SecondaryEmail | String | False |
The secondary email of the lead. |
String | False |
The twitter handle of the lead. | |
LastActivityTime | Datetime | False |
The last time the lead had any activity. |
Street | String | False |
The street where the lead resides in. |
City | String | False |
The city where the lead resides in. |
State | String | False |
The state where the lead resides in. |
ZipCode | String | False |
The zip code of the place where the lead resides in. |
Country | String | False |
The country where the lead resides in. |
Description | String | False |
A description of the lead. |
MostRecentVisit | Datetime | False |
The last time the lead visited. |
FirstVisit | Datetime | False |
The first time the lead visited. |
Referrer | String | False |
The referrer of the lead. |
FirstPageVisited | String | False |
The first URL that the lead has visited. |
NumberOfChats | Int | False |
The number of chats had with the lead. |
AverageTimeSpent_Minutes_ | String | False |
The average time the lead has spent in minutes. |
DaysVisited | Int | False |
The number of days the lead has visitied. |
VisitorScore | Long | False |
The visitor score calculated for this lead. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String |
Used to search for a specific word in records. |
DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
Converted | Boolean |
Set to true to return only converted records. |
Approved | Boolean |
Set to true to return only approved records. |
CustomViewId | String |
The custom view Id to be used for filtering this record. |
Trigger | String |
To trigger the rule while inserting record into CRM account. |
Create, update, delete, and query information regarding notes.
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.
For example, the following queries are processed server side:
SELECT * FROM Notes WHERE Id = '3152079000000153079' SELECT * FROM Notes WHERE NoteTitle = 'Deal details'
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.
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Notes WHERE Id = '3152079000000488014'
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.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for this record. |
NoteOwner_Id | String | False |
The Id of the note owner. |
NoteOwner_FirstName | String | False |
The First Name of the note owner. |
NoteOwner_LastName | String | False |
The Last Name of the note owner. |
NoteTitle | String | False |
The title of the note. |
NoteContent | String | False |
The text content of the note. |
ParentID_Id | String | False |
The Id of the parent of this note. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
CreatedTime | Datetime | False |
The time when the record was created. |
ModifiedTime | Datetime | False |
The time when the record was modified. |
ModuleName | String | False |
The name of the module this note belongs to. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String |
Used to search for a specific word in records. |
DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
Converted | Boolean |
Set to true to return only converted records. |
Approved | Boolean |
Set to true to return only approved records. |
CustomViewId | String |
The custom view Id to be used for filtering this record. |
To fetch the details of all or a specific pipeline in the Deals module. It works only with ApiVersion=2.1.
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 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.
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.
The users can use the TransferAndDeltePipeline stored procedure to delete the pipeline.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
A unique numeric identifier for the profile. |
DisplayValue | String | False |
The name of the pipeline. |
Default | Boolean | False |
The default value of the pipeline. |
ActualValue | String | False |
The actual name of the pipeline. |
Maps | String | False |
The different stages that a deal has to pass through in the sales pipeline. |
LayoutId [KEY] | String | False |
The unique ID of the layout in the Deals module you want to fetch the pipeline's details from. |
Create, update, delete, and query information regarding price books. Not available in free and standard ZohoCRM accounts.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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.
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM PriceBooks WHERE Id = '3152079000000153079'
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.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for this record. |
PriceBookOwner_Id | String | False |
The Id of the owner of the price book. |
PriceBookOwner_FirstName | String | False |
The First Name of the owner of the price book. |
PriceBookOwner_LastName | String | False |
The Last Name of the owner of the price book. |
PriceBookName | String | False |
The name of the price book. |
Active | Bool | False |
Whether this price book is active or not. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
PricingModel | String | False |
The pricing model of the price book. (Flat or Differential). |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
CreatedTime | Datetime | False |
The time when the record was created. |
ModifiedTime | Datetime | False |
The time when the record was modified. |
Tag | String | False |
A list of tags related to this price book. |
Description | String | False |
The description of the price book. |
PricingDetails | String | False |
A json aggregate with pricing details. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String |
Used to search for a specific word in records. |
DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
Converted | Boolean |
Set to true to return only converted records. |
Approved | Boolean |
Set to true to return only approved records. |
CustomViewId | String |
The custom view Id to be used for filtering this record. |
Create, update, delete, and query information regarding products.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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.
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Products WHERE Id = '3152079000000153079'
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.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for this record. |
ProductOwner_Id | String | False |
The Id of the product owner. |
ProductOwner_FirstName | String | False |
The First Name of the product owner. |
ProductOwner_LastName | String | False |
The Last Name of the product owner. |
ProductName | String | False |
The name of the product. |
ProductCode | String | False |
The code of the product. |
VendorName_Id | String | False |
The Id of the vendor of the product.. |
ProductActive | Bool | False |
Whether this product is active or not. |
Manufacturer | String | False |
The manufacturer of the product. |
ProductCategory | String | False |
The category of the product. |
SalesStartDate | Date | False |
The start date of the sale of the product. |
SalesEndDate | Date | False |
The end date of the sale of the product. |
SupportStartDate | Date | False |
The start date of the support of the product. |
SupportEndDate | Date | False |
The end date of the support of the product. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
CreatedTime | Datetime | False |
The time when the record was created. |
ModifiedTime | Datetime | False |
The time when the record was modified. |
Tag | String | False |
A list of tags related to the product. |
UnitPrice | Double | False |
The unit price of the product. |
CommissionRate | Double | False |
The commission rate of the product. |
Tax | String | False |
A json aggregate of the tax related to this product. |
Taxable | Bool | False |
Whether this product is taxable or not. |
UsageUnit | String | False |
The unit of usage of the product. |
QtyOrdered | String | False |
The quantity ordered for this product. |
QuantityinStock | String | False |
The number of items in stock for this product. |
ReorderLevel | String | False |
The level of reorder for the product. |
Handler_Id | String | False |
The Id of the handler of the product. |
QuantityinDemand | String | False |
The quantity in demand of the product. |
Description | String | False |
A brief description of the product. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String |
Used to search for a specific word in records. |
DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
Converted | Boolean |
Set to true to return only converted records. |
Approved | Boolean |
Set to true to return only approved records. |
CustomViewId | String |
The custom view Id to be used for filtering this record. |
Create, update, delete, and query information regarding purchase orders. Not available in free and standard ZohoCRM accounts.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
INSERT INTO PurchaseOrders(TrackingNumber, ExciseDuty, Carrier) VALUES('123123123', 33.33, 'UPS')
Required fields: None.
Any field which is not read-only (ReadOnly = false in the table below) can be inserted.
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM PurchaseOrders WHERE Id = '3152079000000153079'
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.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for this record. |
PurchaseOrderOwner_Id | String | False |
The Id of the owner of the purchase order. |
PurchaseOrderOwner_FirstName | String | False |
The First Name of the owner of the purchase order. |
PurchaseOrderOwner_LastName | String | False |
The Last Name of the owner of the purchase order. |
PONumber | String | False |
The number of the purchase order. |
Subject | String | False |
The subject of the purchase order. |
VendorName_Id | String | False |
The Id of the vendor of the purchase order. |
RequisitionNumber | String | False |
The requisition number of the purchase order. |
TrackingNumber | String | False |
The tracking number of the purchase order. |
ContactName_Id | String | False |
The Id of the contanct regarding this purchase order. |
PODate | Date | False |
The date listed in this purchase order. |
DueDate | Date | False |
The due date of this purchase order. |
Carrier | String | False |
The carrier listed in this purchase order. |
ExciseDuty | Double | False |
The amount of excise duty on this purchase order. |
SalesCommission | Double | False |
The amount of commision for the sale listed on this purchase order. |
Status | String | False |
The status of the purchase order. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
CreatedTime | Datetime | False |
The time when the record was created. |
Tag | String | False |
A list of tags regarding this purchase order. |
ModifiedTime | Datetime | False |
The time when the record was modified. |
BillingStreet | String | False |
The billing street of the purchase order. |
ShippingStreet | String | False |
The shipping street of the purchase order. |
BillingCity | String | False |
The billing city of this purchase order. |
ShippingCity | String | False |
The shipping city of this purchase order. |
BillingState | String | False |
The billing state of this purchase order. |
ShippingState | String | False |
The shipping state of this purchase order. |
BillingCode | String | False |
The billing code of this purchase order. |
ShippingCode | String | False |
The shipping code of this purchase order. |
BillingCountry | String | False |
The billing country of this purchase order. |
ShippingCountry | String | False |
The shipping country of this purchase order. |
ProductDetails | String | False |
A json aggregate of the product details. |
SubTotal | Double | True |
The sub total price of the purchase order. |
Discount | Double | False |
The discount listed in this purchase order. |
Tax | Double | True |
The amount of tax listed in this purchase order. |
Adjustment | Double | False |
The amount of adjustment regarding this purchase order. |
GrandTotal | Double | True |
The grand total of this purchase order. |
TermsandConditions | String | False |
The terms and conditions regarding this purchase order. |
Description | String | False |
The description of this purchase order. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String |
Used to search for a specific word in records. |
DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
Converted | Boolean |
Set to true to return only converted records. |
Approved | Boolean |
Set to true to return only approved records. |
CustomViewId | String |
The custom view Id to be used for filtering this record. |
PurchaseItems | String |
Purchase Items SubForm. This column can only be used for Insert and Update. |
Create, update, delete, and query information regarding quotes. Not available in free and standard ZohoCRM accounts.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
INSERT INTO Quotes (Subject, Team, Adjustment) VALUES ('A quote for product XYZ for company ABC.', 'A-Team', 12.5)
Required fields: None.
Any field which is not read-only (ReadOnly = false in the table below) can be inserted.
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Quotes WHERE Id = '3152079000000153079'
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.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for this record. |
QuoteOwner_Id | String | False |
The Id of the owner of the quote. |
QuoteOwner_FirstName | String | False |
The First Name of the owner of the quote. |
QuoteOwner_LastName | String | False |
The Last Name of the owner of the quote. |
QuoteNumber | String | False |
The number of the quote. |
Subject | String | False |
The subject of the quote. |
DealName_Id | String | False |
The Id of the deal related to this quote. |
QuoteStage | String | False |
The stage in which this quote is currently at. |
ValidUntil | Date | False |
The time until this quote is valid. |
Team | String | False |
The team who is related to this quote. |
ContactName_Id | String | False |
The Id of the contact of the quote. |
Carrier | String | False |
The carrier of this quote. |
AccountName_Id | String | False |
The Id of the account related to this quote. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
CreatedTime | Datetime | False |
The time when the record was created. |
ModifiedTime | Datetime | False |
The time when the record was modified. |
Tag | String | False |
A list of tags related to this quote. |
BillingStreet | String | False |
The billing street of the record. |
ShippingStreet | String | False |
The shipping street of the record. |
BillingCity | String | False |
The billing city of the record. |
ShippingCity | String | False |
The shipping city of the record. |
BillingState | String | False |
The billing state of the record. |
ShippingState | String | False |
The shipping state of the record. |
BillingCode | String | False |
The billing code of the record. |
ShippingCode | String | False |
The shipping code of the record. |
BillingCountry | String | False |
The billing country of the record. |
ShippingCountry | String | False |
The shipping country of the record. |
ProductDetails | String | False |
A json aggregate of the product details related to this quote. |
SubTotal | Double | True |
The sub total price of this quote. |
Discount | Double | False |
The disocunt applied to this quote. |
Tax | Double | True |
The amount of tax applied to this quote. |
Adjustment | Double | False |
The amount of adjusted price applied to this quote. |
GrandTotal | Double | True |
The gradn total of the quote. |
TermsandConditions | String | False |
The terms and conditions of this quote. |
Description | String | False |
The description of this quote. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String |
Used to search for a specific word in records. |
DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
Converted | Boolean |
Set to true to return only converted records. |
Approved | Boolean |
Set to true to return only approved records. |
CustomViewId | String |
The custom view Id to be used for filtering this record. |
QuotedItems | String |
Quoted Items SubForm. This column can only be used for Insert and Update. |
Create, update, delete, and query information regarding sales orders. Not available in free and standard ZohoCRM accounts.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
INSERT INTO SalesOrders (Subject, Status) VALUES ('A brand new sales order', 'Created')
Required fields: None.
Any field which is not read-only (ReadOnly = false in the table below) can be inserted.
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM SalesOrders WHERE Id = '3152079000000153079'
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.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for this record. |
Subject | String | False |
The subject of the sales order. |
SalesOrderOwner_Id | String | False |
The Id of the owner of the sales order. |
SalesOrderOwner_FirstName | String | True |
The First Name of the owner of the sales order. |
SalesOrderOwner_LastName | String | True |
The Last Name of the owner of the sales order. |
SONumber | String | False |
The sales order number. |
DealName_Id | String | False |
The Id of the deal regarding this sales order. |
CustomerNo_ | String | False |
The number of the customer regarding this sales order. |
EndDate | String | False |
The end date of the sales order. |
PurchaseOrder | String | False |
The purchase order linked to this sales order. |
DueDate | Date | False |
The due date of this sales order. |
QuoteName_Id | String | False |
The Id of the quote related to this sales order. |
ContactName_Id | String | False |
The Id of the contact of this sales order. |
Pending | String | False |
The pending status of this sales order. |
ExciseDuty | Double | False |
The amount of excise duty of this sales order. |
Carrier | String | False |
The carrier of this sales order. |
Status | String | False |
The status of this sales order. |
SalesCommission | Double | False |
The commission of sales for this sales order. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
Tag | String | False |
A list of tags related to this record. |
Layout_Id | String | False |
The Id of the layout used in this sales order. |
CreatedTime | Datetime | False |
The time when the record was created. |
AccountName_Id | String | False |
The Id of the account of this sales order. |
ModifiedTime | Datetime | False |
The time when the record was modified. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
BillingStreet | String | False |
The billing street of the record. |
ShippingStreet | String | False |
The shipping street of the record. |
BillingCity | String | False |
The billing city of the record. |
ShippingCity | String | False |
The shipping city of the record. |
BillingState | String | False |
The billing state of the record. |
ShippingState | String | False |
The shipping state of the record. |
BillingCode | String | False |
The billing code of the record. |
ShippingCode | String | False |
The shipping code of the record. |
BillingCountry | String | False |
The billing country of the record. |
ShippingCountry | String | False |
The shipping country of the record. |
ProductDetails | String | False |
A json aggregate of the product details related to this sales order. |
SubTotal | Double | True |
The sub total price of the sales order. |
Discount | Double | False |
The amount of discount applied to this sales order. |
Tax | Double | True |
The amount of tax applied to this sales order. |
Adjustment | Double | False |
The amount of adjustment applied to this sales order. |
GrandTotal | Double | True |
The grand total of the sales order. |
TermsandConditions | String | False |
The terms and conditions of the sales order. |
Description | String | False |
The description of the sales order. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String |
Used to search for a specific word in records. |
DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
Converted | Boolean |
Set to true to return only converted records. |
Approved | Boolean |
Set to true to return only approved records. |
CustomViewId | String |
The custom view Id to be used for filtering this record. |
OrderedItems | String |
Ordered Items SubForm. This column can only be used for Insert and Update. |
Create, update, delete, and query information regarding solutions.
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 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.
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Solutions WHERE Id = '3152079000000153079'
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.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for this record. |
SolutionNumber | String | False |
The number of the solution. |
SolutionOwner_Id | String | False |
The Id of the owner of the solution. |
SolutionOwner_FirstName | String | False |
The First Name of the owner of the solution. |
SolutionOwner_LastName | String | False |
The Last Name of the owner of the solution. |
SolutionTitle | String | False |
The title of the solution. |
Published | Bool | False |
Whether the solution is published or not. |
Status | String | False |
The status of the solution. |
ProductName_Id | String | False |
The Id of the product concerning this solution. |
No_ofcomments | Int | True |
The number of different comments in this solution. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
CreatedTime | Datetime | False |
The time when the record was created. |
ModifiedTime | Datetime | False |
The time when the record was modified. |
Tag | String | False |
A list of tags related to this record. |
Question | String | False |
The question which was asked that led to the creating of this solution. |
Answer | String | False |
The answer given for this solution. |
AddComment | String | False |
An additional comment give for this solution. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String |
Used to search for a specific word in records. |
DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
Converted | Boolean |
Set to true to return only converted records. |
Approved | Boolean |
Set to true to return only approved records. |
CustomViewId | String |
The custom view Id to be used for filtering this record. |
Create, update, delete, and query information regarding tasks.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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.
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Tasks WHERE Id = '3152079000000153079'
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.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for this record. |
TaskOwner_Id | String | False |
The Id of the owner of the task. |
TaskOwner_FirstName | String | False |
The First Name of the owner of the task. |
TaskOwner_LastName | String | False |
The Last Name of the owner of the task. |
Subject | String | False |
The subject of the task. |
DueDate | Date | False |
The date when this task is due. |
ContactName_Id | String | False |
The Id of the contact of the task. |
RelatedTo_Id | String | False |
The Id of the object related to the task. |
Status | String | False |
The status of the task. |
Priority | String | False |
The priority of the task. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
Tag | String | False |
A list of tags related to this record. |
SendNotificationEmail | Bool | False |
Whether a notification email should be sent for this task or not. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
CreatedTime | Datetime | False |
The time when the record was created. |
ModifiedTime | Datetime | False |
The time when the record was modified. |
Repeat | String | False |
If this task is recurring or not. |
ClosedTime | Datetime | False |
The time when this task closes. |
Description | String | False |
The description of the tax. |
ModuleName | String | False |
The name of the module this task belongs to. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String |
Used to search for a specific word in records. |
DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
Converted | Boolean |
Set to true to return only converted records. |
Approved | Boolean |
Set to true to return only approved records. |
CustomViewId | String |
The custom view Id to be used for filtering this record. |
Create, update, delete, and query information regarding vendors.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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.
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Vendors WHERE Id = '3152079000000153079'
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.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for this record. |
VendorOwner_Id | String | False |
The Id of the owner of the vendor. |
VendorOwner_FirstName | String | False |
The First Name of the owner of the vendor. |
VendorOwner_LastName | String | False |
The Last Name of the owner of the vendor. |
VendorName | String | False |
The name of the vendor. |
Phone | String | False |
The phone number of the vendor. |
String | False |
The email address of the vendor. | |
Website | String | False |
The website of the vendor. |
GLAccount | String | False |
The GL account of the vendor. |
Category | String | False |
The category in which this vendor is placed at. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
CreatedTime | Datetime | False |
The time when the record was created. |
ModifiedTime | Datetime | False |
The time when the record was modified. |
Tag | String | False |
A list of tags related to this record. |
Street | String | False |
The street associated with this vendo's address. |
City | String | False |
The city associated with this vendo's address. |
State | String | False |
The state associated with this vendo's address. |
ZipCode | String | False |
The ZIP code associated with this vendo's address. |
Country | String | False |
The country associated with this vendo's address. |
Description | String | False |
A brief description regarding this vendor. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String |
Used to search for a specific word in records. |
DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
Converted | Boolean |
Set to true to return only converted records. |
Approved | Boolean |
Set to true to return only approved records. |
CustomViewId | String |
The custom view Id to be used for filtering this record. |
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます(その機能がデータソースに適用できる場合)。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。
ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。
Name | Description |
ActionsPerformed | Query information regarding performed actions. |
CustomFieldHistoryTracking | Query information regarding different histories for a particular custom field. |
Fields | To get the field metadata for the specified module. |
InvoiceProductDetails | Query information regarding different product details. Not available in free and standard ZohoCRM accounts. |
Layouts | To get the layouts metadata for the specified module. |
ListFields | To get the field metadata for the specified module. |
ModuleAttachedFiles | Retrieves all the files attached to a specified module. |
Modules | To get the modules metadata for the specified account. |
Organizations | Query information regarding different organizations. |
PriceBookPricingDetails | Query information regarding different pricing details. Not available in free and standard ZohoCRM accounts. |
Profiles | Query information regarding different profiles. |
PurchaseOrderProductDetails | Query information regarding different product details. Not available in free and standard ZohoCRM accounts. |
QuoteProductDetails | Query information regarding different product details. Not available in free and standard ZohoCRM accounts. |
RecordCount | To fetch the total number of records in the module. |
Roles | Query information regarding different roles. |
SalesOrderProductDetails | Query information regarding different product details. Not available in free and standard ZohoCRM accounts. |
StageHistories | Query information regarding different stage histories for a particular deal. |
Territories | Get the list of territories enabled for your organization. |
Users | Query information regarding different users. |
Visits | Query information regarding recent visits. |
Query information regarding performed actions.
Name | Type | Description |
Id [KEY] | String | The Id of the performed action. |
ActionType | String | The type of the performed action. |
Actions | String | The actions performed. |
TimeSpent | String | The time spent performing the action. |
ActionPerformedTime | Datetime | The date and time when the action was performed. |
ParentID_Id | String | The Id of the parent object where the action was performed. |
ParentID_Name | String | The name of the parent object where the action was performed. |
ChatAttachment_Id | String | The Id of the chat attachment for the action. |
ChatAttachment_Name | String | The name of the chat attachment for the action. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String | Used to search for a specific word in records. |
DuplicateCheckFields | String | The field/s to be used for checking in an upsert. |
Converted | Bool | Set to true to return only converted records. |
Approved | Bool | Set to true to return only approved records. |
CustomViewId | String | The custom view Id to be used for filtering this record. |
Query information regarding different histories for a particular custom field.
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.
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'
Name | Type | Description |
Id [KEY] | String | A unique numeric identifier for the history. |
ModuleName | String | A unique numeric identifier for the module instance this custom field tracking belongs to. |
EntityId | String | A unique numeric identifier for the module instance this custom field tracking belongs to. |
FieldName | String | The name of the custom field. |
HistoryName | String | The name of the custom field tracking history. |
FieldValue | String | The value of the custom field. |
DurationDays | Integer | The duration of this stage. |
ModifiedAt | Datetime | The time this historical value was last modified. |
ModifiedById | String | The id of the user who modified the value. |
ModifiedByName | String | The name of the user who modified the value. |
CurrencySymbol | String | The currency symbol for the value. |
ProcessFlow | Boolean | The boolean indicating the process flow for this historical value. |
Editable | Boolean | The boolean indicating if this historical value can be edited. |
Approved | Boolean | The boolean indicating if this historical value has been approved. |
To get the field metadata for the specified module.
The Sync App uses 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 Fields WHERE ModuleName = 'Deals'
Name | Type | Description |
DisplayValue | String | The name of the field. |
ActualValue | String | The actual name of the field. |
Id | String | The unique identifier of the field |
ModuleName | String | The name of the module which the user wants the fields. |
Query information regarding different product details. Not available in free and standard ZohoCRM accounts.
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.
For example, the following queries are processed server side:
SELECT * FROM InvoiceProductDetails WHERE InvoiceId = '3152079000000301143'
Name | Type | Description |
Id [KEY] | String | A unique numeric identifier for the product detail. |
InvoiceId [KEY] | String | A unique numeric identifier for the invoice this product detail belongs to. |
ProductId | String | A unique numeric identifier for the id of the product. |
ProductCode | String | The code of the product. |
ProductName | String | The name of the product. |
ProductDescription | String | The description of the product. |
Quantity | Double | The quantity of products in this product detail. |
Discount | Double | The discount applied to this product detail. |
TotalAfterDiscount | Double | The total after discount for this product detail. |
NetTotal | Double | The net total for this product detail. |
Book | String | The book linked with this product detail. |
Tax | Double | The total tax of this product detail. |
ListPrice | Double | The listing price of this product detail. |
UnitPrice | Double | The unit price of the product. |
QuantityInStock | Double | The quantity in stock for this product. |
Total | Double | The total price for this product detail. |
LineTax | String | A line tax aggregate regarding this product detail. |
To get the layouts metadata for the specified module.
The Sync App uses 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 Layouts WHERE ModuleName = 'Deals'
Name | Type | Description |
Id | String | The unique identifier of the layout. |
Name | String | Represents the name of the layout. |
Type | String | Represents if the section is used or not in the layout. |
ModuleName | String | The name of the module which the user wants the layout. |
To get the field metadata for the specified module.
The Sync App uses 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 ListFields WHERE ModuleName = 'Deals'
Name | Type | Description |
ApiName | String | The Api Name. |
AssociationDetails | String | The Association Details. |
BlueprintSupported | Boolean | Is Blueprint Supported. |
BusinesscardSupported | Boolean | Is Businesscard Supported. |
ConvertMappingAccounts | String | The Convert Mapping Accounts. |
ConvertMappingContacts | String | The Convert Mapping Contacts. |
ConvertMappingDeals | String | The Convert Mapping Deals. |
CreatedSource | String | The Created Source. |
Crypt | String | The Crypt. |
CurrencyPrecision | Integer | The Currency Precision. |
CurrencyRoundingOption | String | The Currency Rounding Option. |
CustomField | Boolean | Is Custom Field. |
DataType | String | The Data Type. |
DecimalPlace | Integer | The Decimal Place. |
DisplayField | Boolean | Is Display Field. |
DisplayLabel | String | The Display Label. |
DisplayType | Integer | The Display Type. |
External | String | The External. |
FieldLabel | String | The Field Label. |
FieldReadOnly | Boolean | Is Field ReadOnly. |
Filterable | Boolean | Is Filterable. |
HistoryTracking | String | The History Tracking. |
Id | String | The Id. |
JsonType | String | The Json Type. |
Length | Integer | The Length. |
MassUpdate | Boolean | Is Mass Update. |
PickListValues | String | The Pick List Values. |
PickListValuesSortedLexically | Boolean | Is Pick List Values Sorted Lexically. |
Profiles | String | The Profiles. |
QuickSequenceNumber | String | The QuickSequenceNumber. |
ReadOnly | Boolean | Is ReadOnly. |
Sortable | Boolean | Is Sortable. |
Subform | String | The Subform. |
SystemMandatory | Boolean | Is System Mandatory. |
Tooltip | String | The Tool tip. |
Type | String | The Type. |
UiType | Integer | The Ui Type. |
ViewTypeCreate | Boolean | Is View Type Create. |
ViewTypeEdit | Boolean | Is View Type Edit. |
ViewTypeQuickCreate | Boolean | Is View Type Quick Create. |
ViewTypeView | Boolean | Is View Type View. |
Visible | Boolean | Is Visible. |
Webhook | Boolean | Is Webhook. |
ModuleName | String | The name of the module which the user wants the fields. |
Retrieves all the files attached to a specified module.
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.
For example, the following queries are processed server side:
SELECT * FROM ModuleAttachedFiles WHERE ModuleName = "Leads"
Note: The UploadFile and DownloadFile stored procedures will not work as expected if executed in regards to a custom field. They only upload or download files in the "Attachments" section of the module. Uploading and deleting files from a custom field of type "fileupload" can be done only through the UI.
Name | Type | Description |
FileId | String | Id of the file attached to the module. |
FileName | String | Name of the file attached to the module. |
AttachmentId [KEY] | String | Id of the attachment. |
CreatorId | String | Id of the user who uploaded the attachment. |
EntityId | String | Id of the entity. |
DownloadUrl | String | URL to download the attachment. |
PreviewUrl | String | URL to preview the attachmen. |
FileSize | String | The size of the attachment. |
FileExtension | String | Extension of the attachment. |
ModuleName | String | Id of the module. |
To get the modules metadata for the specified account.
The Sync App uses 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 Modules
Name | Type | Description |
Id | String | The unique identifier of the modules |
Name | String | The name of the module which the user wants. |
SequenceNumber | Integer | The sequence number of the field. |
ApiName | String | The api name of the field. |
Query information regarding different organizations.
The Sync App processes filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.
Name | Type | Description |
Id [KEY] | String | A unique numeric identifier for the organization. |
CompanyName | String | The name of the company for this organization. |
PrimaryEmail | String | The primary email of the organization. |
Phone | String | The phone number of the organization. |
Mobile | String | The mobile phone number of the organization. |
IsoCode | String | The ISO code of the organization. |
Description | String | The description of the organization. |
Country | String | The country where this organization is situated. |
City | String | The city where this organization is situated. |
State | String | The state where this organization is situated. |
Street | String | The street where this organization is situated. |
Zip | String | The zip where this organization is situated. |
CountryCode | String | The country code of the organization. |
Alias | String | The alias of the organization. |
Fax | String | The fax of the organization. |
EmployeeCount | Int | The number of employees this organization has. |
Website | String | The website of the organization. |
CurrencySymbol | String | The default currency symbol for the organization. |
CurrencyLocale | String | The default currency locale for the organization. |
PrimaryZuid | String | The primary ZUID for the organization. |
TimeZone | String | The time zone for the organization. |
Zgid | String | The zgid for the organization. |
MCStatus | Boolean | Whether this organization has MC status or not. |
GappsEnabled | Boolean | Whether this organization has gapps enabled or not. |
LicenseDetailsPaidExpiry | Datetime | The date and time the subscription expires for this organization. |
LicenseDetailsTrialType | String | The trial type of subscription the organization has. |
LicenseDetailsTrialExpiry | Datetime | The date and time the trial subscription expires for this organization. |
LicenseDetailsPaid | Boolean | Whether the organization has a paid subscription. |
LicenseDetailsPaidType | String | The type of subscription the organization has. |
Query information regarding different pricing details. Not available in free and standard ZohoCRM accounts.
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.
For example, the following queries are processed server side:
SELECT * FROM PriceBookPricingDetails WHERE PriceBookId = '3152079000000317001'
Name | Type | Description |
Id [KEY] | String | A unique numeric identifier for the pricing detail. |
PriceBookId [KEY] | String | A unique numeric identifier for the price book this pricing detail belongs to. |
Discount | Double | How much discount should be applied for this pricing detail. |
FromRange | Double | Starting from what amount should this discount be applied. |
ToRange | Double | Until what amount should this discount be applied. |
Query information regarding different profiles.
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.
For example, the following queries are processed server side:
SELECT * FROM Profiles WHERE Id = '3152079000000026011'
Name | Type | Description |
Id [KEY] | String | A unique numeric identifier for the profile. |
Name | String | The name of the profile. |
Description [KEY] | String | A small description regarding this profile. |
CreatedByName | String | The name of the user who created this profile. |
CreatedById | String | The id of the user who created this profile. |
CreatedAt | Datetime | The time this profile was created. |
ModifiedByName | String | The name of the user who modified this profile. |
ModifiedById | String | The id of the user who modified this profile. |
ModifiedAt | Datetime | The time this profile was last modified. |
Category | Boolean | Whether this profile is a category or not. |
Query information regarding different product details. Not available in free and standard ZohoCRM accounts.
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.
For example, the following queries are processed server side:
SELECT * FROM PurchaseOrderProductDetails WHERE PurchaseOrderId = '3152079000000317029'
Name | Type | Description |
Id [KEY] | String | A unique numeric identifier for the product detail. |
PurchaseOrderId [KEY] | String | A unique numeric identifier for the purchase order this product detail belongs to. |
ProductId | String | A unique numeric identifier for the id of the product. |
ProductCode | String | The code of the product. |
ProductName | String | The name of the product. |
ProductDescription | String | The description of the product. |
Quantity | Double | The quantity of products in this product detail. |
Discount | Double | The discount applied to this product detail. |
TotalAfterDiscount | Double | The total after discount for this product detail. |
NetTotal | Double | The net total for this product detail. |
Book | String | The book linked with this product detail. |
Tax | Double | The total tax of this product detail. |
ListPrice | Double | The listing price of this product detail. |
UnitPrice | Double | The unit price of the product. |
QuantityInStock | Double | The quantity in stock for this product. |
Total | Double | The total price for this product detail. |
LineTax | String | A line tax aggregate regarding this product detail. |
Query information regarding different product details. Not available in free and standard ZohoCRM accounts.
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.
For example, the following queries are processed server side:
SELECT * FROM QuoteProductDetails WHERE QuoteId = '3152079000000317060'
Name | Type | Description |
Id [KEY] | String | A unique numeric identifier for the product detail. |
QuoteId [KEY] | String | A unique numeric identifier for the quote this product detail belongs to. |
ProductId | String | A unique numeric identifier for the id of the product. |
ProductCode | String | The code of the product. |
ProductName | String | The name of the product. |
ProductDescription | String | The description of the product. |
Quantity | Double | The quantity of products in this product detail. |
Discount | Double | The discount applied to this product detail. |
TotalAfterDiscount | Double | The total after discount for this product detail. |
NetTotal | Double | The net total for this product detail. |
Book | String | The book linked with this product detail. |
Tax | Double | The total tax of this product detail. |
ListPrice | Double | The listing price of this product detail. |
UnitPrice | Double | The unit price of the product. |
QuantityInStock | Double | The quantity in stock for this product. |
Total | Double | The total price for this product detail. |
LineTax | String | A line tax aggregate regarding this product detail. |
To fetch the total number of records in the module.
The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The module is a mandatory filter for the Sync App.
Note: It works only with ApiVersion=2.1.
For example, the following queries are processed server-side:
SELECT * FROM RecordCount WHERE ModuleName = 'Leads' SELECT * FROM RecordCount WHERE ModuleName IN ('Leads','Invoices')
Name | Type | Description |
Count [KEY] | Integer | The total number of records in the module. |
ModuleName | String | The name of the module which the user wants the count. |
Query information regarding different roles.
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.
For example, the following queries are processed server side:
SELECT * FROM Roles WHERE Id = '3152079000000026008'
Name | Type | Description |
Id [KEY] | String | A unique numeric identifier for the role. |
Name | String | The name of the role. |
DisplayLabel [KEY] | String | The way the role is displayed in the UI. |
ReportingToName | String | The name of the role this role reports to. |
ReportingToId | String | The id of the role this role reports to. |
AdminUser | Boolean | Whether this role has administrative privileges or not. |
Query information regarding different product details. Not available in free and standard ZohoCRM accounts.
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.
For example, the following queries are processed server side:
SELECT * FROM SalesOrderProductDetails WHERE SalesOrderId = '3152079000000355025'
Name | Type | Description |
Id [KEY] | String | A unique numeric identifier for the product detail. |
SalesOrderId [KEY] | String | A unique numeric identifier for the sales order this product detail belongs to. |
ProductId | String | A unique numeric identifier for the id of the product. |
ProductCode | String | The code of the product. |
ProductName | String | The name of the product. |
ProductDescription | String | The description of the product. |
Quantity | Double | The quantity of products in this product detail. |
Discount | Double | The discount applied to this product detail. |
TotalAfterDiscount | Double | The total after discount for this product detail. |
NetTotal | Double | The net total for this product detail. |
Book | String | The book linked with this product detail. |
Tax | Double | The total tax of this product detail. |
ListPrice | Double | The listing price of this product detail. |
UnitPrice | Double | The unit price of the product. |
QuantityInStock | Double | The quantity in stock for this product. |
Total | Double | The total price for this product detail. |
LineTax | String | A line tax aggregate regarding this product detail. |
Query information regarding different stage histories for a particular deal.
Name | Type | Description |
Id [KEY] | String | A unique numeric identifier for the stage. |
DealId | String | A unique numeric identifier for the deal this stage belongs to. |
Stage | String | The stage number for this stage. |
Amount | Double | The amount of money spent for this stage. |
DurationDays | Integer | The duration of this stage. |
ExpectedRevenue | Double | The expected revenue from this stage. |
Probability | Double | The probability for the stage to happen. |
CloseDate | Date | The date when this stage closes. |
LastModifiedTime | Datetime | The time this stage was last modified. |
ModifiedById | String | The id of the user who modified the stage. |
ModifiedByName | String | The name of the user who modified the stage. |
Get the list of territories enabled for your organization.
All the filters are executed at client side within the Sync App.
SELECT * from Territories;
Name | Type | Description |
Id [KEY] | String | Represents the unique ID of the territory. |
Name | String | Represents the name of the territory. |
ParentId | String | Represents the unique ID of the parent territory, if any. |
Criteria | String | Represents the territory criteria details. |
Managername | String | Represents the name of the current territory's manager. |
Managerid | String | Represents the ID of the current territory's manager. |
CreatedByName | String | Represents the name of the user who created the current territory. |
CreatedById | String | Represents the ID of the user who created the current territory. |
ModifiedByName | String | Represents the name of the user who last modified the current territory. |
ModifiedByid | String | Represents the ID of the user who last modified the current territory. |
CreatedAt | Datetime | Represents the date and time at which the current territory was created. |
ModifiedAt | Datetime | Represents the date and time at which the current territory was last modified. |
Desription | String | Represents the description of the territory, if any. |
Query information regarding different users.
The Sync App will use 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.
For example, the following queries are processed server side:
SELECT * FROM Users WHERE Id = '3152079000000150015'
Name | Type | Description |
Id [KEY] | String | A unique numeric identifier for the user. |
FirstName | String | The first name of the user. |
LastName | String | The last name of the user. |
FullName | String | The full name of the user. |
String | The email of the user. | |
RoleName | String | The name of the role the user has. |
RoleId | String | The Id of the role the user has. |
ProfileName | String | The name of the profile the user has. |
ProfileId | String | The Id of the profile the user has. |
Country | String | The country where the user is situated. |
City | String | The city where the user is situated. |
Street | String | The street where the user is situated. |
State | String | The state where the user is situated. |
Zip | String | The zip where the user is situated. |
Alias | String | The alias of the user. |
Signature | String | The signature of the user. |
NameFormat | String | The format of the name of the user. |
PersonalAccount | Boolean | Whether this user has a personal account or not. |
DefaultTabGroup | String | The default tab group for this user. |
CountryLocale | String | The default country locale of the user. |
Fax | String | The fax of the user. |
Website | String | The website of the user. |
Mobile | String | The mobile phone number of the user. |
Phone | String | The phone number of the user. |
Dob | String | The date of birth of the user. |
Status | String | The status of the user. |
Confirm | Boolean | Whether this user has confirmed his email or not. |
Language | String | The Language of the user. |
Locale | String | The locale of the user. |
TimeFormat | String | The default time format of the user. |
DateFormat | String | The default date format of the user. |
DecimalSeparator | String | The locale of the default decimal separator of the user. |
TimeZone | String | The time zone of the user. |
Zuid | String | The default ZUID of the user. |
Territories | String | A comma separeted string of the user's territories. |
CreatedByName | String | The name of the user who created this user. |
CreatedById | String | The id of the user who created this user. |
CreatedAt | Datetime | The time this user was created. |
ModifiedByName | String | The name of the user who modified this user. |
ModifiedById | String | The id of the user who modified this user. |
ModifiedAt | Datetime | The time this user was last modified. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Type | String | Limit the users returned to the ones of this type
使用できる値は次のとおりです。AllUsers, ActiveUsers, DeactiveUsers, ConfirmedUsers, NotConfirmedUsers, DeletedUsers, ActiveConfirmedUsers, AdminUsers, ActiveConfirmedAdmins, CurrentUser |
Query information regarding recent visits.
Name | Type | Description |
Id [KEY] | String | The Id of the visit. |
PageVisited | String | The name of the visited page. |
VisitedBy_Id | String | The Id of the visitor. |
VisitedBy_FirstName | String | The First Name of the visitor. |
VisitedBy_LastName | String | The Last Name of the visitor. |
IPAddress | String | The IP address of the visitor. |
TimeSpent(Minutes) | String | The time spent in minutes for the visit. |
Referrer | String | The referrer of the visitor. |
VisitedPageURL | String | The URL of the visited page. |
CreatedBy_Id | String | The Id of the object which created the visit. |
ModifiedBy_Id | String | The Id of the object which modified the visit. |
ModifiedBy_FirstName | String | The First Name of the object which modified the visit. |
ModifiedBy_LastName | String | The Last Name of the object which modified the visit. |
CreatedTime | Datetime | The date and time when the visit was created. |
ModifiedTime | Datetime | The date and time when the visit was modified. |
AttendedBy | String | Who attended the visit. |
UserDetails | String | The user details of the visit. |
Browser | String | The browser used for the visit. |
TimeVisited | Datetime | The date and time of the visit. |
VisitorType | String | The type of visitor for the visit. |
Revenue | Decimal | The revenue generated by the visit. |
NumberofPages | Int | The number of pages visited from the visit. |
PortalName | String | The name of the portal used for the visit. |
SearchKeyword | String | The search keyword used for the visit. |
SearchEngine | String | The search engine used for the visit. |
OperatingSystem | String | The operating system of the visitor. |
Gclid | String | The GCLID of the visitor. |
Keyword | String | The keyword used in the visit. |
ClickType | String | The click type of the visit. |
Devicetype | String | The type of the device of the visitor. |
AdNetwork | String | The ad network used in the visit. |
SearchPartnerNetwork | String | The search partner network for the visit. |
AdCampaignName | String | The ad campaign name of the visit. |
AdGroupName | String | The ad group name of the visit. |
Ad | String | The ad used for the visit. |
AdClickDate | Date | The date and time when the ad was clicked. |
VisitSource | String | The source of the visit. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Word | String | Used to search for a specific word in records. |
DuplicateCheckFields | String | The field/s to be used for checking in an upsert. |
Converted | Bool | Set to true to return only converted records. |
Approved | Bool | Set to true to return only approved records. |
CustomViewId | String | The custom view Id to be used for filtering this record. |
After updating or inserting a new record into Zoho CRM account, the behavior of ModifiedTime filter server-side may be inconsistent due to API related issues, leading to the wrong filtered results or no results at all until all the data is synchronized server-side. In order to resolve this issue temporarily, the ModifiedTime filter should be adjusted to an hour(60 minutes) prior to the current filter that you have specified.
A Subform is a secondary table that allow you to add multiple line items to a primary table. The Sync App allows you to retrieve Subform information, add lines to an existing subform, modify subform entries, and delete entries.
In order to access the Subform data, you must filter on the Id of the parent:
SELECT * FROM ParentTable WHERE Id = 21142143232903This will return the entire Subform as a JSON aggregate.
It is possible to insert a new parent object along with its full subform record all in one operation. This is done by formatting the Subform as a JSON aggregate and setting the name of the Subform field to this string in your INSERT statement. The following query will insert a parent record with a subform containing two line items.
INSERT INTO ParentTable (ParentName,ChildForm) VALUES ( 'New Parent', '[ { "subformprop1": "row1val1", "subformprop2": "row1val2" }, { "subformprop1": "row2val1", "subformprop2": "row2val2" } ]')
Any modifications done to an existing Subform requires an UPDATE request on the parent record. When building the JSON aggregate of the Subform in your query, you must specify the Id of the lines that you wish to leave untouched. If the Id is not included in the JSON, that line will be deleted from the Subform. New lines can be added by appending a line in your JSON that does not contain an Id. Existing lines can be modified by specifying the Id and any properties to be modified. Properties not specified will be unchanged. Below are examples of how to add lines, modify existing lines, and delete lines from a Subform record that already exists.
To add a line to an existing Subform, you will need to issue an UPDATE request with a JSON aggregate that contains all of the existing Ids specified along with the new lines specified without Ids. The service will recognize that it needs to insert the new line because the record does not have an Id. See below example.
UPDATE ParentTableTable SET ChildForm = -- first include existing child Ids so that they do not get deleted, then append the new lines '[ { "id":"2732548000001192003" }, { "id":"2732548000001192004" }, { "id":"2732548000001192005" }, { "subformprop1": "newline1val", "subformprop2": "newline1val2", }, { "subformprop1": "newline2val", "subformprop2": "newline2val2" } ]' WHERE id=2732548000001192001
To modify a line, specify the Id of that line and any properties you wish to modify. Properties not specified will remain unchanged. In the example below, records with Ids ending in 3 and 4 will be untouched, and the record ending in 5 gets one property modified. Other records that exist are deleted.
UPDATE ParentTableTable SET ChildForm = '[ { "id":"2732548000001192003" }, { "id":"2732548000001192004" }, { "id":"2732548000001192005", "subformprop1": "updatedval" } ]' WHERE id=2732548000001192001
You can perform any combination of deletions, inserts, and updates to line items in a single request depending on how you format the JSON aggregate of the Subform.
Sync App は、データソースの型を、スキーマで使用可能な対応するデータ型にマッピングします。以下のテーブルはこれらのマッピングを説明します。
Zoho CRM | CData スキーマ |
Auto-Number | string |
Checkbox | bool |
Currency | float |
Date | date |
Date/Time | datetime |
Decimal | string |
string | |
FileUpload | string |
Formula | string |
LongInteger | long |
Lookup | string |
Multi-Line | string |
Multi-Select | string |
Number | int |
Percent | string |
Phone | string |
PickList | string |
SingleLine | string |
URL | string |
User | string |
プロパティ | 説明 |
ApiVersion | The Zoho CRM API version to use. |
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
AccountsServer | The full Account Server URL. |
APIDomain | The full URL of the API domain. |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
プロパティ | 説明 |
LogModules | ログファイルに含めるコアモジュール。 |
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
プロパティ | 説明 |
AggregateColumnSize | Sets the length of a aggregate field for a provider. |
IncludeCustomViews | If set to true, the provider will display custom views among the other views and make them available for use. |
IncludeRelatedLists | If set to true, the provider will display related List views among the other views and make them available for use. |
MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PageSize | The number of results to return per page of data retrieved from Zoho CRM. |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UseCOQL | Determines whether to use Query API. |
UseDisplayNames | If set to false, the provider will use api names for some operations. |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
UseSandbox | Determines whether the calls will be sent to a Sandbox instance instead of a regular one. |
UseServerSideFiltering | If set to false, the provider will not send the filters server-side but will process them client-side. |
UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
ApiVersion | The Zoho CRM API version to use. |
The Zoho CRM API version to use.
The Zoho CRM API version to use. Generally this property does not need to be set.
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
AccountsServer | The full Account Server URL. |
APIDomain | The full URL of the API domain. |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
The full Account Server URL.
The full Account Server URL. You only need to supply this when executing the RefreshOAuthAccessToken stored procedure with InitiateOAuth=Off. Most of the time, the value of this property will be https://accounts.zoho.com/, but if your account resides in a different location, then the domain should change accordingly (.eu, .in, .com.au, ...).
The full URL of the API domain.
The full URL of the API domain. You only need to supply this when using your own OAuth access token with InitiateOAuth=Off. Otherwise, the API domain will be retrieved from the OAuth flow. Most of the time, the value of this property will be https://www.zohoapis.com, but if your account resides in a different location, then the domain should change accordingly (.eu, .in, .com.au, ...).
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
説明 | 例 |
フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
タイプ | デフォルトポート | 説明 |
TUNNEL | 80 | これが設定されている場合、Sync App はZoho CRM への接続を開き、プロキシを経由して通信が行われます。 |
SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
ALWAYS | 接続は、常にSSL 有効となります。 |
NEVER | 接続は、SSL 有効になりません。 |
TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
ログファイルに含めるコアモジュール。
指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\ZohoCRM Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます:
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
AggregateColumnSize | Sets the length of a aggregate field for a provider. |
IncludeCustomViews | If set to true, the provider will display custom views among the other views and make them available for use. |
IncludeRelatedLists | If set to true, the provider will display related List views among the other views and make them available for use. |
MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PageSize | The number of results to return per page of data retrieved from Zoho CRM. |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UseCOQL | Determines whether to use Query API. |
UseDisplayNames | If set to false, the provider will use api names for some operations. |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
UseSandbox | Determines whether the calls will be sent to a Sandbox instance instead of a regular one. |
UseServerSideFiltering | If set to false, the provider will not send the filters server-side but will process them client-side. |
UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |
Sets the length of a aggregate field for a provider.
Sets the length of a aggregate field for a provider. If not set the length reported by the server will be considered.
If set to true, the provider will display custom views among the other views and make them available for use.
If set to true, the Sync App will display custom views among other views. Retrieving custom views is not only a costly operation but it also decreases performance, that's why this property defaults to 'false'.
If set to true, the provider will display related List views among the other views and make them available for use.
If set to true, the Sync App will display related List views views among other views. Retrieving related Lists is not only a costly operation but it also decreases performance, that's why this property defaults to 'false'.
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
The number of results to return per page of data retrieved from Zoho CRM.
Note that the PageSize must be between 1 and 200.
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
Determines whether to use Query API.
Query API has limitation to select maximum of 50 columns. Please set the value to false in case more than 50 columns need to be selected.
If set to false, the provider will use api names for some operations.
If set to true, the Sync App will use api names for some operations. This property is used for custom modules: The API name for custom modules is different from a custom module name in the Zoho CRM UI. For example, if you create a Potentials custom module in Zoho CRM, the Sync App will make the underlying requests to the API name; for example, CustomModule_1.
Set this property to true to use the api name in SQL queries.
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{ "MyView": { "query": "SELECT * FROM Accounts WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"
Determines whether the calls will be sent to a Sandbox instance instead of a regular one.
If the Zoho account you plan on using this driver on supports Sandboxes and you want to use one, set this property to true. Otherwise, just leave empty to proceed using your regular CRM instance.
If set to false, the provider will not send the filters server-side but will process them client-side.
If set to true, the Sync App will send the filters server-side. In ZohoCRM, if the data is updated recently, it might take some time for the filters to work server-side so only in this case it is recommended for this property to be set to false in order to get proper results. In all the other cases this will be a considerably expensive operation to do client-side and it might take longer to retrieve the data.
テーブルとカラムに簡略名を使用するかどうかを決定するboolean。
Zoho CRM テーブルおよびカラムでは、 通常のデータベースでは使うことが認められていない特殊記号・文字を名前に使うことができます。UseSimpleNames を使用すると、Sync App を従来のデータベースツールでより簡単に使用できるようになります。
UseSimpleNames をtrue に設定し、返されるテーブル名およびカラム名をシンプルにします。表示されるテーブル名 およびカラム名においてアルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。 英数字以外の文字はすべて、アンダースコアに変換されます。