FireDAC Components for Basecamp

Build 20.0.7587

CalendarEvents

Retrieve calendar events on Basecamp 3.

Table Specific Information

You can query Calendar Events in the specified project.

Select

The following columns are supported as search criteria by Basecamp:

  • ProjectId
  • CalendarId
  • Status (by default only active events are retrieved)

If ProjectId is not specified in the query, the default ProjectId will be used.

SELECT * FROM CalendarEvents WHERE ProjectId = '11111111' AND CalendarId = '22222222' AND Status = 'active'

You can also retrieve a single calendar event by specifying the Id.

SELECT * FROM CalendarEvents WHERE  ProjectId = '11111111' AND Id = '33333333'

Insert

You can insert a new Calendar Event by providing the ProjectId, CalendarId, StartsAt, EndsAt, and Summary as required parameters.

INSERT INTO CalendarEvents (ProjectId, CalendarId, Summary, StartsAt, EndsAt, Description, Notify, ParticipantsIds ) VALUES ( '1111111', '2222222', 'summary test', '2017-11-11 09:00Z', '2017-11-11 11:00Z', 'description', 'false', '3333333, 4444444')

Update

You can also change the Calendar Event by providing the ProjectId and event Id.

UPDATE CalendarEvents SET Summary = 'Updated summary',  StartsAt =  '2017-11-12', EndsAt = '2017-11-12', AllDay = 'true' WHERE ProjectId = '11111111' AND Id = '1234567689'

Delete

Calendar Events cannot be deleted.

Columns

Name Type ReadOnly References Description
Id [KEY] Long True

The unique identifier of the calendar event.

ProjectId Long True

Projects.Id

The Project Id associated with the schedule.

CalendarId Long True

Projects.CalendarId

The Calendar Id that the event belongs to.

Status String True

The status of the calendar event.

Type String True

The type of the returned record.

CreatedAt Datetime True

The date and time when the calendar event was created.

UpdatedAt Datetime True

The date and time when the calendar event was last updated.

Description String False

Provided description for the calendar event.

AllDay Boolean False

Indicates that the event is an all day event.

StartsAt Datetime False

The date and time when the calendar event starts.

EndsAt Datetime False

The date and time when the calendar event ends.

Summary String False

Provided summary for the calendar event.

ParticipantsIds String False

A list of comma separated participant ids.

ParticipantsNames String True

A list of comma separated participant names.

ParentTitle String True

Title of the parent.

ParentType String True

Type of the parent.

BucketName String True

Name of the containing bucket.

BucketType String True

Type of the containing bucket.

CreatorId Long True

People.Id

The Id of the creator.

CreatorName String True

The name of the creator.

CommentsCount Integer True

Number of comments the document has.

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
Notify String

When set to true, will notify the participants about the event.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587