CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるActiveCampaign へのアクセスを実現します。MySQL またはSQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してActiveCampaign に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server / MySQL データベースと同じように、ActiveCampaign への接続を標準化し、構成することができます。
このページでは、CData Cloud でのActiveCampaign への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのActiveCampaign への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してActiveCampaign からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、ActiveCampaign に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
ActiveCampaign はAPI キーによる認証をサポートしています。ActiveCampaign に接続するには、自身のアカウントでDeveloper ページに移動して以下を設定します。
これらのプロパティを設定する際、My Settings とSettings をを間違えないようにしてください。
Cloud はContacts、Accounts などのActiveCampaign リソースをリレーショナルテーブルとしてモデル化し、SQL を記述してActiveCampaign データをクエリできるようにします。
これらのオブジェクトへのライブ接続により、Cloud を使用するとActiveCampaign アカウントへのあらゆる変更が即座に反映されます。
ビュー は変更ができないテーブルです。一般的には、Read-only で更新が不可能なデータはビューとして表されます。
デフォルトの静的ビューに加え、Cloud ではダイナミックビューでのクエリも可能です。
これらはActiveCampaign アカウントの"リスト"("オーディエンス" とも呼ばれます)に基づいて作成されるビューです。
例えば、アカウントに以下の3つのリストがあると仮定しましょう:Master Contact List、New Audience、VIP List。
Cloud はそれらに基づいて3つのビューをリストします:List_MasterList、List_New Audience、List_VIP List。
ビューは、その特定のリストのメンバーである各コンタクトに関するデータを返します。
テーブル では、利用可能なテーブルを説明します。テーブルは、Accounts、Deals、DealGroups、DealStages、Tasks などのリソースを静的にモデル化するように定義されています。
Cloud はまた、AccountCustomFieldData、DealCustomFieldData、ContactCustomFieldData などのカスタムフィールドデータ情報を表すテーブルへのクエリもサポートしています。
さらに、Cloud は、メインリソース(Accounts、Contacts、Deals テーブルで利用可能)からのカスタムフィールドデータの更新や挿入をサポートし、カスタムフィールドはメインフィールドのカラムとして動的に追加されます。詳細については、特定のテーブルのセクションを参照してください。
Cloud はActiveCampaign のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Name | Description |
AccountContacts | Usage information for the operation AccountContacts.rsd. |
AccountCustomFieldData | Create, modify, delete and query the available deal custom field data in ActiveCampaign. |
Accounts | View many or all contacts by including their ID's or various filters. |
ContactCustomFieldData | Create, modify, delete and query the available contact custom field data in ActiveCampaign. |
Contacts | View many or all contacts by including their ID's or various filters. |
DealCustomFieldData | Create, modify, delete and query the available deal custom field data in ActiveCampaign. |
DealGroups | Lists all existing accounts. |
Deals | Usage information for the operation Deals.rsd. |
DealStages | Usage information for the operation DealStages.rsd. |
Tasks | Lists all existing accounts. |
Usage information for the operation AccountContacts.rsd.
The Cloud uses the ActiveCampaign API to process some of the filters.
For example, the following queries are processed server side:
SELECT * FROM AccountContacts WHERE Id = 10003 SELECT * FROM AccountContacts WHERE AccountId = 1 AND ContactId = 100
Inserting an account-contact association requires specifying a value for the AccountId and ContactId columns.
INSERT INTO AccountContacts (AccountId, ContactId) VALUES (2, 300) INSERT INTO AccountContacts (AccountId, ContactId, Jobtitle) VALUES (2, 300, 'nurse')
The driver supports updating account-contact information.
UPDATE AccountContacts SET ContactId = 3, JobTitle = 'updatedJobTitle' WHERE Id = 1 UPDATE AccountContacts SET JobTitle = 'updatedJobTitle' WHERE AccountId = 1
Remove all account-contacts association or an association by specifying the Id of the association.
DELETE FROM AccountContacts WHERE Id = 10003
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The Id of the account-contact association. |
AccountId | String | False |
The account Id. |
ContactId | String | False |
The contact Id. |
CreatedTimestamp | Datetime | True |
Datetime value which indicates when the assosiaction was created. |
JobTitle | String | False |
Job Title of the contact at the account. |
AccountLink | String | True |
Account link. |
ContactLink | String | True |
Contact link. |
UpdatedTimestamp | Datetime | True |
Datetime value which indicates when the assosiaction was last updated. |
Create, modify, delete and query the available deal custom field data in ActiveCampaign.
The Cloud uses the ActiveCampaign API to process some of the filters.
For example, the following queries are processed server side:
SELECT * FROM AccountCustomFieldData WHERE Id = 10003 SELECT * FROM AccountCustomFieldData WHERE AccountId = 1
Inserting an account custom field data requires specifying a value for the AccountId, CustomFieldId, FieldValue columns.
Additionally, the Cloud supports inserting account custom fields data from the Accounts table. See Accounts for more information.
INSERT INTO AccountCustomFieldData (FieldValue, CustomFieldId, AccountId) VALUES ('custom field value', 1, 5)
The Cloud supports updating account custom field data information. Updating an account custom field data requires specifying a value for the Id and CustomFieldId columns.
Additionally, it is possible to update account custom fields data from the Accounts table.
UPDATE AccountCustomFieldData SET FieldValue = 'Custom Field Value' WHERE Id = 13 AND CustomFieldId = 1
The Cloud supports removing accounts' custom field data.
DELETE FROM AccountcustomFieldData WHERE Id = 10
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The Id of the account custom field data. |
AccountCustomFieldMetumId | Integer | True |
The custom field metum Id. |
AccountId | Integer | False |
The ID of the account the field value relates to. |
CreatedTimestamp | Datetime | True |
Datetime value that indicates when the custom field value was set. |
CustomFieldId | Integer | False |
The ID of the custom field metum the field value relates to. |
CustomFieldName | String | True |
The name of the custom field metum the field value relates to. |
FieldValue | String | False |
Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5). |
AccountLink | String | True |
Account link. |
AccountCustomFieldMetumLink | String | True |
AccountCustomFieldMetum link. |
UpdatedTimestamp | Datetime | True |
Datetime value which indicates when the custom field data was last updated. |
FieldCurrency | String | False |
Value of the custom field currency type for a specific contact. This field is required when inserting currency custom fields. |
View many or all contacts by including their ID's or various filters.
The Cloud uses the ActiveCampaign API to process some of the filters.
For example, the following queries are processed server side:
SELECT * FROM Accounts WHERE Id = 10003 SELECT * FROM Accounts WHERE Name = 'testAccount'
As a note, due to server-side performance issues, even when the property IncludeCustomFields is set to TRUE, the custom fields will appear only in the table schema with null values. To retrieve the values of the custom fields, please refer to the AccountCustomFieldData table.
Inserting an account requires specifying the account name.
INSERT INTO Accounts (Name) VALUES ('testAccount2') INSERT INTO Accounts (Name, AccountUrl) VALUES ('account', 'http://accountUrl.com/')
Additionally, the Cloud supports inserting account and account custom fields data from the Accounts table. All custom field columns start with CF_.
INSERT INTO Accounts (Name, CF_Description, CF_Hidden, CF_Number) VALUES ('testAccount3', 'custom field value', 'custom field value', 123)
The Cloud supports updating account information.
Additionally, it is possible to update account custom fields data from the Accounts table.
UPDATE Accounts SET Name = 'updatedName', AccountUrl = 'http://updatedAccountUrl.com/' WHERE Id = 1 UPDATE Accounts SET Name = 'updatedName', CF_Description = 'custom field value', CF_Hidden = 'custom field value' WHERE Id = 1
Remove all accounts or an account by specifying the Id of the account.
DELETE FROM Accounts WHERE Id = 10003
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The Id column of the Accounts table. |
AccountUrl | String | False |
Account's website. |
ContactCount | Integer | True |
The ContactCount column of the Accounts table. |
CreatedTimestamp | Datetime | True |
The CreatedTimestamp column of the Accounts table. |
DealCount | Integer | True |
The DealCount column of the Accounts table. |
AccountContactsLink | String | True |
The AccountContactsLink column of the Accounts table. |
AccountCustomFieldDataLink | String | True |
The AccountCustomFieldDataLink column of the Accounts table. |
ContactEmailsLink | String | True |
The ContactEmailsLink column of the Accounts table. |
EmailActivitiesLink | String | True |
The EmailActivitiesLink column of the Accounts table. |
NotesLink | String | True |
The NotesLink column of the Accounts table. |
Name | String | False |
Account's name. |
UpdatedTimestamp | Datetime | True |
The UpdatedTimestamp column of the Accounts table. |
Create, modify, delete and query the available contact custom field data in ActiveCampaign.
The Cloud uses the ActiveCampaign API to process some of the filters.
For example, the following queries are processed server side:
SELECT * FROM ContactCustomFieldData WHERE Id = 10003 SELECT * FROM ContactCustomFieldData WHERE FieldValue = 'custom field value'
Inserting a contact custom field data requires specifying a value for the ContactId, FieldId, FieldValue columns.
Additionally, the Cloud supports inserting contact custom fields data from the Contacts table. See Contacts for more information.
INSERT INTO ContactCustomFieldData (FieldValue, FieldId, ContactId) VALUES ('custom field value', 1, 5)
The Cloud supports updating contact custom field data information. Updating contact custom field data requires specifying a value for the Id, ContactId and FieldId columns.
Additionally, it is possible to update contact custom fields data from the Contacts table.
UPDATE ContactCustomFieldData SET FieldValue = 'custom field value' WHERE Id = 8 AND ContactId = 3 AND FieldId = 2"
The Cloud supports removing contact custom field data.
DELETE FROM ContactCustomFieldData WHERE Id = 10
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The Id column of the ContactCustomFieldData table. |
CDate | Datetime | False |
The CDate column of the ContactCustomFieldData table. |
ContactId | String | False |
The ContactId column of the ContactCustomFieldData table. |
CustomFieldName | String | True |
The name of the custom field metum the field value relates to. |
FieldId | String | False |
ID of the field the value belongs to. |
FieldLink | String | False |
The FieldLink column of the ContactCustomFieldData table. |
OwnerLink | String | False |
The OwnerLink column of the ContactCustomFieldData table. |
Owner | String | False |
The Owner column of the ContactCustomFieldData table. |
Udate | Datetime | False |
The Udate column of the ContactCustomFieldData table. |
FieldValue | String | False |
Value of the custom field for a specific contact. |
View many or all contacts by including their ID's or various filters.
The Cloud uses the ActiveCampaign API to process some of the filters.
For example, the following queries are processed server side:
SELECT * FROM Contacts WHERE Id = 10 SELECT * FROM Contacts WHERE Udate >= '2019-06-30T10:44:34-05:00' SELECT * FROM Contacts WHERE Udate <= '2021-06-30T10:44:34-05:00' SELECT * FROM Contacts WHERE Cdate >= '2019-06-30T10:44:34-05:00' AND Cdate <= '2021-06-30T10:44:34-05:00'
As a note, due to server-side performance issues, even when the property IncludeCustomFields is set to TRUE, the custom fields will appear only in the table schema with null values. To retrieve the values of the custom fields, please refer to the ContactCustomFieldData table.
Inserting a contact requires specifying the contact email.
INSERT INTO Contacts (Email) VALUES ('testcontact@test.com') INSERT INTO Contacts (Email, FirstName, LastName, Phone) VALUES ('test@test.com', 'test', 'test', 'contactphonenumber')
Additionally, the Cloud supports inserting contact and contact custom fields data from the Contacts table. All custom field columns start with CF_.
INSERT INTO Contacts (Name, CF_Description, CF_Hidden, CF_Number) VALUES ('testcontact3', 'custom field value', 'custom field value', 123)
The Cloud supports updating contact information.
Additionally, it is possible to update contact custom fields data from the Contacts table.
UPDATE Contacts SET FirstName = 'updatedName' WHERE Id = 1 UPDATE Contacts SET CF_CustomField1 = 'custom field value', CF_CustomField2 = 'custom field value' WHERE Id = 1
The Cloud supports uploading large numbers of contacts into your account. This operation includes:
Contacts are imported in batches of up to 250 items. The importer is not recommended to be used for a small number of contacts. You can import contacts as below:
INSERT INTO Contacts#TEMP (Email) VALUES ('email1@test.com') INSERT INTO Contacts#TEMP (Email) VALUES ('email2@test.com') UPSERT INTO Contacts (Email) SELECT Email FROM Contacts#TEMP
Additionally, the Cloud supports BULK INSERT for the Contacts table. Please note this operation will cause a cost in performance as the Cloud validates if the submitted contacts exist before importing them.
INSERT INTO Contacts#TEMP (Email) VALUES ('email1@test.com') INSERT INTO Contacts#TEMP (Email) VALUES ('email2@test.com') INSERT INTO Contacts (Email) SELECT Email FROM Contacts#TEMP
To subscribe and unsubscribe contacts from a specific list set a value for the SubscribeTo and/or UnsubcribeFrom columns which accept a comma-separated list of list ids. For example:
INSERT INTO Contacts#TEMP (Email, SubscribeTo, UnsubcribeFrom) VALUES ('email1@test.com', '1,2', '6,12') INSERT INTO Contacts#TEMP (Email, SubscribeTo, UnsubcribeFrom) VALUES ('email2@test.com', '3,7', '6,1') UPSERT INTO Contacts (Email, SubscribeTo, UnsubcribeFrom) SELECT Email, SubscribeTo, UnsubcribeFrom FROM Contacts#TEMP
Contacts must meet all the following criteria in order to be created or updated with this API:
If contacts do not meet all of these requirements, they will be skipped by the importer.
Remove all contacts or a contact by specifying the Id of the contact.
DELETE FROM Contacts WHERE Id = 10003
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The Id column of the Contacts table. |
Adate | Datetime | True |
The Adate column of the Contacts table. |
Anonymized | String | True |
The Anonymized column of the Contacts table. |
BouncedDate | String | True |
The BouncedDate column of the Contacts table. |
BouncedHard | String | True |
The BouncedHard column of the Contacts table. |
BouncedSoft | String | True |
The BouncedSoft column of the Contacts table. |
Cdate | Datetime | True |
The Cdate column of the Contacts table. |
CreatedBy | String | True |
The CreatedBy column of the Contacts table. |
CreatedTimestamp | Datetime | True |
The CreatedTimestamp column of the Contacts table. |
CreatedUtcTimestamp | Datetime | True |
The CreatedUtcTimestamp column of the Contacts table. |
Deleted | String | True |
The Deleted column of the Contacts table. |
DeletedAt | String | True |
The DeletedAt column of the Contacts table. |
Edate | Datetime | True |
The Edate column of the Contacts table. |
String | False |
The Email column of the Contacts table. | |
EmailDomain | String | True |
The EmailDomain column of the Contacts table. |
EmailEmpty | Boolean | True |
The EmailEmpty column of the Contacts table. |
EmailLocal | String | True |
The EmailLocal column of the Contacts table. |
FirstName | String | False |
The FirstName column of the Contacts table. |
Gravatar | String | True |
The Gravatar column of the Contacts table. |
Hash | String | True |
The Hash column of the Contacts table. |
Ip | String | True |
The Ip column of the Contacts table. |
LastName | String | False |
The LastName column of the Contacts table. |
AccountContactsLink | String | True |
The AccountContactsLink column of the Contacts table. |
AutomationEntryCountsLink | String | True |
The AutomationEntryCountsLink column of the Contacts table. |
BounceLogsLink | String | True |
The BounceLogsLink column of the Contacts table. |
ContactAutomationsLink | String | True |
The ContactAutomationsLink column of the Contacts table. |
ContactDataLink | String | True |
The ContactDataLink column of the Contacts table. |
ContactDealsLink | String | True |
The ContactDealsLink column of the Contacts table. |
ContactGoalsLink | String | True |
The ContactGoalsLink column of the Contacts table. |
ContactListsLink | String | True |
The ContactListsLink column of the Contacts table. |
ContactLogsLink | String | True |
The ContactLogsLink column of the Contacts table. |
ContactTagsLink | String | True |
The ContactTagsLink column of the Contacts table. |
DealsLink | String | True |
The DealsLink column of the Contacts table. |
FieldValuesLink | String | True |
The FieldValuesLink column of the Contacts table. |
GeoIpsLink | String | True |
The GeoIpsLink column of the Contacts table. |
NotesLink | String | True |
The NotesLink column of the Contacts table. |
OrganizationLink | String | True |
The OrganizationLink column of the Contacts table. |
PlusAppendLink | String | True |
The PlusAppendLink column of the Contacts table. |
ScoreValuesLink | String | True |
The ScoreValuesLink column of the Contacts table. |
TrackingLogsLink | String | True |
The TrackingLogsLink column of the Contacts table. |
Organization | String | True |
The Organization column of the Contacts table. |
Orgname | String | True |
The Orgname column of the Contacts table. |
Phone | String | False |
The Phone column of the Contacts table. |
RatingTStamp | String | True |
The RatingTStamp column of the Contacts table. |
SegmentioId | String | True |
The SegmentioId column of the Contacts table. |
Sentcnt | String | True |
The Sentcnt column of the Contacts table. |
SocialdataLastcheck | String | True |
The SocialdataLastcheck column of the Contacts table. |
Ua | String | True |
The Ua column of the Contacts table. |
Udate | Datetime | True |
The Udate column of the Contacts table. |
UpdatedTimestamp | String | True |
The UpdatedTimestamp column of the Contacts table. |
Updated_by | String | True |
The Updated_by column of the Contacts table. |
SubscribeTo | String | False |
Comma-separated list of list Ids to subscribe a contact to. |
UnsubscribeFrom | String | False |
Comma-separated list of list Ids to unsubscribe a contact from. |
Create, modify, delete and query the available deal custom field data in ActiveCampaign.
The Cloud uses the ActiveCampaign API to process some of the filters.
For example, the following queries are processed server side:
SELECT * FROM DealCustomFieldData WHERE Id = 10003 SELECT * FROM DealCustomFieldData WHERE DealId = 1
Inserting a deal custom field data requires specifying a value for the DealId, CustomFieldId, and FieldValue columns.
Additionally, the Cloud supports inserting deal custom fields data from the Deals table. See Deals for more information.
INSERT INTO DealCustomFieldData (FieldValue, CustomFieldId, DealId) VALUES ('custom field value', 1, 5)
The Cloud supports updating deal custom field data information. Updating deal custom field data requires specifying a value for the Id, DealId and CustomFieldId columns.
Additionally, it is possible to update deal custom fields data from the Deals table.
UPDATE DealCustomFieldData SET FieldValue = 'custom field value' WHERE Id = 8 AND DealId = 3 AND CustomFieldId = 2
The Cloud supports removing deal custom field data.
DELETE FROM DealCustomFieldData WHERE Id = 10
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The Id column of the DealCustomFieldData table. |
CreatedTimestamp | Datetime | False |
The CreatedTimestamp column of the DealCustomFieldData table. |
CustomFieldName | String | True |
The name of the custom field metum the field value relates to. |
CustomFieldId | Integer | False |
The CustomFieldId column of the DealCustomFieldData table. |
DealCustomFieldMetumId | Integer | False |
The DealCustomFieldMetumId column of the DealCustomFieldData table. |
DealId | Integer | False |
The DealId column of the DealCustomFieldData table. |
FieldValue | String | False |
The FieldValue column of the DealCustomFieldData table. |
DealLink | String | False |
The DealLink column of the DealCustomFieldData table. |
DealCustomFieldMetumLink | String | False |
The DealCustomFieldMetumLink column of the DealCustomFieldData table. |
UpdatedTimestamp | Datetime | False |
The UpdatedTimestamp column of the DealCustomFieldData. |
FieldCurrency | String | False |
Value of the custom field currency type for a specific deal. This field is required when inserting currency custom fields. |
FieldType | String | False |
Value of the custom field currency type for a specific deal. This field is required when inserting currency custom fields. |
Lists all existing accounts.
The Cloud uses the ActiveCampaign API to process some of the filters.
For example, the following queries are processed server side:
SELECT * FROM DealGroups WHERE Id = 10003 SELECT * FROM DealGroups WHERE Title = 'title'
Inserting a pipeline/dealgroup requires specifying a value for the Currency, Title columns.
INSERT INTO DealGroups (Currency, Title) VALUES (2, 300) INSERT INTO DealGroups (Currency, Title, AutoAssign, AllUsers, AllGroups) VALUES ('USD', 'title', 1, 0, 1)
The Cloud supports updating pipeline/dealgroup information.
UPDATE DealGroups SET AllUsers = 0, AllGroups = 1, Currency = 'EUR' WHERE Id = 1
Remove all pipelines or a pipeline by specifying the Id of the dealgroup.
DELETE FROM DealGroups WHERE Id = 10003
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The pipeline Id. |
AllGroups | String | False |
The AllGroups column of the DealGroups table. Indicates whether all user groups have permission to manage this pipeline. Can be either 1 or 0. If 1, all user groups can manage this pipeline. If 0, only user groups in dealGroup.groups parameter can manage this pipeline. |
AllUsers | String | False |
The AllUsers column of the DealGroups table. Indicates whether new deals get auto-assigned to all users. Can be either 1 or 0. If 1, new deals are auto-assigned to all users unless auto-assign is disabled. If 0, new deals are auto-assigned to only the users in dealGroup.users parameter. |
AutoAssign | String | False |
The AutoAssign column of the DealGroups table. Deal auto-assign option. Can be one of 0, 1, and 2. If 0, auto-assign is disabled. If 1, Round Robin method is used to auto-assign new deals. If 2, deals are distributed based on deal values. |
Cdate | Datetime | True |
The Cdate column of the DealGroups table. |
Currency | String | False |
The Currency column of the DealGroups table. |
DealGroupGroupsLink | String | True |
The DealGroupGroupsLink column of the DealGroups table. |
DealGroupUsersLink | String | True |
The DealGroupUsersLink column of the DealGroups table. |
StagesLink | String | True |
The StagesLink column of the DealGroups table. |
Stages | String | True |
The Stages column of the DealGroups table. |
Title | String | False |
Pipeline's title. |
Udate | Datetime | True |
The Udate column of the DealGroups table. |
Usage information for the operation Deals.rsd.
The Cloud uses the ActiveCampaign API to process some of the filters.
For example, the following queries are processed server side:
SELECT * FROM Deals WHERE Id = 10 SELECT * FROM Deals WHERE GroupId = 1 SELECT * FROM Deals WHERE OwnerId = 1 SELECT * FROM Deals WHERE Stage = 1 AND Title = 'title'
As a note, due to server-side performance issues, even when the property IncludeCustomFields is set to TRUE, the custom fields will appear only in the table schema with null values. To retrieve the values of the custom fields, please refer to the DealCustomFieldData table.
Inserting a deal requires specifying a value for the GroupId, Stage, OwnerId, Title, Value, Currency columns and a value for AccountId or ContactId column.
INSERT INTO Deals (AccountId, GroupId, Stage, OwnerId, Title, Value, Currency) VALUES (1, 1, 1, 1, 'title', 100, 'USD') INSERT INTO Deals (Email, FirstName, LastName, Phone) VALUES ('test@test.com', 'test', 'test', 'dealphonenumber')
Additionally, the Cloud supports inserting deal and deal custom fields data from the Deals table. All custom field columns start with CF_.
INSERT INTO Deals (AccountId, GroupId, Stage, OwnerId, Title, Value, Currency, CF_CustomField1, CF_CustomField2, CF_CustomField3) VALUES (1, 1, 1, 1, 'title', 100, 'USD', 'value', 'value', 'value')
The Cloud supports updating deal information.
Additionally, it is possible to update deal custom fields data from the Deals table.
UPDATE Deals SET Title = 'updatedTitle' WHERE Id = 1 UPDATE Deals SET CF_CustomField1 = 'custom field value', CF_CustomField2 = 'custom field value' WHERE Id = 1
Remove all deals or a deal by specifying the Id of the deal.
DELETE FROM Deals DELETE FROM Deals WHERE Id = 10003
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The Id column of the Deals table. |
AccountId | String | False |
The AccountId column of the Deals table. |
ActivityCount | String | True |
The ActivityCount column of the Deals table. |
Cdate | Datetime | True |
The Cdate column of the Deals table. |
ContactId | String | False |
Deal's primary contact's Id. |
Currency | String | False |
Deal's currency in 3-digit ISO format, lowercased. |
CustomerAccount | String | True |
The CustomerAccount column of the Deals table. |
Description | String | False |
The Description column of the Deals table. |
Edate | String | True |
The Edate column of the Deals table. |
Group | String | False |
Deal's pipeline Id. Required if deal.stage is not provided. If deal.group is not provided, the stage's pipeline will be assigned to the deal automatically. |
Hash | String | True |
The Hash column of the Deals table. |
IsDisabled | String | True |
The IsDisabled column of the Deals table. |
AccountLink | String | True |
The AccountLink column of the Deals table. |
ContactLink | String | True |
The ContactLink column of the Deals table. |
ContactDealsLink | String | True |
The ContactDealsLink column of the Deals table. |
CustomerAccountLink | String | True |
The CustomerAccountLink column of the Deals table. |
DealActivitiesLink | String | True |
The DealActivitiesLink column of the Deals table. |
DealCustomFieldDataLink | String | True |
The DealCustomFieldDataLink column of the Deals table. |
GroupLink | String | True |
The GroupLink column of the Deals table. |
NextTaskLink | String | True |
The NextTaskLink column of the Deals table. |
NotesLink | String | True |
The NotesLink column of the Deals table. |
OrganizationLink | String | True |
The OrganizationLink column of the Deals table. |
OwnerLink | String | True |
The OwnerLink column of the Deals table. |
ScoreValuesLink | String | True |
The ScoreValuesLink column of the Deals table. |
StageLink | String | True |
The StageLink column of the Deals table. |
TasksLink | String | True |
The TasksLink column of the Deals table. |
Mdate | Datetime | True |
The Mdate column of the Deals table. |
NextTask | String | True |
The NextTask column of the Deals table. |
NextDate | Datetime | True |
The NextDate column of the Deals table. |
NextDealId | String | True |
The NextDealId column of the Deals table. |
NextTaskId | String | True |
The NextTaskId column of the Deals table. |
Organization | String | True |
The Organization column of the Deals table. |
Owner | String | False |
Deal's owner Id. Required if pipeline's auto-assign option is disabled. |
Percent | String | False |
The Percent column of the Deals table. |
Stage | String | False |
Deal's stage Id. Required if deal.group is not provided. If deal.stage is not provided, the deal will be assigned with the first stage in the pipeline provided in deal.group. |
Status | String | False |
The Status column of the Deals table. |
Title | String | False |
The Title column of the Deals table. |
Value | String | False |
Deal's value in cents. |
WinProbability | Integer | True |
The WinProbability column of the Deals table. |
WinProbabilityMdate | Datetime | True |
The WinProbabilityMdate column of the Deals table. |
Usage information for the operation DealStages.rsd.
The Cloud uses the ActiveCampaign API to process some of the filters.
For example, the following queries are processed server side:
SELECT * FROM DealStages WHERE Id = 10003 SELECT * FROM DealStages WHERE Title = 'title' AND GroupId = 1
Inserting a stage requires specifying a value for the GroupId, Title columns.
INSERT INTO DealStages (GroupId, Title) VALUES (2, 'title') INSERT INTO DealStages (Title, GroupId, OrderId, CardRegion3, Color, Width) VALUES ('TestStage', 1, 2, 'hide-avatar', '434343', '280')
The Cloud supports updating stage/dealstage information.
UPDATE DealStages SET Title = 'updatedTitle' WHERE Id = 1
Remove all stages or a stage by specifying the Id of the stage.
DELETE FROM DealStages WHERE Id = 10003
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The Id column of the DealStages table. |
CardRegion1 | String | False |
The CardRegion1 column of the DealStages table. Indicates what to show in upper-left corner of Deal Cards. |
CardRegion2 | String | False |
The CardRegion2 column of the DealStages table. Indicates what to show in upper-right corner of Deal Cards. |
CardRegion3 | String | False |
The CardRegion3 column of the DealStages table. Indicates whether to show the avatar in Deal Cards. Can be one of show-avatar and hide-avatar. If set to show-avatar, deal cards will show the avatars. If set to hide-avatar, deal cards will hide the avatars. |
CardRegion4 | String | False |
The CardRegion4 column of the DealStages table. Indicates what to show next to the avatar in Deal Cards. |
CardRegion5 | String | False |
The CardRegion5 column of the DealStages table. Indicates what to show in lower-right corner of Deal Cards. |
Cdate | Datetime | True |
The Cdate column of the DealStages table. |
Color | String | False |
Deal Stage's color. 6-character HEX color code without the hashtag. e.g. 434343 to assign the hex color value #434343. |
DealOrder | String | False |
Option and direction to be used to sort deals in the deal stage. The option and direction should be delimited by a space. Direction can be either. |
GroupId | String | False |
The GroupId column of the DealStages table. |
GroupLink | String | True |
The GroupLink column of the DealStages table. |
OrderId | String | False |
The OrderId column of the DealStages table. |
Title | String | False |
The Title column of the DealStages table. |
Udate | Datetime | True |
The Udate column of the DealStages table. |
Width | String | False |
Deal stage's width in pixels, without px unit. |
Lists all existing accounts.
The Cloud uses the ActiveCampaign API to process some of the filters.
For example, the following queries are processed server side:
SELECT * FROM Tasks WHERE Id = 10003 SELECT * FROM Tasks WHERE DealTaskType = 1 SELECT * FROM Tasks WHERE DueDate >= '2019-06-30T10:44:34-05:00' SELECT * FROM Tasks WHERE DueDate <= '2021-06-30T10:44:34-05:00' SELECT * FROM Tasks WHERE OutcomeId = 1 AND RelId = 1 AND Status = 1
Inserting a stage requires specifying a value for the DealTaskType, DueDate, Relid columns.
INSERT INTO Tasks (DealTaskType, DueDate, Relid) VALUES (2, '2021-06-30T10:44:34-05:00', 7)
The Cloud supports updating stage/dealstage information.
UPDATE Tasks SET Title = 'updatedTitle' WHERE Id = 1
Remove all stages or a stage by specifying the Id of the stage.
DELETE FROM Tasks WHERE Id = 10003
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The Id column of the Tasks table. |
Assignee | String | False |
The Assignee column of the Tasks table. |
Automation | String | True |
The Automation column of the Tasks table. |
Cdate | Datetime | True |
The Cdate column of the Tasks table. |
DealTaskType | String | False |
The type of the task based on the available Task Types in the account. |
DoneAutomation | String | False |
The DoneAutomation column of the Tasks table. |
DueDate | Datetime | False |
Due date of the task. |
Edate | Datetime | True |
The Edate column of the Tasks table. |
ActivitiesLink | String | True |
The ActivitiesLink column of the Tasks table. |
AssigneeLink | String | True |
The AssigneeLink column of the Tasks table. |
AutomationLink | String | True |
The AutomationLink column of the Tasks table. |
DealTasktypeLink | String | True |
The DealTasktypeLink column of the Tasks table. |
DoneAutomationLink | String | True |
The DoneAutomationLink column of the Tasks table. |
NotesLink | String | True |
The NotesLink column of the Tasks table. |
OwnerLink | String | True |
The OwnerLink column of the Tasks table. |
TaskNotificationsLink | String | True |
The TaskNotificationsLink column of the Tasks table. |
UserLink | String | True |
The UserLink column of the Tasks table. |
Note | String | False |
The content describing the task. |
OutcomeId | Integer | False |
The OutcomeId column of the Tasks table. |
OutcomeInfo | String | False |
The OutcomeInfo column of the Tasks table. |
OwnerId | String | True |
The OwnerId column of the Tasks table. |
OwnerType | String | False |
The name of the relating object. Valid values are contact or deal. |
Relid | String | False |
The Id of the relational object for this task. |
Reltype | String | True |
The Reltype column of the Tasks table. |
Status | Integer | False |
The Status column of the Tasks table. 1 is complete and 0 is incomplete.. |
Title | String | False |
The Title column of the Tasks table. |
Udate | Datetime | True |
The Udate column of the Tasks table. |
User | String | True |
The User column of the Tasks table. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
Addresses | Usage information for the operation Addresses.rsd. |
Automations | Usage information for the operation Automations.rsd. |
Campaigns | Query the campaigns information in ActiveCampaign. |
ContactAutomations | View many or all contacts by including their ID's or various filters. |
ContactLists | Retrieve ContactList for each contact Group or for the specific Contact group. |
ContactTags | Retrieve tags added for each contact or for the specific Contact Id |
DealActivities | Retrieve Deal Activities for each Deal or for the specific Deal Id. |
Lists | Usage information for the operation Lists.rsd. |
Scores | View many or all contacts by including their ID's or various filters. |
Tags | View many or all tags by including their ID's or various filters. |
TrackingLogs | Retrieve trackingLogs for the specific contact or all contacts |
Users | Usage information for the operation Users.rsd. |
Usage information for the operation Addresses.rsd.
The Cloud uses the ActiveCampaign API to process some of the filters.
For example, the following query is processed server side:
SELECT * FROM AccountContacts WHERE Id = 10003
Name | Type | Description |
Id | String | The Id column of the Addresses table. |
Address1 | String | The Address1 column of the Addresses table. |
Address2 | String | The Address2 column of the Addresses table. |
Allgroup | String | The Allgroup column of the Addresses table. |
City | String | The City column of the Addresses table. |
CompanyName | String | The CompanyName column of the Addresses table. |
Country | String | The Country column of the Addresses table. |
District | String | The District column of the Addresses table. |
isDefault | String | The isDefault column of the Addresses table. |
AddressGroupLink | String | The AddressGroupLink column of the Addresses table. |
AddressListLink | String | The AddressListLink column of the Addresses table. |
FormsLink | String | The FormsLink column of the Addresses table. |
State | String | The State column of the Addresses table. |
Zip | String | The Zip column of the Addresses table. |
Usage information for the operation Automations.rsd.
Name | Type | Description |
Id | String | The Id column of the Automations table. |
Cdate | Datetime | The Cdate column of the Automations table. |
DefaultScreenshot | String | The DefaultScreenshot column of the Automations table. |
Entered | String | The Entered column of the Automations table. |
Exited | String | The Exited column of the Automations table. |
Hidden | String | The Hidden column of the Automations table. |
BlocksLink | String | The BlocksLink column of the Automations table. |
CampaignsLink | String | The CampaignsLink column of the Automations table. |
ContactAutomationsLink | String | The ContactAutomationsLink column of the Automations table. |
ContactGoalsLink | String | The ContactGoalsLink column of the Automations table. |
GoalsLink | String | The GoalsLink column of the Automations table. |
SiteMessagesLink | String | The SiteMessagesLink column of the Automations table. |
SmsLink | String | The SmsLink column of the Automations table. |
Mdate | Datetime | The Mdate column of the Automations table. |
Name | String | The Name column of the Automations table. |
Screenshot | String | The Screenshot column of the Automations table. |
Status | String | The Status column of the Automations table. |
UserId | String | The UserId column of the Automations table. |
Query the campaigns information in ActiveCampaign.
The Cloud uses the ActiveCampaign API to process some of the filters.
For example, the following query is processed server side:
SELECT * FROM Campaigns WHERE Id = 10003
Name | Type | Description |
Id [KEY] | String | The Id column of the Campaigns table. |
ActiveRssInterval | String | The ActiveRssInterval column of the Campaigns table. |
ActiveRssItems | String | The ActiveRssItems column of the Campaigns table. |
ActiveRssUrl | String | The ActiveRssUrl column of the Campaigns table. |
AddressId | String | The AddressId column of the Campaigns table. |
AnalyticsCampaignName | String | The AnalyticsCampaignName column of the Campaigns table. |
Automation | String | The Automation column of the Campaigns table. |
BaseMessageId | String | The BaseMessageId column of the Campaigns table. |
BaseTemplateId | String | The BaseTemplateId column of the Campaigns table. |
BounceId | String | The BounceId column of the Campaigns table. |
CanSkipApproval | String | The can_skip_approval column of the Campaigns table. |
Cdate | Datetime | The Cdate column of the Campaigns table. |
CreatedBy | String | The Created By column of the Campaigns table. |
CreatedTimestamp | Datetime | The Created Timestamp column of the Campaigns table. |
DeleteStamp | String | The DeleteStamp column of the Campaigns table. |
EmbedImages | String | The EmbedImages column of the Campaigns table. |
String | The Facebook column of the Campaigns table. | |
FormId | String | The FormId column of the Campaigns table. |
Forwards | String | The Forwards column of the Campaigns table. |
HardBounces | String | The HardBounces column of the Campaigns table. |
HasPredictiveContent | Bit | The HasPredictiveContent column of the Campaigns table. |
HtmlUnsub | String | The HtmlUnsub column of the Campaigns table. |
HtmlUnsubdata | String | The HtmlUnsubdata column of the Campaigns table. |
Ip | String | The Ip column of the Campaigns table. |
Ip4 | String | The Ip4 column of the Campaigns table. |
LastStep | String | The LastStep column of the Campaigns table. |
Ldate | String | The Ldate column of the Campaigns table. |
LinkClicks | String | The LinkClicks column of the Campaigns table. |
AutomationLink | String | The AutomationLink column of the Campaigns table. |
CampaignAggregateRevenuesLink | String | The AggregateRevenues column of the Campaigns table. |
CampaignListsLink | String | The CampaignListsLink column of the Campaigns table. |
CampaignMessageLink | String | The CampaignMessageLink column of the Campaigns table. |
CampaignMessagesLink | String | The CampaignMessagesLink column of the Campaigns table. |
LinksLink | String | The LinksLink column of the Campaigns table. |
LinksSegment | String | The Segment column of the Campaigns table. |
UserLink | String | The UserLink column of the Campaigns table. |
MailCleanup | String | The MailCleanup column of the Campaigns table. |
MailSend | String | The MailSend column of the Campaigns table. |
MailTransfer | String | The MailTransfer column of the Campaigns table. |
MailerLogFile | String | The MailerLogFile column of the Campaigns table. |
ManageText | String | The ManageText column of the Campaigns table. |
Mdate | Datetime | The Mdate column of the Campaigns table. |
Name | String | The Name column of the Campaigns table. |
Opens | String | The Opens column of the Campaigns table. |
Public | String | The Public column of the Campaigns table. |
RealCid | String | The RealCid column of the Campaigns table. |
Recurring | String | The Recurring column of the Campaigns table. |
ReminderField | String | The ReminderField column of the Campaigns table. |
ReminderFormat | String | The ReminderFormat column of the Campaigns table. |
ReminderLastCronRun | String | The ReminderLastCronRun column of the Campaigns table. |
ReminderOffset | String | The ReminderOffset column of the Campaigns table. |
ReminderOffsetSign | String | The ReminderOffsetSign column of the Campaigns table. |
ReminderOffsetType | String | The ReminderOffsetType column of the Campaigns table. |
ReminderType | String | The ReminderType column of the Campaigns table. |
Replies | String | The Replies column of the Campaigns table. |
ReplySys | String | The ReplySys column of the Campaigns table. |
ResponderExisting | String | The ResponderExisting column of the Campaigns table. |
ResponderOffset | String | The ResponderOffset column of the Campaigns table. |
ResponderType | String | The ResponderType column of the Campaigns table. |
Schedule | String | The Schedule column of the Campaigns table. |
ScheduledDate | String | The ScheduledDate column of the Campaigns table. |
Screenshot | String | The Screenshot column of the Campaigns table. |
Sdate | String | The Sdate column of the Campaigns table. |
SegmentId | String | The SegmentId column of the Campaigns table. |
SegmentName | String | The SegmentName column of the Campaigns table. |
SendAmt | String | The SendAmt column of the Campaigns table. |
SendId | String | The SendId column of the Campaigns table. |
SeriesId | String | The SeriesId column of the Campaigns table. |
Series Send Lock Time | String | The SeriesSendLockTime column of the Campaigns table. |
SocialShares | String | The SocialShares column of the Campaigns table. |
SoftBounces | String | The SoftBounces column of the Campaigns table. |
Source | String | The Source column of the Campaigns table. |
SplitContent | String | The SplitContent column of the Campaigns table. |
SplitOffset | String | The SplitOffset column of the Campaigns table. |
SplitOffsetType | String | The SplitOffsetType column of the Campaigns table. |
SplitType | String | The SplitType column of the Campaigns table. |
SplitWinnerAwaiting | String | The SplitWinnerAwaiting column of the Campaigns table. |
SplitWinnerMessageId | String | The SplitWinnerMessageId column of the Campaigns table. |
Status | String | The Status column of the Campaigns table. |
SubscriberClicks | String | The SubscriberClicks column of the Campaigns table. |
Survey | String | The Survey column of the Campaigns table. |
TextUnsub | String | The TextUnsub column of the Campaigns table. |
TextUnsubData | String | The TextUnsubData column of the Campaigns table. |
ThreadId | String | The ThreadId column of the Campaigns table. |
TotalAmt | String | The TotalAmt column of the Campaigns table. |
TrackLinks | String | The TrackLinks column of the Campaigns table. |
TrackLinksAnalytics | String | The TrackLinksAnalytics column of the Campaigns table. |
TrackReads | String | The TrackReads column of the Campaigns table. |
TrackReadsAnalytics | String | The TrackReadsAnalytics column of the Campaigns table. |
Tweet | String | The Tweet column of the Campaigns table. |
Type | String | The Type column of the Campaigns table. |
UniqueForwards | String | The UniqueForwards column of the Campaigns table. |
UniqueLinkClicks | String | The UniqueLinkClicks column of the Campaigns table. |
UniqueOpens | String | The UniqueOpens column of the Campaigns table. |
UniqueReplies | String | The UniqueReplies column of the Campaigns table. |
UnsubReasons | String | The UnsubReasons column of the Campaigns table. |
Unsubscribes | String | The Unsubscribes column of the Campaigns table. |
Updated By | String | The UpdatedBy column of the Campaigns table. |
Updated Timestamp | String | The UpdatedTimestamp column of the Campaigns table. |
Updates | String | The Updates column of the Campaigns table. |
User | String | The User column of the Campaigns table. |
UserId | String | The UserId column of the Campaigns table. |
WaitPreview | String | The WaitPreview column of the Campaigns table. |
WillRecur | String | The WillRecur column of the Campaigns table. |
View many or all contacts by including their ID's or various filters.
The Cloud uses the ActiveCampaign API to process some of the filters.
For example, the following query is processed server side:
SELECT * FROM ContactAutomations WHERE Id = 10003
Name | Type | Description |
Id | String | The Id column of the ContactAutomations table. |
Adddate | Datetime | The Adddate column of the ContactAutomations table. |
Automation | String | The Automation column of the ContactAutomations table. |
Batchid | Unknown | The Batchid column of the ContactAutomations table. |
CompleteValue | Integer | The CompleteValue column of the ContactAutomations table. |
Completed | Integer | The Completed column of the ContactAutomations table. |
CompletedElements | String | The CompletedElements column of the ContactAutomations table. |
ContactId | String | The ContactId column of the ContactAutomations table. |
Lastblock | String | The Lastblock column of the ContactAutomations table. |
Lastdate | Datetime | The Lastdate column of the ContactAutomations table. |
LastLogId | String | The LastLogId column of the ContactAutomations table. |
AutomationLink | String | The AutomationLink column of the ContactAutomations table. |
ContactLink | String | The ContactLink column of the ContactAutomations table. |
ContactGoalsLink | String | The ContactGoalsLink column of the ContactAutomations table. |
Remdate | Datetime | The Remdate column of the ContactAutomations table. |
SeriesId | String | The SeriesId column of the ContactAutomations table. |
StartId | String | The StartId column of the ContactAutomations table. |
Status | String | The Status column of the ContactAutomations table. |
TimeSpan | String | The TimeSpan column of the ContactAutomations table. |
TotalElements | String | The TotalElements column of the ContactAutomations table. |
Retrieve ContactList for each contact Group or for the specific Contact group.
Retrieving information from ContactLists requires specifying a ContactId.
SELECT * FROM ContactLists WHERE ContactId = 1000
Name | Type | Description |
Id [KEY] | String | The Id column of the ContactLists table. |
ContactId | String | The ContactId column of the ContactLists table. |
AutomationId | String | The AutomationId column of the ContactLists table. |
AutosyncLog | String | The AutosyncLog column of the ContactLists table. |
Campaign | String | The Campaign column of the ContactLists table. |
CreatedBy | String | The CreatedBy column of the ContactLists table. |
CreatedTimestamp | Datetime | The CreatedTimestamp column of the ContactLists table. |
FirstName | String | The FirstName column of the ContactLists table. |
Form | String | The Form column of the ContactLists table. |
Ip4Sub | String | The Ip4Sub column of the ContactLists table. |
Ip4Unsub | String | The Ip4Unsub column of the ContactLists table. |
Ip4Last | String | The Ip4Last column of the ContactLists table. |
LastName | String | The LastName column of the ContactLists table. |
AutomationLink | String | The AutomationLink column of the ContactLists table. |
AutosyncLogLink | String | The AutosyncLogLink column of the ContactLists table. |
CampaignLink | String | The CampaignLink column of the ContactLists table. |
ContactLink | String | The ContactLink column of the ContactLists table. |
FormLink | String | The FormLink column of the ContactLists table. |
ListLink | String | The ListLink column of the ContactLists table. |
MessageLink | String | The MessageLink column of the ContactLists table. |
UnsubscribeAutomationLink | String | The UnsubscribeAutomationLink column of the ContactLists table. |
ListId | String | The ListId column of the ContactLists table. |
Message | String | The Message column of the ContactLists table. |
Responder | String | The Responder column of the ContactLists table. |
Sdate | Datetime | The Sdate column of the ContactLists table. |
SeriesId | String | The SeriesId column of the ContactLists table. |
Status | String | The Status column of the ContactLists table. |
SourceId | String | The SourceId column of the ContactLists table. |
Sync | String | The Sync column of the ContactLists table. |
Unsubreason | String | The Unsubreason column of the ContactLists table. |
UnsubscribeAutomation | String | The UnsubscribeAutomation column of the ContactLists table. |
UpdatedBy | String | The UpdatedBy column of the ContactLists table. |
UpdatedTimestamp | Datetime | The UpdatedTimestamp column of the ContactLists table. |
Retrieve tags added for each contact or for the specific Contact Id
Retrieving information for ContactTags requires specifying a ContactId.
SELECT * FROM ContactTags WHERE ContactId = 1
Name | Type | Description |
Id [KEY] | String | The Id column of the ContactTags table. |
ContactId | String | The ContactId column of the ContactTags table. |
Cdate | Datetime | The Cdate column of the ContactTags table. |
CreatedBy | String | The CreatedBy column of the ContactTags table. |
CreatedTimestamp | Datetime | The CreatedTimestamp column of the ContactTags table. |
ContactLink | String | The ContactLink column of the ContactTags table. |
TagLink | String | The TagLink column of the ContactTags table. |
Tag | String | The Tag column of the ContactTags table. |
UpdatedBy | String | The UpdatedBy column of the ContactTags table. |
UpdatedTimestamp | Datetime | The UpdatedTimestamp column of the ContactTags table. |
Retrieve Deal Activities for each Deal or for the specific Deal Id.
Name | Type | Description |
Id [KEY] | String | The Id of the activity. |
DealId | String | The Id of the Deal to which the activity belongs to. |
StageId | String | The Id of the Stage to which the parent Deal of the activity belongs to. |
UserId | String | The Id of the User which triggered the activity. |
DataId | String | The Id for the related object (e.g. a Task or Note or similar), if relevant. |
DataType | String | The type of the activity. Examples include 'userid' or 'subscriberid' or 'task' or 'note' or empty quotes ('') for the deal's initial creation. |
DataAction | String | The action taken by this activity. Examples include 'add' or 'complete' or the new value ('100') if the value is changing. |
DataOldVal | String | The previous value, if the value has changed (see DataAction); otherwise, empty quotes ('') |
CreatedDate | Datetime | The creation date of the activity. |
SortDate | Datetime | |
IsAddTask | Boolean | Indicates whether the activity was adding a task to the deal. |
Deleted | Boolean | Indicates whethere the activity was deleted or not. |
SeriesId | String | |
DealLink | String | The API endpoint to the Deal related to this activity. |
StageLink | String | The API endpoint to the Stage related to this activity. |
UserLink | String | The API endpoint to the User related to this activity. |
AutomationLink | String | The API endpoint to the Automation related to this activity. |
ActivityLink | String | The API endpoint to the Activity. |
Deal | String | The related to this Activity. |
Stage | String | The Stage column of the DealActivities table. |
User | String | The User column of the DealActivities table. |
Automation | String | The Automation which triggered this activity. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Exclude | String | Include this param to exclude 'email', 'connection_email', and 'LinkData' activity types.
使用できる値は次のとおりです。email |
Usage information for the operation Lists.rsd.
The Cloud uses the ActiveCampaign API to process some of the filters.
For example, the following queries are processed server side:
SELECT * FROM Lists WHERE Id = 1 SELECT * FROM Lists WHERE Name = 'list1'
In addition the Cloud supports retrieving information about members of lists in your account by supporting them dynamically as VIEWS. Selecting from a dynamic list will return information about all the contacts that are members of that list. Lists names always start with "List_".
Name | Type | Description |
Id [KEY] | String | The Id column of the Lists table. |
AnalyticsDomains | String | The AnalyticsDomains column of the Lists table. |
AnalyticsSource | String | The AnalyticsSource column of the Lists table. |
AnalyticsUa | String | The AnalyticsUa column of the Lists table. |
CarbonCopy | String | The CarbonCopy column of the Lists table. |
Cdate | Datetime | The Cdate column of the Lists table. |
Udate | Datetime | The Udate column of the Lists table. |
DeleteStamp | String | The DeleteStamp column of the Lists table. |
FacebookSession | String | The FacebookSession column of the Lists table. |
FullAddress | String | The FullAddress column of the Lists table. |
UnsubscribeReason | String | The UnsubscribeReason column of the Lists table. |
AddressListsLink | String | The AddressListsLink column of the Lists table. |
ContactGoalListsLink | String | The ContactGoalListsLink column of the Lists table. |
UserLink | String | The UserLink column of the Lists table. |
Name | String | The Name column of the Lists table. |
OptinMessageId | String | The OptinMessageId column of the Lists table. |
OptinOptout | String | The OptinOptout column of the Lists table. |
OptoutConf | String | The OptoutConf column of the Lists table. |
EmbedImage | String | The EmbedImage column of the Lists table. |
UseAnalyticsLink | String | The UseAnalyticsLink column of the Lists table. |
UseAnalyticsRead | String | The UseAnalyticsRead column of the Lists table. |
UseCaptcha | String | The UseCaptcha column of the Lists table. |
UseFacebook | String | The UseFacebook column of the Lists table. |
UseTracking | String | The UseTracking column of the Lists table. |
UseTwitter | String | The UseTwitter column of the Lists table. |
Private | String | The Private column of the Lists table. |
RequireName | String | The RequireName column of the Lists table. |
SendLastBroadcast | String | The SendLastBroadcast column of the Lists table. |
SenderAddr1 | String | The SenderAddr1 column of the Lists table. |
SenderAddr2 | String | The SenderAddr2 column of the Lists table. |
SenderCity | String | The SenderCity column of the Lists table. |
SenderCountry | String | The SenderCountry column of the Lists table. |
SenderName | String | The SenderName column of the Lists table. |
SenderPhone | String | The SenderPhone column of the Lists table. |
SenderReminder | String | The SenderReminder column of the Lists table. |
SenderState | String | The SenderState column of the Lists table. |
SenderUrl | String | The SenderUrl column of the Lists table. |
SenderZip | String | The SenderZip column of the Lists table. |
StringId | String | The StringId column of the Lists table. |
SubscriptionNotify | String | The SubscriptionNotify column of the Lists table. |
ToName | String | The ToName column of the Lists table. |
TwitterToken | String | The TwitterToken column of the Lists table. |
TwitterTokenSecret | String | The TwitterTokenSecret column of the Lists table. |
UnsubscriptionNotify | String | The UnsubscriptionNotify column of the Lists table. |
ListsUser | String | The ListsUser column of the Lists table. |
ListsUserid | String | The ListsUserid column of the Lists table. |
View many or all contacts by including their ID's or various filters.
The Cloud uses the ActiveCampaign API to process some of the filters.
For example, the following query is processed server side:
SELECT * FROM Scores WHERE Id = 10
Name | Type | Description |
Id | String | The Id column of the Scores table. |
Cdate | Datetime | The Cdate column of the Scores table. |
Descript | String | The Descript column of the Scores table. |
Mdate | Datetime | The Mdate column of the Scores table. |
Name | String | The Name column of the Scores table. |
RelType | String | The RelType column of the Scores table. |
Status | String | The Status column of the Scores table. |
View many or all tags by including their ID's or various filters.
The Cloud uses the ActiveCampaign API to process some of the filters.
For example, the following query is processed server side:
SELECT * FROM Tags WHERE Id = 10003
Name | Type | Description |
Id [KEY] | String | The Id column of the Tags table. |
Tag | String | The Tag column of the Tags table. |
TagType | String | The TagType column of the Tags table. |
Description | String | The Description column of the Tags table. |
Cdate | Datetime | The Cdate column of the Tags table. |
ContactGoalTagsLink | String | The ContactGoalTagsLink column of the Tags table. |
Retrieve trackingLogs for the specific contact or all contacts
Name | Type | Description |
Id [KEY] | String | The Id column of the TrackingLogs table. |
ContactId | String | The ContactId column of the TrackingLogs table. |
Hash | String | The Hash column of the TrackingLogs table. |
ContactLink | String | The ContactLink column of the TrackingLogs table. |
SubscriberidLink | String | The SubscriberidLink column of the TrackingLogs table. |
TstampLink | Datetime | The TstampLink column of the TrackingLogs table. |
TypeLink | String | The TypeLink column of the TrackingLogs table. |
ValueLink | String | The ValueLink column of the TrackingLogs table. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
UDateLink | Datetime |
Usage information for the operation Users.rsd.
The Cloud uses the ActiveCampaign API to process some of the filters.
For example, the following query is processed server side:
SELECT * FROM Users WHERE Id = 10003
Name | Type | Description |
Id | String | The Id column of the Users table. |
String | The Email column of the Users table. | |
FirstName | String | The FirstName column of the Users table. |
LastName | String | The LastName column of the Users table. |
ConfigsLink | String | The ConfigsLinks column of the Users table. |
DealGroupTotalsLink | String | The DealGroupTotalsLink column of the Users table. |
DealGroupUsersLink | String | The DealGroupUsersLink column of the Users table. |
ListsLink | String | The ListsLink column of the Users table. |
UserGroupLink | String | The UserGroupLink column of the Users table. |
Phone | Unknown | The Phone column of the Users table. |
Signature | Unknown | The Signature column of the Users table. |
Username | String | The Username column of the Users table. |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、ActiveCampaign のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリのクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
SELECT * FROM sys_catalogs
Name | Type | Description |
CatalogName | String | データベース名。 |
利用可能なスキーマをリストします。
次のクエリは、すべての利用可能なスキーマを取得します。
SELECT * FROM sys_schemas
Name | Type | Description |
CatalogName | String | データベース名。 |
SchemaName | String | スキーマ名。 |
利用可能なテーブルをリストします。
次のクエリは、利用可能なテーブルおよびビューを取得します。
SELECT * FROM sys_tables
Name | Type | Description |
CatalogName | String | テーブルまたはビューを含むデータベース。 |
SchemaName | String | テーブルまたはビューを含むスキーマ。 |
TableName | String | テーブル名またはビュー名。 |
TableType | String | テーブルの種類(テーブルまたはビュー)。 |
Description | String | テーブルまたはビューの説明。 |
IsUpdateable | Boolean | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、Contacts テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Contacts'
Name | Type | Description |
CatalogName | String | テーブルまたはビューを含むデータベースの名前。 |
SchemaName | String | テーブルまたはビューを含むスキーマ。 |
TableName | String | カラムを含むテーブルまたはビューの名前。 |
ColumnName | String | カラム名。 |
DataTypeName | String | データ型の名前。 |
DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
Length | Int32 | カラムのストレージサイズ。 |
DisplaySize | Int32 | 指定されたカラムの通常の最大幅(文字数)。 |
NumericPrecision | Int32 | 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
NumericScale | Int32 | カラムのスケール(小数点以下の桁数)。 |
IsNullable | Boolean | カラムがNull を含められるかどうか。 |
Description | String | カラムの簡単な説明。 |
Ordinal | Int32 | カラムのシーケンスナンバー。 |
IsAutoIncrement | String | カラムに固定増分値が割り当てられるかどうか。 |
IsGeneratedColumn | String | 生成されたカラムであるかどうか。 |
IsHidden | Boolean | カラムが非表示かどうか。 |
IsArray | Boolean | カラムが配列かどうか。 |
IsReadOnly | Boolean | カラムが読み取り専用かどうか。 |
IsKey | Boolean | sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。 |
利用可能なストアドプロシージャをリストします。
次のクエリは、利用可能なストアドプロシージャを取得します。
SELECT * FROM sys_procedures
Name | Type | Description |
CatalogName | String | ストアドプロシージャを含むデータベース。 |
SchemaName | String | ストアドプロシージャを含むスキーマ。 |
ProcedureName | String | ストアドプロシージャの名前。 |
Description | String | ストアドプロシージャの説明。 |
ProcedureType | String | PROCEDURE やFUNCTION などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、SelectEntries ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2
Name | Type | Description |
CatalogName | String | ストアドプロシージャを含むデータベースの名前。 |
SchemaName | String | ストアドプロシージャを含むスキーマの名前。 |
ProcedureName | String | パラメータを含むストアドプロシージャの名前。 |
ColumnName | String | ストアドプロシージャパラメータの名前。 |
Direction | Int32 | パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。 |
DataTypeName | String | データ型の名前。 |
DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
Length | Int32 | 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。 |
NumericPrecision | Int32 | 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
NumericScale | Int32 | 数値データの小数点以下の桁数。 |
IsNullable | Boolean | パラメータがNull を含められるかどうか。 |
IsRequired | Boolean | プロシージャの実行にパラメータが必要かどうか。 |
IsArray | Boolean | パラメータが配列かどうか。 |
Description | String | パラメータの説明。 |
Ordinal | Int32 | パラメータのインデックス。 |
主キーおよび外部キーについて説明します。
次のクエリは、Contacts テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Contacts'
Name | Type | Description |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前 |
IsKey | Boolean | カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。 |
IsForeignKey | Boolean | カラムがTableName フィールドで参照される外部キーかどうか。 |
PrimaryKeyName | String | 主キーの名前。 |
ForeignKeyName | String | 外部キーの名前。 |
ReferencedCatalogName | String | 主キーを含むデータベース。 |
ReferencedSchemaName | String | 主キーを含むスキーマ。 |
ReferencedTableName | String | 主キーを含むテーブル。 |
ReferencedColumnName | String | 主キーのカラム名。 |
外部キーについて説明します。
次のクエリは、他のテーブルを参照するすべての外部キーを取得します。
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
名前 | タイプ | 説明 |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前 |
PrimaryKeyName | String | 主キーの名前。 |
ForeignKeyName | String | 外部キーの名前。 |
ReferencedCatalogName | String | 主キーを含むデータベース。 |
ReferencedSchemaName | String | 主キーを含むスキーマ。 |
ReferencedTableName | String | 主キーを含むテーブル。 |
ReferencedColumnName | String | 主キーのカラム名。 |
ForeignKeyType | String | 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。 |
主キーについて説明します。
次のクエリは、すべてのテーブルとビューから主キーを取得します。
SELECT * FROM sys_primarykeys
Name | Type | Description |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前。 |
KeySeq | String | 主キーのシーケンス番号。 |
KeyName | String | 主キーの名前。 |
利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。
次のクエリは、主キーでないすべてのインデックスを取得します。
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Name | Type | Description |
CatalogName | String | インデックスを含むデータベースの名前。 |
SchemaName | String | インデックスを含むスキーマの名前。 |
TableName | String | インデックスを含むテーブルの名前。 |
IndexName | String | インデックス名。 |
ColumnName | String | インデックスに関連付けられたカラムの名前。 |
IsUnique | Boolean | インデックスが固有の場合はTrue。そうでない場合はFalse。 |
IsPrimary | Boolean | インデックスが主キーの場合はTrue。そうでない場合はFalse。 |
Type | Int16 | インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。 |
SortOrder | String | 並べ替え順序:A が昇順、D が降順。 |
OrdinalPosition | Int16 | インデックスのカラムのシーケンスナンバー。 |
利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。
このテーブルをクエリする際は、config 接続文字列を使用する必要があります。
jdbc:cdata:activecampaign:config:
この接続文字列を使用すると、有効な接続がなくてもこのテーブルをクエリできます。
次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。
SELECT * FROM sys_connection_props WHERE Value <> ''
Name | Type | Description |
Name | String | 接続プロパティ名。 |
ShortDescription | String | 簡単な説明。 |
Type | String | 接続プロパティのデータ型。 |
Default | String | 明示的に設定されていない場合のデフォルト値。 |
Values | String | 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。 |
Value | String | 設定した値またはあらかじめ設定されたデフォルト。 |
Required | Boolean | プロパティが接続に必要かどうか。 |
Category | String | 接続プロパティのカテゴリ。 |
IsSessionProperty | String | プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。 |
Sensitivity | String | プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。 |
PropertyName | String | キャメルケースの短縮形の接続プロパティ名。 |
Ordinal | Int32 | パラメータのインデックス。 |
CatOrdinal | Int32 | パラメータカテゴリのインデックス。 |
Hierarchy | String | このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。 |
Visible | Boolean | プロパティが接続UI に表示されるかどうかを通知します。 |
ETC | String | プロパティに関するその他のさまざまな情報。 |
Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。
SQL 構文の詳細については、SQL 準拠 を参照してください。
以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。
名前 | 説明 | 有効な値 |
AGGREGATE_FUNCTIONS | サポートされている集計関数。 | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
COUNT | COUNT 関数がサポートされているかどうか。 | YES, NO |
IDENTIFIER_QUOTE_OPEN_CHAR | 識別子をエスケープするための開始文字。 | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | 識別子をエスケープするための終了文字。 | ] |
SUPPORTED_OPERATORS | サポートされているSQL 演算子。 | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
GROUP_BY | GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。 | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
OJ_CAPABILITIES | サポートされている外部結合の種類。 | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
OUTER_JOINS | 外部結合がサポートされているかどうか。 | YES, NO |
SUBQUERIES | サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。 | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
STRING_FUNCTIONS | サポートされている文字列関数。 | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
NUMERIC_FUNCTIONS | サポートされている数値関数。 | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
TIMEDATE_FUNCTIONS | サポートされている日付および時刻関数。 | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
REPLICATION_SKIP_TABLES | レプリケーション中にスキップされたテーブルを示します。 | |
REPLICATION_TIMECHECK_COLUMNS | レプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。 | |
IDENTIFIER_PATTERN | 識別子としてどの文字列が有効かを示す文字列値。 | |
SUPPORT_TRANSACTION | プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。 | YES, NO |
DIALECT | 使用するSQL ダイアレクトを示します。 | |
KEY_PROPERTIES | Uniform データベースを特定するプロパティを示します。 | |
SUPPORTS_MULTIPLE_SCHEMAS | プロバイダー用に複数のスキームが存在するかどうかを示します。 | YES, NO |
SUPPORTS_MULTIPLE_CATALOGS | プロバイダー用に複数のカタログが存在するかどうかを示します。 | YES, NO |
DATASYNCVERSION | このドライバーにアクセスするために必要な、CData Sync のバージョン。 | Standard, Starter, Professional, Enterprise |
DATASYNCCATEGORY | このドライバーのCData Sync カテゴリ。 | Source, Destination, Cloud Destination |
SUPPORTSENHANCEDSQL | API で提供されている以上の、追加SQL 機能がサポートされているかどうか。 | TRUE, FALSE |
SUPPORTS_BATCH_OPERATIONS | バッチ操作がサポートされているかどうか。 | YES, NO |
SQL_CAP | このドライバーでサポートされているすべてのSQL 機能。 | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
PREFERRED_CACHE_OPTIONS | 使用したいcacheOptions を指定する文字列値。 | |
ENABLE_EF_ADVANCED_QUERY | ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。 | YES, NO |
PSEUDO_COLUMNS | 利用可能な疑似カラムを示す文字列の配列。 | |
MERGE_ALWAYS | 値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。 | TRUE, FALSE |
REPLICATION_MIN_DATE_QUERY | レプリケート開始日時を返すSELECT クエリ。 | |
REPLICATION_MIN_FUNCTION | サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
REPLICATION_START_DATE | レプリケート開始日を、プロバイダーが指定できるようになります。 | |
REPLICATION_MAX_DATE_QUERY | レプリケート終了日時を返すSELECT クエリ。 | |
REPLICATION_MAX_FUNCTION | サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | 初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。 | |
CHECKCACHE_USE_PARENTID | CheckCache 構文を親キーカラムに対して実行するかどうかを示します。 | TRUE, FALSE |
CREATE_SCHEMA_PROCEDURES | スキーマファイルの生成に使用できる、ストアドプロシージャを示します。 |
次のクエリは、WHERE 句で使用できる演算子を取得します。
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。
Name | Type | Description |
NAME | String | SQL 構文のコンポーネント、またはサーバー上で処理できる機能。 |
VALUE | String | サポートされるSQL またはSQL 構文の詳細。 |
試行された変更に関する情報を返します。
次のクエリは、バッチ処理で変更された行のId を取得します。
SELECT * FROM sys_identity
Name | Type | Description |
Id | String | データ変更処理から返された、データベース生成Id。 |
Batch | String | バッチの識別子。1 は単一処理。 |
Operation | String | バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。 |
Message | String | SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
プロパティ | 説明 |
APIKey | The APIKey obtained from the ActiveCampaign UI. |
URL | Base URL which is used to access the API. |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Pagesize | The maximum number of results to return per page from ActiveCampaign. |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
The APIKey obtained from the ActiveCampaign UI.
string
""
API key can be found in your account on the Settings page under the "Developer" tab. Each user in your ActiveCampaign account has their own unique API key.
Base URL which is used to access the API.
string
""
URL can be found in your account on the My Settings page under the "Developer" tab. For example: https://{yourAccountName}.api-us1.com
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
string
""
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
説明 | 例 |
フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
string
""
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Pagesize | The maximum number of results to return per page from ActiveCampaign. |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
int
-1
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
The maximum number of results to return per page from ActiveCampaign.
int
100
The Pagesize property affects the maximum number of results to return per page from ActiveCampaign. ActiveCampaign allows a maximum of 100 records to be returned in each page.
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
string
""
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
int
60
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Cloud は例外をスローします。