JDBC Driver for Pipedrive

Build 22.0.8462

Activities

Get all Activities assigned to a particular User.

Select

The driver will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the driver.

  • Id supports the '=' operator.
  • Done supports the '=' operator.
  • Type supports the '=, IN' operators.
  • UserId supports the '=' operator.
  • FilterId supports the '=' operator.
  • StartDate supports the '=' operator.
  • EndDate supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM Activities WHERE Id = 246

SELECT * FROM Activities WHERE Done = 0

SELECT * FROM  Activities WHERE Type IN ('deadline','call')

SELECT * FROM  Activities WHERE EndDate = '2021-12-24'
 
SELECT * FROM  Activities WHERE UserId = 8230170

INSERT

The columns that are not read-only can be inserted. Following is an example of how to insert into this table.

INSERT INTO ActivitiesAttendees#TEMP (EmailAddress) VALUES ('[email protected]')
INSERT INTO Activities (DueDate,DueTime,Duration,Dealid,Attendees) VALUES ('1994-10-12','10:20','02:00',1,'ActivitiesAttendees#TEMP')

UPDATE

Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE Activities SET DealId = 2 WHERE Id = 245

DELETE

Delete can be executed by specifying the Id in the WHERE Clause. For example:

DELETE FROM Activities WHERE Id = 246

Columns

Name Type ReadOnly Description
Id [KEY] Integer True

Activity Id.

ActiveFlag Boolean True

ActiveFlag.

AddTime Datetime True

AddTime.

AssignedToUserId Integer True

AssignedToUserId.

Attendees String False

Attendees of the Activity This can be either your existing Pipedrive contacts or an external email address.

BusyFlag Boolean True

Set the Activity as Busy or Free.

The allowed values are true, false.

The default value is true.

CalendarSync String True

CalendarSync.

CompanyId Integer True

CompanyId.

MeetingClient String True

MeetingClient.

MeetingId String True

MeetingId.

MeetingUrl String True

MeetingUrl.

CreatedByUserId Integer True

CreatedByUserId.

DealDropboxBcc String True

DealDropboxBcc.

DealId Integer False

The ID of the Deal this Activity is associated with.

DealTitle String True

DealTitle.

Done Boolean True

Whether the Activity is done or not 0 = Not done 1 = Done If omitted returns both Done and Not done activities.

The allowed values are 0, 1.

DueDate Date False

Due date of the Activity Format YYYY-MM-DD

DueTime Time False

Due time of the Activity in UTC Format HH:MM

Duration Time True

Duration of the Activity Format HH:MM

FileCleanName String True

FileCleanName.

FileId String True

FileId.

FileUrl String True

FileUrl.

GcalEventId String True

GcalEventId.

GoogleCalendarEtag String True

GoogleCalendarEtag.

GoogleCalendarId String True

GoogleCalendarId.

LastNotificationTime Datetime True

LastNotificationTime.

LastNotificationUserId Integer True

LastNotificationUserId.

LeadId String True

LeadId.

Location String False

The address of the Activity.

AdminAreaLevel1 String True

AdminAreaLevel1.

AdminAreaLevel2 String True

AdminAreaLevel2.

LocationCountry String True

LocationCountry.

FormattedAddress String True

FormattedAddress.

LocationLat Double True

LocationLat.

LocationLocality String True

LocationLocality.

LocationLong Double True

LocationLong.

PostalCode String True

PostalCode.

LocationRoute String True

LocationRoute.

StreetNumber String True

StreetNumber.

Sublocality String True

Sublocality.

Subpremise String True

Subpremise.

MarkedAsDoneTime Datetime True

MarkedAsDoneTime.

Note Html False

Note of the Activity HTML format.

NotificationLanguageId Integer True

NotificationLanguageId.

OrgId Integer False

The ID of the Organization this Activity is associated with.

OrgName String True

OrgName.

OwnerName String True

OwnerName.

Participants String False

List of multiple Persons participants this Activity is associated with If omitted single participant from person_id field is used.

PersonDropboxBcc String True

PersonDropboxBcc.

PersonId Integer False

The ID of the Person this Activity is associated with.

PersonName String True

PersonName.

PublicDescription String False

Additional details about the Activity that is synced to your external calendar Unlike the note added to the Activity the description is publicly visible to any guests added to the Activity.

RecMasterActivityId String True

RecMasterActivityId.

RecRule String True

RecRule.

RecRuleExtension String True

RecRuleExtension.

ReferenceId Integer True

ReferenceId.

ReferenceType String True

ReferenceType.

Series String True

Series.

SourceTimezone String True

SourceTimezone.

Subject String False

Subject of the Activity.

The default value is Call.

Type String True

Type of the Activity This is in correlation with the key_string parameter of ActivityTypes When value for type is not set, it will be given a default value Call.

The default value is Call.

UpdateTime Datetime True

UpdateTime.

UpdateUserId Integer True

The ID of the User whose Activities will be fetched If omitted the User associated with the API token will be used If 0 Activities for all company Users will be fetched based on the permission sets.

UserId Integer False

UserId.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
FilterId Integer

The ID of the Filter to use.

StartDate String

Use the Activity due date where you wish to begin fetching Activities from Insert due date in YYYY-MM-DD format.

EndDate String

Use the Activity due date where you wish to stop fetching Activities from Insert due date in YYYY-MM-DD format.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462