Events
Retrieves all events associated with a specific project.
Select
- Id supports '=' operator
- Location supports '=,!=,CONTAINS' operators
- Status supports '=' operator
- Ids supports '=' operator
For example, the following query is processed server side:
SELECT * FROM Events WHERE Status = 'open'
Insert
To create a new Event you can specify the following fields:
- Title
- Location
- StartsAt
- EndsAt
- Attendees
- RemindBefore
- RecurrenceCount
- RecurrenceFrequency
- AttachmentIds
- ThirdpartyId
INSERT INTO Events (Title, StartsAt, EndsAt, Attendees, Location)
VALUES ('SQL Event #2', '2026-08-20T13:15:00.000-04:00', '2026-08-20T14:15:00.000-04:00', '[460276000000076012]', 'Test Location')
Update
To update an Event specify the Id field.
UPDATE Events SET title = 'Updated Title #1', Location = 'Test Location 3' WHERE Id = '123456000000045018'
Delete
Events can be deleted by providing the Id and issuing a DELETE statement.
DELETE FROM Events WHERE Id = '123456000000045018'
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | Long | True |
Event Id. |
| Title | String | False |
Event Title. |
| Location | String | False |
Event Location. |
| StartsAt | Datetime | False |
Event Start Time (ISO-8601). |
| EndsAt | Datetime | False |
Event End Time (ISO-8601). |
| Attendees | String | False |
Event Attendees. |
| RemindBefore | String | False |
Event Reminder. The allowed values are on time, 15 mins, 30 mins, 1 hour, 2 hours, 6 hours, 12 hours, 1 day. |
| CreatedOn | Datetime | True |
Event Created On Time. |
| CreatedById | Long | True |
Event Created By Id. |
| CreatedByFirstName | String | True |
Event Created By First Name. |
| CreatedByLastName | String | True |
Event Created By Last Name. |
| CreatedByName | String | True |
Event Created By Name. |
| CreatedByFullName | String | True |
Event Created By Name. |
| CreatedByEmail | String | True |
Event Created By Email. |
| CreatedByRole | String | True |
Event Created By role. |
| CreatedByRoleId | Long | True |
Event Created By role id. |
| CreatedByZuid | Long | True |
Event Created By Zuid. |
| CreatedByZpuid | Long | True |
Event Created By Zpuid. |
| CreatedByIsClientUser | Boolean | True |
Event Created By Is Client User. |
| CreatedByIsNotificationMuted | Boolean | True |
Event Created By Is Notification Muted. |
| CreatedByUserType | Integer | True |
Event Created By User Type. |
| CreatedByInvoiceRate | Double | True |
Event Created By Invoice Rate. |
| Duration | String | True |
Event duration. |
| DurationDays | Integer | True |
Event duration days. |
| DurationMilli | Long | True |
Event duration in milliseconds. |
| DurationHours | Integer | True |
Event duration hours. |
| DurationMinutes | Integer | True |
Event duration minutes. |
| ProjectId | Long | True |
Event Project Id. |
| AddToOffice365 | Boolean | True |
Event Add To Office365. |
| AddEventToO365 | Boolean | True |
Event Add Event To O365. |
| CommentMailId | String | True |
Event Comment Mail Id. |
| IsOpen | Boolean | True |
Event Is Open. |
| RecurrenceCount | Integer | False |
Event Recurrence Count. |
| RecurrenceFrequency | String | False |
Event Recurrence Frequency. The allowed values are only once, every day, every week, every month, every year. |
| RecurrenceName | String | True |
Event Recurrence Name. |
| RecurrenceType | String | True |
Event Recurrence Type. |
| UpdatedOn | Datetime | True |
Event Updated On time. |
| UpdatedById | Long | True |
Event Updated By Id. |
| UpdatedByFirstName | String | True |
Event Updated By First Name. |
| UpdatedByLastName | String | True |
Event Updated By Last Name. |
| UpdatedByName | String | True |
Event Updated By Name. |
| UpdatedByFullName | String | True |
Event Updated By Full Name. |
| UpdatedByEmail | String | True |
Event Updated By Email. |
| UpdatedByRole | String | True |
Event Updated By role. |
| UpdatedByRoleId | Long | True |
Event Updated By role id. |
| UpdatedByZuid | Long | True |
Event Updated By Zuid. |
| UpdatedByZpuid | Long | True |
Event Updated By Zpuid. |
| UpdatedByIsNotificationMuted | Boolean | True |
Event Updated By Is Notification Muted. |
| UpdatedByIsClientUser | Boolean | True |
Event Updated By Is Client User. |
| UpdatedByUserType | Integer | True |
Event Updated By User type. |
| UpdatedByInvoiceRate | Double | True |
Event Updated By Invoice Rate. |
| AddedVia | String | True |
Source of event creation. |
| Status | String | True |
Event Status. The allowed values are open, completed. |
| Ids | String | True |
Comma separated IDs of the specific events to retrieve. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| AttachmentIds | String |
Array of the IDs of attachments to include with this event. |
| ThirdpartyId | String |
Array of the WorkDrive resource IDs of the files to associate. |