Documents
Retrieve, create, update, and delete Documents on Basecamp 3.
Table Specific Information
Select
You can retrieve all documents belonging to a certain Project and Vault only, or specify a Project and a certain Document at the same time (ProjectId, VaultId and Id are the only columns supported as search criteria by Basecamp).
If ProjectId is not specified in the query, the default ProjectId will be used.
SELECT * FROM Documents WHERE ProjectId = '11111111' AND VaultId = '222222222' SELECT * FROM Documents WHERE ProjectId = '11111111' AND Id = '1234567689'
Insert
To add a new document to a major project, you need to specify the ProjectId, Vaultid, Title, Content, and Status (optional).
INSERT INTO Documents (ProjectId, Vaultid, Title, Content, Status) VALUES ('11111111', '222222222', 'Memo', 'This is our document content', 'active')
Update
Specify the ProjectId and the document Id to update a document.
UPDATE Documents SET Title = 'Updated Memo3', Content = 'Updated Content of Memo.' WHERE ProjectId = '11111111' AND Id = '1234567689'
Delete
DELETE is not supported for this table.
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | Long | True |
The unique identifier for the document. | |
ProjectId | Long | True |
Projects.Id |
The Id of the Project associated with the document. |
VaultId | Long | True |
Vaults.Id |
The Vault Id associated with the document. |
Status | String | False |
The status of the vault. | |
Title | String | False |
The title of the document. | |
Content | String | False |
The content of the Document | |
Type | String | True |
The type of the returned record. | |
CreatedAt | Datetime | True |
The date and time when the document was created. | |
UpdatedAt | Datetime | True |
The date and time when the document was last updated. | |
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. |