FireDAC Components for Basecamp

Build 20.0.7587

Documents

Retrieve, create, update, and delete Documents on Basecamp.

Table Specific Information

Select

You can retrieve all Documents (for all Projects), select Documents belonging to a certain Project only, or specify a Project and a certain Document at the same time (ProjectId and Id are the only columns supported as search criteria by Basecamp).

You can also sort Documents by UpdatedAt, CreatedAt, or Title.

SELECT * FROM Documents WHERE ProjectId = '11111111' AND Id = '1234567689'

SELECT * FROM Documents ORDER BY UpdatedAt

SELECT * FROM Documents ORDER BY Title DESC

Insert

To add a new Document to a major Project, specify the ProjectId and provide the Document's title or some Content.

INSERT INTO Documents (ProjectId, Title, Content) VALUES ('11111111', 'Memo', 'This is our document content')

Update and Delete

Specify the ProjectId and the Document Id to update or delete a Document.

UPDATE Documents SET Title = 'Updated Memo3', Content = 'Updated Content of Memo.' WHERE ProjectId = '11111111' AND Id = '1234567689'

DELETE FROM Documents WHERE ProjectId = '11111111' AND Id = '12345678'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The unique identifier for the document.

AppUrl String True

The app URL.

BucketAppUrl String True

The topic bucket app url.

BucketColor String True

The to-do bucket color.

BucketId String True

The to-do bucket Id.

BucketName String True

The to-do bucket name.

BucketType String True

The to-do bucket type.

BucketUrl String True

The to-do bucket URL.

Content String False

The content of the document.

CreatedAt Datetime True

The date and time when the document was created.

CreatorAvatarUrl String False

Creator Avatar URL.

CreatorFullsizeAvatarUrl String False

Creator full-size avatar URL.

CreatorId String False

The Id of the creator of the document.

CreatorName String False

The name of the creator of the document.

LastUpdaterId String False

The Id of the person who last updated the document.

LastUpdaterName String False

The name of the person who last updated the document.

Private Boolean False

Whether this to-do is private.

SubscribersId String False

The Id of the subscriber to the document.

SubscribersName String False

The name of the subscriber to the document.

Title String False

The title of the document.

Trashed Boolean False

Boolean value for deleted to-dos.

UpdatedAt Datetime True

The date and time when the document was last updated.

URL String True

The URL of the document.

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

The Id of the Project associated with the document.

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