CData Sync App は、Salesloft データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Salesloft コネクタはCData Sync アプリケーションから使用可能で、Salesloft からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App はSalesloft API を使用して、Salesloft への双方向アクセスを実現します。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
埋め込みOAuth クレデンシャルかカスタムOAuth クレデンシャルのいずれかでOAuth 認証を有効にするには、AuthScheme をOAuth に設定する必要があります。
以下のサブセクションでは、Salesloft への認証について詳しく説明します。
Web 上で接続するためのカスタムOAuth アプリケーションの作成についての情報と、埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、カスタムOAuth アプリケーションの作成 を参照してください。
Salesloft で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。
アクセストークンの期限が切れたときは、Sync App は自動でアクセストークンをリフレッシュします。
OAuth アクセストークンの自動リフレッシュ:
Sync App がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。
OAuth アクセストークンの手動リフレッシュ:
OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。
OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。
このセクションでは、利用可能なAPI オブジェクトを示し、Salesloft API へのSQL の実行について詳しく説明します。
ビュー では、利用可能なビューを説明します。ビューは、AccountStages、AccountTiers、Actions などを静的にモデル化するように定義されています。
テーブル では、利用可能なテーブルを説明します。テーブルはAccounts、People、Imports、Tasks などを静的にモデル化するように定義されています。
ストアドプロシージャ は、Salesloft のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、Salesloft の操作を実行できます。
Sync App はSalesloft のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Name | Description |
Accounts | Create, update, and query the available accounts in SalesLoft. |
CadenceMemberships | Returns multiple cadence membership records. The records can be filtered, paged, and sorted according to the respective parameters. A cadence membership is the association between a person and their current and historical time on a cadence. Cadence membership records are mutable and change over time. If a person is added to a cadence and re-added to the same cadence in the future, there is a single membership record. |
CalendarEvents | Returns all calendar events, paginated and filtered by the date. |
Calls | Returns multiple call records. The records can be filtered, paged, and sorted according to the respective parameters. |
CustomFields | Fetches multiple custom field records. The records can be filtered, paged, and sorted according to the respective parameters. |
Imports | Create, update, and query the available Imports in SalesLoft. |
Meetings | Fetches multiple meeting records. The records can be filtered, paged, and sorted according to the respective parameters. Meetings resource is responsible for events created via the Salesloft platform using calendaring features. These events can relate to cadences, people, and accounts.. |
MeetingSettings | Fetches multiple meeting records. The records can be filtered, paged, and sorted according to the respective parameters. Meetings resource is responsible for events created via the Salesloft platform using calendaring features. These events can relate to cadences, people, and accounts.. |
Notes | Returns multiple note records. The records can be filtered, paged, and sorted according to the respective parameters. |
PendingEmails | Fetches a list of emails ready to be sent by an external email service. |
People | Create, update, and query the available people in SalesLoft. |
PersonStages | Returns multiple person stage records. The records can be filtered, paged, and sorted according to the respective parameters. |
SavedListViews | Create, update, and query the available saved list views in SalesLoft. |
Tasks | Create, update, and query the available task records in SalesLoft. |
WebhookSubscriptions | Fetches all of the customer webhook subscriptions for your application. |
Create, update, and query the available accounts in SalesLoft.
The Sync App will use the Salesloft 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.
SELECT * FROM Accounts WHERE ID = 123 SELECT * FROM Accounts WHERE AccountTierId IN ('123', '1234') SELECT * FROM Accounts WHERE CreatedAt >= '2022-12-01' SELECT * FROM Accounts WHERE CrmId IN ('123', '1234') SELECT * FROM Accounts WHERE Domain IN ('domainA', 'domainB') SELECT * FROM Accounts WHERE MyCustomFiled = 'customValue' ,etc.
To add an Account, at least the Domain and Name need to be specified. The Sync App is able to execute an insert in two ways.
INSERT INTO Accounts (Domain, Name, Description) VALUES ('DomainTest.com', 'TestAccount', 'Description of test account' )Or using Bulk Insert:
INSERT INTO Accounts#TEMP (Domain, Name, Description) VALUES ('DomainTest.com', 'TestAccount', 'Description of test account' ) INSERT INTO Accounts#TEMP (Domain, Name, Description) VALUES ('DomainTest1.com', 'TestAccount1', 'Description of test account1' ) INSERT INTO Accounts (Domain, Name, Description) SELECT Domain, Name, Description FROM Accounts#TEMP
Similarly, to the Insert operation we can update an item by specifying the field and the new value.
UPDATE Accounts SET Description = 'Updated Description', Phone = '123', Country = 'US', State = 'CA' WHERE ID = 13391259
To perform an upsert operation, the upsert Key must be provided. Valid options are: ID, CrmId, Domain. Additionally, the Salesloft can perform a batch Upsert for more than 1 record.
UPSERT INTO Accounts (name, id, domain, description, Tags, OwnerId) VALUES ('AccountN' ,10917448, 'AccountDom.com', 'This is an upsert', 'tag1Upsert,tag2Upsert', 16081 )
In order to delete an Account the ID needs to be specified, for ex.:
DELETE FROM Accounts WHERE ID = 100
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | True |
The Id property of the Account table. |
AccountTierId | Integer | False |
The AccountTierId property of the Account table. |
ArchivedAt | Datetime | True |
The ArchivedAt property of the Account table. |
City | String | False |
The City property of the Account table. |
CompanyStageId | Integer | False |
The CompanyStageId property of the Account table. |
CompanyType | String | False |
The CompanyType property of the Account table. |
ConversationalName | String | True |
The ConversationalName property of the Account table. |
Country | String | False |
The Country property of the Account table. |
CountsPeople | Integer | False |
The CountsPeople property of the Account table. |
CreatedAt | Datetime | True |
The CreatedAt property of the Account table. |
CreatorId | Integer | False |
The CreatorId property of the Account table. |
CrmId | String | False |
The CrmId property of the Account table. |
CrmObjectType | String | False |
The CrmObjectType property of the Account table. |
CrmUrl | String | False |
The CrmUrl property of the Account table. |
Description | String | False |
The Description property of the Account table. |
DoNotContact | Boolean | False |
The DoNotContact property of the Account table. |
Domain | String | False |
The Domain property of the Account table. |
Founded | String | False |
The Founded property of the Account table. |
Industry | String | False |
The Industry property of the Account table. |
LastContactedAt | Datetime | True |
The LastContactedAt property of the Account table. |
LastContactedById | Integer | False |
The LastContactedById property of the Account table. |
LastContactedPersonId | Integer | False |
The LastContactedPersonId property of the Account table. |
LastContactedType | String | False |
The LastContactedType property of the Account table. |
LinkedinUrl | String | False |
The LinkedinUrl property of the Account table. |
Locale | String | False |
The Locale property of the Account table. |
Name | String | False |
The Name property of the Account table. |
OwnerId | Integer | False |
The OwnerId property of the Account table. |
OwnerCrmId | String | False |
The OwnerCrmId property of the Account table. |
Phone | String | False |
The Phone property of the Account table. |
PostalCode | String | False |
The PostalCode property of the Account table. |
RevenueRange | String | False |
The RevenueRange property of the Account table. |
Size | String | False |
The Size property of the Account table. |
State | String | False |
The State property of the Account table. |
Street | String | False |
The Street property of the Account table. |
Tags | String | False |
The Tags property of the Account table. |
TwitterHandle | String | False |
The TwitterHandle property of the Account table. |
UpdatedAt | Datetime | True |
The UpdatedAt property of the Account table. |
Website | String | False |
The Website property of the Account table. |
Archived | Boolean | False |
The Archived property of the Account table. |
TagId | Integer | False |
The TagId property of the Account table. |
AccountStageId | Integer | False |
The AccountStageId property of the Account table. |
OwnerIsActive | Boolean | False |
The OwnerIsActive property of the Account table. |
Returns multiple cadence membership records. The records can be filtered, paged, and sorted according to the respective parameters. A cadence membership is the association between a person and their current and historical time on a cadence. Cadence membership records are mutable and change over time. If a person is added to a cadence and re-added to the same cadence in the future, there is a single membership record.
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
The Id of the CadenceMembership. |
AddedAt | Datetime | False |
The AddedAt property of the CadenceMembership table. |
CadenceId | Integer | False |
The CadenceId property of the CadenceMembership table. |
CountsBounces | Integer | False |
The CountsBounces property of the CadenceMembership table. |
CountsCalls | Integer | False |
The CountsCalls property of the CadenceMembership table. |
CountsClicks | Integer | False |
The CountsClicks property of the CadenceMembership table. |
CountsReplies | Integer | False |
The CountsReplies property of the CadenceMembership table. |
CountsSentEmails | Integer | False |
The CountsSentEmails property of the CadenceMembership table. |
CountsViews | Integer | False |
The CountsViews property of the CadenceMembership table. |
CreatedAt | Datetime | False |
The CreatedAt property of the CadenceMembership table. |
CurrentState | String | False |
The CurrentState property of the CadenceMembership table. |
CurrentlyOnCadence | Boolean | False |
The CurrentlyOnCadence property of the CadenceMembership table. |
LatestActionId | Integer | False |
The LatestActionId property of the CadenceMembership table. |
PersonId | Integer | False |
The PersonId property of the CadenceMembership table. |
PersonDeleted | Boolean | False |
The PersonDeleted property of the CadenceMembership table. |
UpdatedAt | Datetime | False |
The UpdatedAt property of the CadenceMembership table. |
UserId | Integer | False |
The UserId property of the CadenceMembership table. |
StepId | Integer | False |
ID of the step on which the person should start the cadence. Start on first step is the default behavior without this parameter. |
Returns all calendar events, paginated and filtered by the date.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The Id of the CalendarEvent. |
UpdatedAt | Datetime | False |
Last modification time of the calendar event. |
UserGuid | String | False |
The UUID of the user this activity is for. |
Title | String | False |
Title of the calendar event. |
TenantId | Integer | False |
The Tenant ID of the user calendar. |
Status | String | False |
The Status of the Email. 使用できる値は次のとおりです。confirmed, tentative, cancelled |
StartTime | Datetime | False |
Start time of the meeting. |
Recurring | Boolean | False |
Whether the calendar event is a recurring event. |
Provider | String | False |
The provider of the calendar event. |
Organizer | String | False |
The organizer email of the calendar event. |
Location | String | False |
The Location of the calendar event. |
ICalUid [KEY] | String | False |
The Calendar event unique identifier (iCalUID). |
HtmlLink | String | False |
Raw body content from Microsoft calendar events. |
BodyHtml | String | False |
An absolute link to this calendar event in the Google Calendar Web UI. |
ExtendedProperties | String | False |
Extended properties of the calendar event. |
EndTime | Datetime | False |
The (exclusive) end time of the calendar event. |
Description | String | False |
Description of the calendar event. |
Creator | String | False |
The creator email of the calendar event. |
CreatedAt | Datetime | False |
The CreatedAt of the Email. |
ConferenceData | String | False |
The conference-related information, such as details of a Google Meet conference. |
CanceledAt | Datetime | False |
The canceled date of the calendar event. |
CalendarId [KEY] | String | False |
Calendar ID of the user calendar. |
Busy | Boolean | False |
Busy/free status of the calendar event. |
Attendees | String | False |
The attendees of the calendar event. |
AllDay | Boolean | False |
Whether the calendar event is an all-day event. |
Returns multiple call records. The records can be filtered, paged, and sorted according to the respective parameters.
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
The Id of the Call. |
ActionId | Integer | False |
The ActionId of the Call. |
CadenceId | Integer | False |
The CadenceId of the Call. |
CalledPersonId | Integer | False |
The CalledPersonId of the Call. |
CreatedAt | Datetime | False |
The CreatedAt of the Call. |
CrmActivityId | Integer | False |
The CrmActivityId of the Call. |
Disposition | String | False |
The Disposition of the Call. |
Duration | Integer | False |
The Duration of the Call. |
NoteId | Integer | False |
The NoteId of the Call. |
Recordings | String | False |
The Recordings of the Call. |
Sentiment | String | False |
The Sentiment of the Call. |
StepId | Integer | False |
The StepId of the Call. |
To | String | False |
The To of the Call. |
UpdatedAt | Datetime | False |
The UpdatedAt of the Call. |
UserId | Integer | False |
The UserId of the Call. |
PersonId | String | False |
The PersonId property of the Calls table. |
LinkedCallDataRecordIds | String | False |
CallDataRecord associations that will become linked to the created call. It is possible to pass multiple CallDataRecord ids in this field; this can be used to represent multiple phone calls that made up a single call.Any call data record that is used must not already be linked to a call. It is not possible to link a call data record to multiple calls, and it is not possible to re-assign a call data record to a different call.* Only single values are supported with our |
Fetches multiple custom field records. The records can be filtered, paged, and sorted according to the respective parameters.
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
The ID of Custom Field. |
Name | String | False |
The Name of the Custom Field. |
FieldType | String | False |
Type of the Custom Field. Value must be one of: person, company, opportunity. 使用できる値は次のとおりです。person, company, opportunity |
ValueType | String | False |
Value Type of the Custom Field. Value must be one of: text, date. 使用できる値は次のとおりです。text, date |
CreatedAt | Datetime | False |
The Datetime of when the Custom Field was created |
UpdatedAt | Datetime | False |
The Datetime of when the Custom Field was last updated. |
Create, update, and query the available Imports in SalesLoft.
The Sync App will use the Salesloft 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.
SELECT * FROM Imports WHERE Id IN (1234, 4321) SELECT * FROM Imports WHERE UserIDs IN (123, 321)
To add an Import UserId and Name need to be specified.
INSERT INTO Imports (UserId, Name) VALUES (123, 'ImportTest')
Similarly to the Insert operation, update an Import by specifying the field and the new value.
UPDATE Imports SET Name = 'new test' WHERE Id = 123
In order to delete an Import the Id needs to be specified, for ex.
DELETE FROM Imports WHERE Id = 100
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
The Id of the Import. |
CreatedAt | Datetime | True |
The CreatedAt of the Import. |
UpdatedAt | Datetime | True |
The UpdatedAt of the Import. |
Name | String | False |
The Name of the Import. |
CurrentPeopleCount | Integer | False |
The CurrentPeopleCount of the Import. |
ImportedPeopleCount | Integer | False |
The ImportedPeopleCount of the Import. |
UserIDs | String | False |
The OwnedByGuid property of the Import table. |
Fetches multiple meeting records. The records can be filtered, paged, and sorted according to the respective parameters. Meetings resource is responsible for events created via the Salesloft platform using calendaring features. These events can relate to cadences, people, and accounts..
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
The Id of the meeting. |
Title | String | False |
Title of the meeting. |
StartTime | Datetime | False |
Start time of the meeting. |
EndTime | Datetime | False |
End time of the meeting. |
CalendarId | String | False |
Calendar ID of the meeting owner. |
CalendarType | String | False |
Calendar type of the meeting owner. Possible values are: gmail, azure, nylas, linkedin_azure, cerebro, external. 使用できる値は次のとおりです。gmail, azure, nylas, linkedin_azure, cerebro, external |
MeetingType | String | False |
Meeting type. |
RecipientName | String | False |
Name of the meeting invite recipient. |
RecipientEmail | String | False |
Email of the meeting invite recipient. |
Location | String | False |
Location of the meeting. |
Description | String | False |
Description of the meeting. |
EventId | String | False |
ID of the meeting created by target calendar. |
AccountId | String | False |
ID of the account the recipient associated to. |
TaskId | String | False |
ID of the created task. |
CreatedAt | Datetime | False |
Datetime of when the meeting was created. |
UpdatedAt | Datetime | False |
Datetime of when the meeting was last updated. |
Guests | String | False |
The list of attendees emails of the meeting. |
Attendees | String | False |
The attendees of the meeting. Each attendee includes the following fields: status, email, name, organizer. |
Person | String | False |
The Salesloft Person record for the recipient. |
Cadence | String | False |
The Salesloft Cadence record associated with meeting. |
Step | String | False |
The Salesloft Step record associated with meeting. |
BookedByUser | String | False |
The User who booked the meeting. |
CrmReferences | String | False |
The List of crm references associated with the meeting. |
EventSource | String | False |
Source of the meeting. Possible values are: 'external' - The event was synced to Salesloft platform via Calendar Sync, 'internal' - The event was created via Salesloft platform. |
CanceledAt | Datetime | False |
Datetime of when the meeting was canceled. |
AllDay | Boolean | False |
Whether the meeting is an all-day meeting. |
NoShow | Boolean | False |
Whether the meeting is a No Show meeting. |
CrmCustomFields | String | False |
The List of crm custom fields which will be logged to SFDC. |
StrictAttribution | Boolean | False |
Strict attribution means that we 100% sure which cadence generate the meeting. |
ICalUid | String | False |
The UID of the meeting provided by target calendar provider. |
Status | String | False |
The Status of the meeting. Possible values are: pending, booked, failed, retry. 使用できる値は次のとおりです。pending, booked, failed, retry |
RescheduleStatus | String | False |
The Status of the meeting rescheduling progress. Possible values are: pending, booked, failed, retry. |
OwnedByMeetingsSettings | String | False |
The Owner meetings settings. |
BookedByMeetingsSettings | String | False |
The Organizer meetings settings. |
ShowDeleted | Boolean | False |
Whether to include deleted events in the result. |
Fetches multiple meeting records. The records can be filtered, paged, and sorted according to the respective parameters. Meetings resource is responsible for events created via the Salesloft platform using calendaring features. These events can relate to cadences, people, and accounts..
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
The Id of the meeting. |
Title | String | False |
Title of the meeting. |
StartTime | Datetime | False |
Start time of the meeting. |
EndTime | Datetime | False |
End time of the meeting. |
CalendarId | String | False |
Calendar ID of the meeting owner. |
CalendarType | String | False |
Calendar type of the meeting owner. Possible values are: gmail, azure, nylas, linkedin_azure, cerebro, external. 使用できる値は次のとおりです。gmail, azure, nylas, linkedin_azure, cerebro, external |
MeetingType | String | False |
Meeting type. |
RecipientName | String | False |
Name of the meeting invite recipient. |
RecipientEmail | String | False |
Email of the meeting invite recipient. |
Location | String | False |
Location of the meeting. |
Description | String | False |
Description of the meeting. |
EventId | String | False |
ID of the meeting created by target calendar. |
AccountId | String | False |
ID of the account the recipient associated to. |
TaskId | String | False |
ID of the created task. |
CreatedAt | Datetime | False |
Datetime of when the meeting was created. |
UpdatedAt | Datetime | False |
Datetime of when the meeting was last updated. |
Guests | String | False |
The list of attendees emails of the meeting. |
Attendees | String | False |
The attendees of the meeting. Each attendee includes the following fields: status, email, name, organizer. |
Person | String | False |
The Salesloft Person record for the recipient. |
Cadence | String | False |
The Salesloft Cadence record associated with meeting. |
Step | String | False |
The Salesloft Step record associated with meeting. |
BookedByUser | String | False |
The User who booked the meeting. |
CrmReferences | String | False |
The List of crm references associated with the meeting. |
EventSource | String | False |
Source of the meeting. Possible values are: 'external' - The event was synced to Salesloft platform via Calendar Sync, 'internal' - The event was created via Salesloft platform. |
CanceledAt | Datetime | False |
Datetime of when the meeting was canceled. |
AllDay | Boolean | False |
Whether the meeting is an all-day meeting. |
NoShow | Boolean | False |
Whether the meeting is a No Show meeting. |
CrmCustomFields | String | False |
The List of crm custom fields which will be logged to SFDC. |
StrictAttribution | Boolean | False |
Strict attribution means that we 100% sure which cadence generate the meeting. |
ICalUid | String | False |
The UID of the meeting provided by target calendar provider. |
Status | String | False |
The Status of the meeting. Possible values are: pending, booked, failed, retry. 使用できる値は次のとおりです。pending, booked, failed, retry |
RescheduleStatus | String | False |
The Status of the meeting rescheduling progress. Possible values are: pending, booked, failed, retry. |
OwnedByMeetingsSettings | String | False |
The Owner meetings settings. |
BookedByMeetingsSettings | String | False |
The Organizer meetings settings. |
ShowDeleted | Boolean | False |
Whether to include deleted events in the result. |
Returns multiple note records. The records can be filtered, paged, and sorted according to the respective parameters.
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
The Id of the Note. |
Content | String | False |
The Content of the Note. |
CreatedAt | Datetime | False |
The CreatedAt of the Note. |
UpdatedAt | Datetime | False |
The UpdatedAt of the Note. |
UserId | Integer | False |
The UserId of the Note. |
AssociatedWithId | Integer | False |
The AssociatedWithId of the Note. |
CallId | Integer | False |
The CallId of the Note. |
AssociatedWithType | String | False |
The AssociatedWithType property of the Note table. |
SkipCRMSync | Boolean | False |
Boolean indicating if the CRM sync should be skipped. No syncing will occur if true. |
Subject | String | False |
The subject of the note's crm activity, defaults to 'Note'. |
UserGUID | String | False |
The user to create the note for. Only team admins may create notes on behalf of other users. Defaults to the requesting user. |
Fetches a list of emails ready to be sent by an external email service.
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
ID of the email. |
Mailbox | String | False |
Email Address of the pending email. |
MIMEEmailPayload | String | False |
The email MIME payload. |
MessageId | String | False |
The message id of the email that was sent. |
Status | String | False |
Delivery status of the email. Valid statuses are 'sent' and 'failed'. |
ErrorMessage | String | False |
The error message indicating why the email failed to send. |
SentAt | String | False |
The time that the email was actually sent in iso8601 format. |
Create, update, and query the available people in SalesLoft.
The Sync App will use the Salesloft 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.
SELECT * FROM People WHERE Id = 123 SELECT * FROM People WHERE AccountId IN (123, 1234) SELECT * FROM People WHERE EmailAddress IS NULL SELECT * FROM People WHERE MyCustomFiled = 'customValue'
To add a Person, at least the EmailAddress, FirstName and LastName need to be specified. Execute an insert in one of 2 ways.
INSERT INTO People (EmailAddress, Phone, FirstName, LastName) VALUES ('[email protected]', '123456', 'FirstNameTest', 'LastNameTest')Or using Bulk Insert:
INSERT INTO People#TEMP (EmailAddress, Phone, FirstName, LastName) VALUES ('[email protected]', '123456', 'FirstNameTest', 'LastNameTest') INSERT INTO People#TEMP (EmailAddress, Phone, FirstName, LastName) VALUES ('[email protected]', '1234567', 'FirstNameTest1', 'LastNameTest1') INSERT INTO People (EmailAddress, Phone, FirstName, LastName) SELECT EmailAddress, Phone, FirstName, LastName FROM People#TEMP
Similarly, to the Insert operation we can update a Person by specifying the field and the new value.
UPDATE People SET Phone = '123456', Tags = 'tag1,tag2', WorkCity = 'NewCity' WHERE Id = 123
To perform an upsert operation, the upsert Key must be provided. Valid options are: ID, CrmId, EmailAddress. Additionally, the Sync App can perform a batch Upsert for more than 1 record.
UPSERT INTO People (FirstName, Id, Phone) VALUES ('AccountN', 10917448, '123')
In order to delete a Person, the Id needs to be specified.
DELETE FROM People WHERE Id = 100
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | True |
The Id property of the People table. |
AccountId | Integer | False |
The AccountId property of the People table. |
Bouncing | Boolean | False |
The Bouncing property of the People table. |
City | String | False |
The City property of the People table. |
ContactRestrictions | String | False |
The ContactRestrictions property of the People table. |
Country | String | False |
The Country property of the People table. |
CountsCalls | Integer | False |
The CountsCalls property of the People table. |
CountsEmailsBounced | Integer | True |
The CountsEmailsBounced property of the People table. |
CountsEmailsClicked | Integer | False |
The CountsEmailsClicked property of the People table. |
CountsEmailsRepliedTo | Integer | False |
The CountsEmailsRepliedTo property of the People table. |
CountsEmailsSent | Integer | False |
The CountsEmailsSent property of the People table. |
CountsEmailsViewed | Integer | False |
The CountsEmailsViewed property of the People table. |
CreatedAt | Datetime | True |
The CreatedAt property of the People table. |
CrmId | String | False |
The CrmId property of the People table. |
CrmObjectType | String | False |
The CrmObjectType property of the People table. |
CrmUrl | String | False |
The CrmUrl property of the People table. |
DisplayName | String | False |
The DisplayName property of the People table. |
DoNotContact | Boolean | False |
The DoNotContact property of the People table. |
EmailAddress | String | False |
The EmailAddress property of the People table. |
FirstName | String | False |
The FirstName property of the People table. |
FullEmailAddress | String | False |
The FullEmailAddress property of the People table. |
HomePhone | String | False |
The HomePhone property of the People table. |
ImportId | Integer | False |
The ImportId property of the People table. |
JobSeniority | String | False |
The JobSeniority property of the People table. |
LastCompletedStepId | Integer | False |
The LastCompletedStepId property of the People table. |
LastCompletedStepCadenceId | Integer | False |
The LastCompletedStepCadenceId property of the People table. |
LastContactedAt | Datetime | True |
The LastContactedAt property of the People table. |
LastContactedById | Integer | False |
The LastContactedById property of the People table. |
LastContactedType | String | False |
The LastContactedType property of the People table. |
LastName | String | False |
The LastName property of the People table. |
LastRepliedAt | Datetime | True |
The LastRepliedAt property of the People table. |
LinkedinUrl | String | False |
The LinkedinUrl property of the People table. |
Locale | String | False |
The Locale property of the People table. |
MobilePhone | String | False |
The MobilePhone property of the People table. |
MostRecentCadenceId | Integer | False |
The MostRecentCadenceId property of the People table. |
OwnerId | Integer | False |
The OwnerId property of the People table. |
OwnerCrmId | String | False |
The OwnerCrmId property of the People table. |
PersonCompanyIndustry | String | False |
The PersonCompanyIndustry property of the People table. |
PersonCompanyName | String | False |
The PersonCompanyName property of the People table. |
PersonCompanyWebsite | String | False |
The PersonCompanyWebsite property of the People table. |
PersonStageId | Integer | False |
The PersonStageId property of the People table. |
PersonalEmailAddress | String | False |
The PersonalEmailAddress property of the People table. |
PersonalWebsite | String | False |
The PersonalWebsite property of the People table. |
Phone | String | False |
The Phone property of the People table. |
PhoneExtension | String | False |
The PhoneExtension property of the People table. |
SecondaryEmailAddress | String | False |
The SecondaryEmailAddress property of the People table. |
State | String | False |
The State property of the People table. |
Tags | String | False |
The Tags property of the People table. |
Title | String | False |
The Title property of the People table. |
TwitterHandle | String | False |
The TwitterHandle property of the People table. |
UpdatedAt | Datetime | True |
The UpdatedAt property of the People table. |
WorkCity | String | False |
The WorkCity property of the People table. |
WorkCountry | String | False |
The WorkCountry property of the People table. |
WorkState | String | False |
The WorkState property of the People table. |
OwnedByGuid | String | False |
The OwnedByGuid property of the People table. |
CanEmail | Boolean | False |
The CanEmail property of the People table. |
CanCall | Boolean | False |
The CanCall property of the People table. |
TagId | Integer | False |
The TagId property of the People table. |
OwnerIsActive | Boolean | False |
The OwnerIsActive property of the People table. |
CadenceId | Integer | False |
The cadenceid property of the People table. |
Returns multiple person stage records. The records can be filtered, paged, and sorted according to the respective parameters.
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
The Id of the AccountStage. |
Name | String | False |
The Name of the Account. |
CreatedAt | Datetime | False |
The CreatedAt date of the Account. |
UpdatedAt | Datetime | False |
The UpdatedAt date of the AccountStage. |
Order | Integer | False |
The Order of the Account. |
Create, update, and query the available saved list views in SalesLoft.
The Sync App will use the Salesloft 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.
SELECT * FROM SavedListViews WHERE Id = 123 SELECT * FROM SavedListViews WHERE View = 'people'
To add an entry into SavedListViews, at least the Name and View need to be specified.
INSERT INTO SavedListViews (Name, View, IsDefault) VALUES ('SampleView', 'people', true)
Similarly to the Insert operation, update a SavedListView by specifying the field and the new value.
UPDATE SavedListViews SET Name = 'NewName', View = 'companies', IsDefault = false WHERE Id = 123
In order to delete a SavedListViews the Id needs to be specified.
DELETE FROM SavedListViews WHERE Id = 123
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
The Id of the Stage. |
View | String | False |
The View of the Stage. 使用できる値は次のとおりです。people, companies, recordings |
Name | String | False |
The Name of the Stage. |
ViewParams | String | False |
The ViewParams of the Stage. |
IsDefault | Boolean | False |
The IsDefault of the Stage. |
UpdatedAt | Datetime | True |
The UpdatedAt date of the Stage. |
Create, update, and query the available task records in SalesLoft.
The Sync App will use the Salesloft 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.
SELECT * FROM Tasks WHERE Id = 123 SELECT * FROM Tasks WHERE CurrentState IN ('scheduled', 'completed') SELECT * FROM Tasks WHERE PersonId IN (123, 321) SELECT * FROM Tasks WHERE TaskType IN ('call', 'email') SELECT * FROM Tasks WHERE TimeInterval = 'interval' SELECT * FROM Tasks WHERE IdempotencyKey = 'key'
To add a Task, at least the Subject, PersonId, UserId, TaskType, DueDate and CurrentState need to be specified.
INSERT INTO Tasks (Subject, PersonId, UserId, TaskType, DueDate, CurrentState) VALUES ('Subject Task Test', 123, 123, 'email', '2022-12-30', 'scheduled')
Similarly, to the Insert operation we can update a Task by specifying the field and the new value.
UPDATE Tasks SET Subject = 'new Subject', CurrentState = 'completed' WHERE ID = 123
In order to delete a Task the Id needs to be specified, for ex.
DELETE FROM Tasks WHERE Id = 100
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
The Id of the Task. |
CompletedAt | Datetime | False |
The CompletedAt of the Task. |
CompletedById | Integer | False |
The CompletedById of the Task. |
CreatedAt | Datetime | True |
The CreatedAt of the Task. |
CreatedByUserId | Integer | False |
The CreatedByUserId of the Task. |
CurrentState | String | False |
The CurrentState of the Task. |
DueAt | Datetime | False |
The DueAt of the Task. |
DueDate | Date | False |
The DueDate of the Task. |
PersonId | Integer | False |
The PersonId of the Task. |
RemindAt | Datetime | False |
The RemindAt of the Task. |
Subject | String | False |
The Subject of the Task. |
TaskType | String | False |
The TaskType of the Task. |
UpdatedAt | Datetime | True |
The UpdatedAt date of the Task. |
UserId | Integer | False |
The UserId of the Task. |
TimeInterval | String | False |
The TimeInterval property of the Task table. |
IdempotencyKey | String | False |
The IdempotencyKey property of the Task table. |
Fetches all of the customer webhook subscriptions for your application.
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
ID for the Webhook Subscription. |
UserGUID | String | False |
UUID of the user the token is associated with. |
TenantId | Integer | False |
ID for the tenant to which user is assigned. |
EventType | String | False |
Type of event the subscription is for. |
Enabled | Boolean | False |
Is the Webhook Subscription enabled or not. |
CallbackUrl | String | False |
URL for your callback handler. |
CallbackToken | String | False |
SalesLoft will include this token in the webhook event payload when calling your callback_url. It is strongly encouraged for your handler to verify this value in order to ensure the request came from SalesLoft. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
AccountStages | Returns multiple account stage records. The records can be filtered, paged, and sorted according to the respective parameters. |
AccountTiers | Returns multiple account tier records. The records can be filtered, paged, and sorted according to the respective parameters. |
ActionDetails | Returns multiple call instruction records. The records can be filtered, paged, and sorted according to the respective parameters. |
Actions | Returns multiple action records. The records can be filtered, paged, and sorted according to the respective parameters. Only actions that are currently 'in_progess' will be returned by this endpoint. If the requester is not an admin, this endpoint will only return actions belonging to the requester. If the request is an admin, this endpoint will return actions for the entire team. Additionally, an admin may use the user_guid parameter to request actions that belong to specific users on the team. |
ActivityHistories | Fetches all of the customer's past activities for your application. Returns all the Activities that are found on the Salesloft Activity Feed. |
Cadences | Returns multiple cadence records. The records can be filtered, paged, and sorted according to the respective parameters. |
CallDataRecords | Returns multiple call data records. The records can be filtered, paged, and sorted according to the respective parameters. Call data records are records of all inbound and outbound calls through SalesLoft. A call data record may be associated with a call, but does not have to be. |
CallDispositions | Returns multiple call disposition records. The records can be sorted according to the respective parameters. Call dispositions must be configured in application. This will change in the future, but please contact us if you have a pressing use case. |
CallerIDs | Returns each entry that is a possible caller ID match for the number. Multiple entries may be returned if the phone number is present on more than one person in the system. Phone number should be in E.164 format. |
CallSentiments | Returns multiple call sentiment records. The records can be sorted according to the respective parameters. Call sentiments must be configured in application. This will change in the future, but please contact us if you have a pressing use case. |
ConversationsCalls | Enqueue a Conversations Call for processing. |
CRMActivities | Returns multiple crm activity records. The records can be filtered, paged, and sorted according to the respective parameters. |
CRMActivityFields | Returns multiple crm activity field records. The records can be filtered, paged, and sorted according to the respective parameters. |
CRMUsers | Returns multiple crm user records. |
Emails | Returns multiple email records. The records can be filtered, paged, and sorted according to the respective parameters. |
EmailTemplateAttachments | Returns multiple email template attachment records. The records can be filtered and paged according to the respective parameters. |
EmailTemplates | Returns multiple email template records. The records can be filtered, paged, and sorted according to the respective parameters. |
Groups | Returns multiple group records. The records can be filtered, and sorted according to the respective parameters. |
MIMEEmailPayloads | Returns the MIME content for email. |
PhoneNumberAssignments | Fetches multiple phone number assignment records. The records can be filtered, paged, and sorted according to the respective parameters. |
RecordingSettings | Fetches the recording status for a given phone number, based on Do Not Record and Recording Governance for your team. Phone number should be in E.164 format. |
Roles | Fetches multiple custom role records. The records can be filtered, and sorted according to the respective parameters. A custom role is any role that is not Admin or User. |
Steps | Returns multiple step records. The records can be filtered, paged, and sorted according to the respective parameters. |
Successes | Returns multiple success records. The records can be filtered, paged, and sorted according to the respective parameters. |
Tags | Fetches a list of the tags used for a team. The records can be filtered, paged, and sorted according to the respective parameters. Tags can be applied to multiple resource types. |
Team | Returns the team of the authenticated user. |
TeamTemplateAttachments | Returns multiple team template attachment records. The records can be filtered and paged according to the respective parameters. |
TeamTemplates | Fetches multiple team template records. The records can be filtered, paged, and sorted according to the respective parameters. Team templates are templates that are available team-wide. Admins may use team templates to create original content for the entire team, monitor version control to ensure templates are always up to date, and track template performance across the entire organization. All metrics on a team template reflect usage across the team; individual metrics can be found with the email_templates API endpoint. |
Users | Returns Non Admin: Lists only your user, or all on team depending on group visibility policy Team Admin: Lists users associated with your team. |
Returns multiple account stage records. The records can be filtered, paged, and sorted according to the respective parameters.
Name | Type | Description |
Id [KEY] | Integer | The Id of the AccountStage. |
CreatedAt | Datetime | The CreatedAt date of the AccountStage. |
Name | String | The Name of the AccountStage. |
Order | Integer | The Order of the AccountStage. |
UpdatedAt | Datetime | The UpdatedAt property of the AccountStage table. |
Returns multiple account tier records. The records can be filtered, paged, and sorted according to the respective parameters.
Name | Type | Description |
Id [KEY] | Integer | The Id of the AccountTier. |
CreatedAt | Datetime | The CreatedAt date of the AccountTier. |
Name | String | The Name of the AccountTier. |
Order | Integer | The Order of the AccountTier. |
UpdatedAt | Datetime | The UpdatedAt property of the AccountTier table. |
Returns multiple call instruction records. The records can be filtered, paged, and sorted according to the respective parameters.
Name | Type | Description |
Id [KEY] | Integer | The Id of the ActionDetail. |
CreatedAt | Datetime | The CreatedAt date of the ActionDetail. |
UpdatedAt | Datetime | The UpdatedAt date of the ActionDetail. |
Instructions | String | The Instructions of the ActionDetail. |
Returns multiple action records. The records can be filtered, paged, and sorted according to the respective parameters. Only actions that are currently 'in_progess' will be returned by this endpoint. If the requester is not an admin, this endpoint will only return actions belonging to the requester. If the request is an admin, this endpoint will return actions for the entire team. Additionally, an admin may use the user_guid parameter to request actions that belong to specific users on the team.
Name | Type | Description |
Id [KEY] | Integer | The Id of the Action. |
ActionDetailsId | Integer | The ActionDetailsId of the Action. |
CadenceId | Integer | The CadenceId of the Action. |
CreatedAt | Datetime | The CreatedAt date of the Action. |
Due | Boolean | Returns if the Action is on Due. |
DueOn | Datetime | The DueOn date of the Action. |
MultitouchGroupId | Integer | The MultitouchGroupId of the Action. |
PersonId | Integer | The PersonId of the Action. |
Status | String | The Status of the Action. |
StepId | Integer | The StepId of the Action. |
Type | String | The Type of the Action. |
UpdatedAt | Datetime | The UpdatedAt date of the Action. |
UserId | Integer | The UserId of the Action. |
Fetches all of the customer's past activities for your application. Returns all the Activities that are found on the Salesloft Activity Feed.
Name | Type | Description |
Id [KEY] | String | The Id of the Action. |
UserGuid | String | The UUID of the user this activity is for. |
UpdatedAt | Datetime | When this record was updated. |
Type | String | The Type of the Activity. Filter by the type of activity. Must be one of: added_to_cadence, completed_action, call, requested_email, sent_email, received_email, email_reply, note, success, dnc_event, residency_change, meeting, meeting_held, message_conversation, task, voicemail, opportunity_stage_change, opportunity_amount_change, opportunity_close_date_change.
使用できる値は次のとおりです。added_to_cadence, completed_action, call, requested_email, sent_email, received_email, email_reply, note, success, dnc_event, residency_change, meeting, meeting_held, message_conversation, task, voicemail, opportunity_stage_change, opportunity_amount_change, opportunity_close_date_change |
StaticData | String | The static data for this activity. |
DynamicData | String | Attributes from associated records. This is specific to the type of activity and may change over time. Not returned for create requests. |
FailedDynamicResources | String | A list of remote resource names that failed to load. This is specific to the type of activity and may change over time. Not returned for create requests. |
ResourceType | String | Type of the resource this activity is for. One of: account, person.
使用できる値は次のとおりです。person, account, crm_opportunity |
ResourceId | Integer | ID of the resource this activity is for. It will be a string for the following resource types: crm_opportunity. |
PinnedAt | Datetime | When this record was pinned. |
OccurredAt | Datetime | When this activity occurred. |
CreatedAt | Datetime | When this record was created. |
Pinned | Boolean | Filter by the pinned status of activity. Must be 'true' or 'false'. |
Returns multiple cadence records. The records can be filtered, paged, and sorted according to the respective parameters.
Name | Type | Description |
Id [KEY] | Integer | The Id of the Cadence. |
AddedStageId | Integer | The AddedStageId of the Cadence. |
ArchivedAt | Datetime | The ArchivedAt of the Cadence. |
BouncedStageId | Integer | The BouncedStageId of the Cadence. |
CountsCadencePeople | Integer | The CountsCadencePeople of the Cadence. |
CountsTargetDailyPeople | Integer | The CountsTargetDailyPeople of the Cadence. |
CreatedAt | Datetime | The CreatedAt of the Cadence. |
CreatorId | Integer | The CreatorId of the Cadence. |
FinishedStageId | Integer | The FinishedStageId of the Cadence. |
Name | String | The Name of the Cadence. |
OptOutLinkIncluded | Boolean | The OptOutLinkIncluded of the Cadence. |
OwnerId | Integer | The OwnerId of the Cadence. |
RemoveBouncesEnabled | Boolean | The RemoveBouncesEnabled of the Cadence. |
RemoveRepliesEnabled | Boolean | The RemoveRepliesEnabled of the Cadence. |
RepliedStageId | Integer | The RepliedStageId of the Cadence. |
Shared | Boolean | The Shared of the Cadence. |
Tags | String | The Tags of the Cadence. |
TeamCadence | Boolean | The TeamCadence of the Cadence. |
UpdatedAt | Datetime | The UpdatedAt of the Cadence. |
PeopleAddable | Boolean | The PeopleAddable property of the Cadence table. |
OwnedByGuid | String | The OwnedByGuid property of the Cadence table. |
Returns multiple call data records. The records can be filtered, paged, and sorted according to the respective parameters. Call data records are records of all inbound and outbound calls through SalesLoft. A call data record may be associated with a call, but does not have to be.
Name | Type | Description |
Id [KEY] | Integer | The Id of the CallDataRecord. |
CallId | Integer | The CallId of the CallDataRecord. |
CallType | String | The CallType of the CallDataRecord. |
CallUuid | String | The CallUuid of the CallDataRecord. |
CalledPersonId | Integer | The CalledPersonId of the CallDataRecord. |
CreatedAt | Datetime | The CreatedAt of the CallDataRecord. |
Direction | String | The Direction of the CallDataRecord. |
Duration | Integer | The Duration of the CallDataRecord. |
From | String | The From of the CallDataRecord. |
RecordingStatus | String | The RecordingStatus of the CallDataRecord. |
RecordingUrl | String | The RecordingUrl of the CallDataRecord. |
Status | String | The Status of the CallDataRecord. |
To | String | The To of the CallDataRecord. |
UpdatedAt | Datetime | The UpdatedAt of the CallDataRecord. |
UserId | Integer | The UserId of the CallDataRecord. |
HasCall | Boolean | The HasCall property of the CallDataRecords table. |
UserGuid | String | The UserGuid property of the CallDataRecords table. |
Returns multiple call disposition records. The records can be sorted according to the respective parameters. Call dispositions must be configured in application. This will change in the future, but please contact us if you have a pressing use case.
Name | Type | Description |
Id [KEY] | Integer | The Id of the CallDisposition. |
CreatedAt | Datetime | The CreatedAt of the CallDisposition. |
Name | String | The Name of the CallDisposition. |
UpdatedAt | Datetime | The UpdatedAt of the CallDisposition. |
Returns each entry that is a possible caller ID match for the number. Multiple entries may be returned if the phone number is present on more than one person in the system. Phone number should be in E.164 format.
Name | Type | Description |
DisplayName | String | The DisplayName of the CallerID. |
Title | String | The Title of the CallerID. |
AccountName | String | The AccountName of the CallerID. |
PersonId | Integer | The PersonId of the CallerID. |
PhoneNumber | String | The PhoneNumber property of the CallerIDs table. This property is required in the Select statement. |
Returns multiple call sentiment records. The records can be sorted according to the respective parameters. Call sentiments must be configured in application. This will change in the future, but please contact us if you have a pressing use case.
Name | Type | Description |
Id [KEY] | Integer | The Id of the CallSentiment. |
CreatedAt | Datetime | The CreatedAt of the CallSentiment. |
Name | String | The Name of the CallSentiment. |
UpdatedAt | Datetime | The UpdatedAt of the CallSentiment. |
Enqueue a Conversations Call for processing.
Name | Type | Description |
To | String | The Phone number that was called. |
From | String | The Phone number that call was made from. |
Duration | Integer | The Duration of call in seconds. |
Recording | String | The Object containing recording info including the audio file (.mp3, .wav, .ogg, .m4a). |
CallCreatedAt | Datetime | The Timestamp for when the call started. If not provided, will default to the time the request was received. |
UserGuid | String | The Guid of the Salesloft User to assign the call to. If not provided, will default to the user within the authentication token. |
Direction | String | The Call direction. |
Returns multiple crm activity records. The records can be filtered, paged, and sorted according to the respective parameters.
Name | Type | Description |
Id [KEY] | Integer | The Id of the CRMActivity. |
CreatedAt | Datetime | The CreatedAt of the CRMActivity. |
UpdatedAt | Datetime | The UpdatedAt of the CRMActivity. |
Subject | String | The Subject of the CRMActivity. |
Description | String | The Description of the CRMActivity. |
CrmId | String | The CrmId of the CRMActivity. |
ActivityType | String | The ActivityType of the CRMActivity. |
CustomCrmFieldsAggr | String | The CustomCrmFieldsAggr of the CRMActivity. |
PersonId | Integer | The PersonId of the CRMActivity. |
UserId | Integer | The UserId of the CRMActivity. |
Returns multiple crm activity field records. The records can be filtered, paged, and sorted according to the respective parameters.
Name | Type | Description |
Id [KEY] | Integer | The Id of the CRMActivityField. |
CreatedAt | Datetime | The CreatedAt of the CRMActivityField. |
CrmObjectType | String | The CrmObjectType of the CRMActivityField. |
Field | String | The Field of the CRMActivityField. |
FieldType | String | The FieldType of the CRMActivityField. |
PicklistValuesHigh | String | The PicklistValuesHigh of the CRMActivityField. |
PicklistValuesLow | String | The PicklistValuesLow of the CRMActivityField. |
SalesforceObjectType | String | The SalesforceObjectType of the CRMActivityField. |
Source | String | The Source of the CRMActivityField. |
Title | String | The Title of the CRMActivityField. |
UpdatedAt | Datetime | The UpdatedAt of the CRMActivityField. |
Value | String | The Value of the CRMActivityField. |
Returns multiple crm user records.
Name | Type | Description |
Id [KEY] | Integer | The Id of the CRMUser. |
CrmId | String | The CrmId of the CRMUser. |
CreatedAt | Datetime | The CreatedAt of the CRMUser. |
UpdatedAt | Datetime | The UpdatedAt of the CRMUser. |
UserId | Integer | The UserId of the CRMUser. |
Returns multiple email records. The records can be filtered, paged, and sorted according to the respective parameters.
Name | Type | Description |
Id [KEY] | Integer | The Id of the Email. |
ActionId | Integer | The ActionId of the Email. |
Bounced | Boolean | The Bounced of the Email. |
CadenceId | Integer | The CadenceId of the Email. |
ClickTracking | Boolean | The ClickTracking of the Email. |
CountsAttachments | Integer | The CountsAttachments of the Email. |
CountsClicks | Integer | The CountsClicks of the Email. |
CountsReplies | Integer | The CountsReplies of the Email. |
CountsUniqueDevices | Integer | The CountsUniqueDevices of the Email. |
CountsUniqueLocations | Integer | The CountsUniqueLocations of the Email. |
CountsViews | Integer | The CountsViews of the Email. |
CreatedAt | Datetime | The CreatedAt of the Email. |
CrmActivityId | Integer | The CrmActivityId of the Email. |
HeadersBCC | String | The HeadersBCC of the Email. |
HeadersCC | String | The HeadersCC of the Email. |
MailingId | Integer | The MailingId of the Email. |
Personalization | String | The Personalization of the Email. |
RecipientId | Integer | The RecipientId of the Email. |
RecipientEmailAddress | String | The RecipientEmailAddress of the Email. |
SendAfter | Datetime | The SendAfter of the Email. |
SentAt | Datetime | The SentAt of the Email. |
Status | String | The Status of the Email. |
StepId | Integer | The StepId of the Email. |
UpdatedAt | Datetime | The UpdatedAt of the Email. |
UserId | Integer | The UserId of the Email. |
ViewTracking | Boolean | The ViewTracking of the Email. |
Returns multiple email template attachment records. The records can be filtered and paged according to the respective parameters.
Name | Type | Description |
Id [KEY] | Integer | The Id of the EmailTemplateAttachments. |
AttachmentId | Integer | The AttachmentId of the EmailTemplateAttachments. |
EmailTemplateId | Integer | The EmailTemplateId of the EmailTemplateAttachments. |
Name | String | The Name of the EmailTemplateAttachments. |
DownloadURL | String | The DownloadURL of the EmailTemplateAttachments. |
AttachmentFileSize | Integer | The AttachmentFileSize of the EmailTemplateAttachments. |
Returns multiple email template records. The records can be filtered, paged, and sorted according to the respective parameters.
Name | Type | Description |
Id [KEY] | Integer | The Id of the EmailTemplate. |
LinksAttachments | String | The LinksAttachments of the EmailTemplate. |
ArchivedAt | Datetime | The ArchivedAt of the EmailTemplate. |
Body | String | The Body of the EmailTemplate. |
BodyPreview | String | The BodyPreview of the EmailTemplate. |
CadenceTemplate | Boolean | The CadenceTemplate of the EmailTemplate. |
ClickTrackingEnabled | Boolean | The ClickTrackingEnabled of the EmailTemplate. |
CountsBounces | Integer | The CountsBounces of the EmailTemplate. |
CountsClicks | Integer | The CountsClicks of the EmailTemplate. |
CountsReplies | Integer | The CountsReplies of the EmailTemplate. |
CountsSentEmails | Integer | The CountsSentEmails of the EmailTemplate. |
CountsViews | Integer | The CountsViews of the EmailTemplate. |
CreatedAt | Datetime | The CreatedAt of the EmailTemplate. |
GroupsId | Integer | The GroupsId of the EmailTemplate. |
LastUsedAt | Datetime | The LastUsedAt of the EmailTemplate. |
OpenTrackingEnabled | Boolean | The OpenTrackingEnabled of the EmailTemplate. |
Shared | Boolean | The Shared of the EmailTemplate. |
Subject | String | The Subject of the EmailTemplate. |
Tags | String | The Tags of the EmailTemplate. |
TeamTemplateId | String | The TeamTemplateId of the EmailTemplate. |
TemplateOwnerId | Integer | The TemplateOwnerId of the EmailTemplate. |
Title | String | The Title of the EmailTemplate. |
UpdatedAt | Datetime | The UpdatedAt of the EmailTemplate. |
LinkedToTeamTemplate | Boolean | The LinkedToTeamTemplate property of the EmailTemplates table. |
TagIDs | String | The TagIDs property of the EmailTemplates table. |
Search | String | The Search property of the EmailTemplates table. |
FilterByOwner | Boolean | The FilterByOwner property of the EmailTemplates table. |
IncludeCadenceTemplates | Boolean | The IncludeCadenceTemplates property of the EmailTemplates table. |
IncludeArchivedTemplates | Boolean | The IncludeArchivedTemplates property of the EmailTemplates table. |
Returns multiple group records. The records can be filtered, and sorted according to the respective parameters.
Name | Type | Description |
Id [KEY] | Integer | The Id of the Group. |
Name | String | The Name of the Group. |
ParentId | Integer | The ParentId of the Group. |
Returns the MIME content for email.
Name | Type | Description |
Id [KEY] | Integer | The Id of the MIMEEmailPeyload. |
MailBox | String | The MailBox of the MIMEEmailPeyload. |
MessageId | String | The MessageId of the MIMEEmailPeyload. |
Raw | String | The Raw of the MIMEEmailPeyload. |
Fetches multiple phone number assignment records. The records can be filtered, paged, and sorted according to the respective parameters.
Name | Type | Description |
Id [KEY] | Integer | PhoneNumberAssignment ID. |
Number | String | The phone number associated with this assignment. |
User | String | User associated with this phone number assignment. |
Fetches the recording status for a given phone number, based on Do Not Record and Recording Governance for your team. Phone number should be in E.164 format.
Name | Type | Description |
Id [KEY] | String | The id of the RecordingSettings. E.164 Phone Number. |
recording_default | Boolean | Whether this phone number should record by default. |
Fetches multiple custom role records. The records can be filtered, and sorted according to the respective parameters. A custom role is any role that is not Admin or User.
Name | Type | Description |
Id [KEY] | Integer | ID of the custom role. |
Name | String | Name of the custom role. |
Returns multiple step records. The records can be filtered, paged, and sorted according to the respective parameters.
Name | Type | Description |
Id [KEY] | Integer | The Id of the Stage. |
CadenceId | Integer | The CadenceId of the Stage. |
CreatedAt | Datetime | The CreatedAt date of the Stage. |
Day | Integer | The Day of the Stage. |
DetailsId | Integer | The DetailsId of the Stage. |
Disabled | Boolean | The Disabled of the Stage. |
DisplayName | String | The DisplayName of the Stage. |
StepNumber | Integer | The StepNumber of the Stage. |
Type | String | The Type of the Stage. |
UpdatedAt | Datetime | The UpdatedAt date of the Stage. |
HasDueActions | Boolean | The HasDueActions property of the Steps table. |
Returns multiple success records. The records can be filtered, paged, and sorted according to the respective parameters.
Name | Type | Description |
Id [KEY] | Integer | The Id of the Success. |
TotalCalls | Integer | The TotalCalls of the Success. |
TotalEmails | Integer | The TotalEmails of the Success. |
TotalOtherTouches | Integer | The TotalOtherTouches of the Success. |
CreatedAt | Datetime | The CreatedAt of the Success. |
LatestActionId | Integer | The LatestActionId of the Success. |
LatestCadenceId | Integer | The LatestCadenceId of the Success. |
LatestCallId | Integer | The LatestCallId of the Success. |
LatestEmailId | Integer | The LatestEmailId of the Success. |
PersonId | Integer | The PersonId of the Success. |
SucceededAt | Datetime | The SucceededAt of the Success. |
SuccessWindowStartedAt | Datetime | The SuccessWindowStartedAt of the Success. |
UpdatedAt | Datetime | The UpdatedAt of the Success. |
UserId | Integer | The UserId of the Success. |
Fetches a list of the tags used for a team. The records can be filtered, paged, and sorted according to the respective parameters. Tags can be applied to multiple resource types.
Name | Type | Description |
Id [KEY] | Integer | The Id of the Tag. |
Name | String | The Name of the Tag. |
Returns the team of the authenticated user.
Name | Type | Description |
Id [KEY] | Integer | The Id of the Team. |
AllowAutomatedEmailSteps | Boolean | The AllowAutomatedEmailSteps setting of the Team. |
CallRecordingDisabled | Boolean | The CallRecordingDisabled setting of the Team. |
ClickTrackingDefault | Boolean | The ClickTrackingDefault setting of the Team. |
CreatedAt | Datetime | The CreatedAt date of the Team. |
CustomTrackingDomain | String | The CustomTrackingDomain setting of the Team. |
DispositionsRequired | Boolean | The DispositionsRequired setting of the Team. |
EmailDailyLimit | Integer | The EmailDailyLimit setting of the Team. |
GroupPrivacySetting | String | The GroupPrivacySetting setting of the Team. |
LicenseLimit | Integer | The LicenseLimit setting of the Team. |
LocalDialEnabled | Boolean | The LocalDialEnabled setting of the Team. |
Name | String | The Name of the Team. |
Plan | String | The Plan of the Team. |
OpportunityManagement | String | The OpportunityManagement setting of the Team. |
RecordByDefault | Boolean | The RecordByDefault setting of the Team. |
SentimentsRequired | Boolean | The SentimentsRequired setting of the Team. |
TeamVisibilityDefault | String | The TeamVisibilityDefault setting of the Team. |
UpdatedAt | Datetime | The UpdatedAt date of the Team. |
Returns multiple team template attachment records. The records can be filtered and paged according to the respective parameters.
Name | Type | Description |
Id [KEY] | Integer | The Id of the Team Template Attachments. |
AttachmentFileSize | Integer | The Attachment File Size of a Team Template Attachments. |
AttachmentId | Integer | The AttachmentId of a Team Template Attachments. |
DownloadUrl | String | The DownloadUrl of a Team Template Attachments. |
Name | String | The Name of a Team Template Attachments. |
TeamTemplateId | Integer | The Team Template Id of a Team Template Attachments. |
Fetches multiple team template records. The records can be filtered, paged, and sorted according to the respective parameters. Team templates are templates that are available team-wide. Admins may use team templates to create original content for the entire team, monitor version control to ensure templates are always up to date, and track template performance across the entire organization. All metrics on a team template reflect usage across the team; individual metrics can be found with the email_templates API endpoint.
Name | Type | Description |
Id [KEY] | String | The Id of the AccountStage. |
Attachments | String | The Attachments of the TeamTemplate. |
ArchivedAt | Datetime | The ArchivedAt of the TeamTemplate. |
Body | String | The Body of the TeamTemplate. |
BodyPreview | String | The BodyPreview of the TeamTemplate. |
ClickTrackingEnabled | Boolean | The ClickTrackingEnabled of the TeamTemplate. |
Bounces | Integer | The Bounces of the TeamTemplate. |
Clicks | Integer | The Clicks of the TeamTemplate. |
Replies | Integer | The Replies of the TeamTemplate. |
SentEmails | Integer | The SentEmails of the TeamTemplate. |
Views | Integer | The Views of the TeamTemplate. |
CreatedAt | Datetime | The CreatedAt of the TeamTemplate. |
LastModifiedAt | Datetime | The LastModifiedAt of the TeamTemplate. |
LastModifiedUserId | Integer | The LastModifiedUserId of the TeamTemplate. |
LastUsedAt | Datetime | The LastUsedAt of the TeamTemplate. |
OpenTrackingEnabled | Boolean | The OpenTrackingEnabled of the TeamTemplate. |
Subject | String | The Subject of the TeamTemplate. |
Tags | String | The Tags of the TeamTemplate. |
Title | String | The Title of the TeamTemplate. |
UpdatedAt | Datetime | The UpdatedAt date of the TeamTemplate. |
TagId | Integer | The TagId property of the TeamTemplate table. |
IncludeArchivedTemplates | Boolean | The IncludeArchivedTemplates property of the TeamTemplate table. |
Search | String | The Search property of the TeamTemplate table. |
Returns Non Admin: Lists only your user, or all on team depending on group visibility policy Team Admin: Lists users associated with your team.
Name | Type | Description |
Id [KEY] | Integer | The Id of the User. |
Active | Boolean | The Active property of the User. |
BCCEmailAddress | String | The BCCEmailAddress property of the User. |
ClickToCallEnabled | Boolean | The ClickToCallEnabled property of the User. |
CreatedAt | Datetime | The CreatedAt property of the User. |
CrmConnected | Boolean | The CrmConnected property of the User. |
String | The Email property of the User. | |
EmailClientConfigured | Boolean | The EmailClientConfigured property of the User. |
EmailClientEmailAddress | String | The EmailClientConfigured property of the User. |
EmailSignature | String | The EmailSignature property of the User. |
EmailSignatureClickTrackingDisabled | Boolean | The EmailSignatureClickTrackingDisabled property of the User. |
EmailSignatureType | String | The EmailSignatureType property of the User. |
FirstName | String | The FirstName property of the User. |
FromAddress | String | The FromAddress property of the User. |
FullEmailAddress | String | The FullEmailAddress property of the User. |
GroupId | Integer | The GroupId property of the User. |
Guid | String | The Guid of the User. |
JobRole | String | The JobRole property of the User. |
LastName | String | The LastName property of the User. |
LocalDialEnabled | Boolean | The LocalDialEnabled property of the User. |
Name | String | The Name of the User. |
PhoneClientId | Integer | The PhoneClientId property of the User. |
PhoneNumberAssignmentId | Integer | The PhoneNumberAssignmentId property of the User. |
RoleId | String | The RoleId property of the User. |
SendingEmailAddress | String | The SendingEmailAddress property of the User. |
SlackUsername | String | The SlackUsername property of the User. |
TeamId | Integer | The TeamId property of the User. |
TeamAdmin | Boolean | The TeamAdmin property of the User. |
TimeZone | String | The TimeZone of the User. |
TwitterHandle | String | The TwitterHandle of the User. |
UpdatedAt | Datetime | The UpdatedAt date of the User. |
Search | String | The Search property of the Users table. |
VisibleOnly | Boolean | The VisibleOnly property of the Users table. |
プロパティ | 説明 |
AuthScheme | Whether to use APIKey Authentication or OAuth Authentication when connecting to SalesLoft |
APIKey | The API key used for accessing your SalesLoft account. |
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
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 です。 |
プロパティ | 説明 |
IncludeFiltersAsViews | Set this to true if you want to expose filters for the modules as views.(Also konwn as Saved List Views) |
ImpersonatedUserId | User Impersonation allows Administrators to access and operate as if they were logged in as that User. The ImpersonatedUserId property defines the Id of the user you are trying to impersonate. The impact this has in the system is the value of the ownerId send in the insert/update statements as well as in Filters Views where the filter contains OwnerId or OwnerGUID. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
AuthScheme | Whether to use APIKey Authentication or OAuth Authentication when connecting to SalesLoft |
APIKey | The API key used for accessing your SalesLoft account. |
Whether to use APIKey Authentication or OAuth Authentication when connecting to SalesLoft
The API key used for accessing your SalesLoft account.
The API key used for accessing your SalesLoft account.
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能な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 はSalesloft への接続を開き、プロキシを経由して通信が行われます。 |
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 | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するには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\\SalesLoft Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます:
Platform | %APPDATA% |
Windows | APPDATA 環境変数の値 |
Linux | ~/.config |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、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 プロパティの全リストを提供します。
プロパティ | 説明 |
IncludeFiltersAsViews | Set this to true if you want to expose filters for the modules as views.(Also konwn as Saved List Views) |
ImpersonatedUserId | User Impersonation allows Administrators to access and operate as if they were logged in as that User. The ImpersonatedUserId property defines the Id of the user you are trying to impersonate. The impact this has in the system is the value of the ownerId send in the insert/update statements as well as in Filters Views where the filter contains OwnerId or OwnerGUID. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
Set this to true if you want to expose filters for the modules as views.(Also konwn as Saved List Views)
You can query the filtered modules like you would query the views:
SELECT * FROM [Filter_People_CadenceTest]
where "People" is the name of the module and "CadenceTest" is the name of the filter applied to that module.
User Impersonation allows Administrators to access and operate as if they were logged in as that User. The ImpersonatedUserId property defines the Id of the user you are trying to impersonate. The impact this has in the system is the value of the ownerId send in the insert/update statements as well as in Filters Views where the filter contains OwnerId or OwnerGUID.
User Impersonation allows Administrators to access and operate as if they were logged in as that User. The ImpersonatedUserId property defines the Id of the user you are trying to impersonate. The impact this has in the system is the value of the ownerId send in the insert/update statements as well as in Filters Views where the filter contains OwnerId or OwnerGUID.
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
カスタムビューを含む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指定されたパスは引用符で囲まれていないことに注意してください。