JDBC Driver for SuiteCRM

Build 22.0.8462

Documents

Create, update, delete, and query SuiteCRM documents

Table Specific Information

Select

You can query the Documents table using any criteria in the WHERE clause. The driver will use the SuiteCRM API to filter the results.

SELECT * FROM Documents WHERE [Document Name] LIKE '%.txt' 

Insert

Create a Document by specifying any writable column.

INSERT INTO Documents (Name,[Document Source URL]) VALUES ('New Document','http://fileorigin.com/testfile.txt')

Update

You can update any Document column that is writable, by specifying the Id.

UPDATE Documents SET [Status Id] = 'Expired' WHERE Id = 'Test123' 

Delete

Delete a Document by specifying the Id.

DELETE FROM Documents WHERE Id = '10003'

Columns

Name Type ReadOnly Description
ID [KEY] String False

The unique identifier for the record.

Assignedto String True

The user name of the user assigned to the record.

AssignedUserId String False

The Id of the user assigned to the record.

Category String False

The Id for the category of the document.

Contractname String True

The name of the document's contract

Contractstatus String True

The document's contract status.

CreatedById String True

The Id of the user who created the record.

CreatedByName String True

The user name of the user who created the record.

DateCreated Datetime True

The date the record was created.

DateModified Datetime True

The date the record was last modified.

Deleted Bool False

Record deletion indicator.

Description String False

The full text of the note.

DocumentName String False

The document name.

DocumentRevisionId String False

The Id of the document revision.

DocumentSourceID String False

The document Id from the Web service provider for the document.

DocumentSourceURL String False

The document URL from the Web service provider for the document.

DocumentType String False

The template type of the document.

ExpirationDate Date False

The date the document expires.

FileName String True

The file name of the document attachment.

IsaTemplate Bool False

Whether the document is a template.

LastRevisionCreateDate Date True

The date the last revision was created.

LastrevisionMIMEtype String True

The MIME type of the last revision.

Lastestrevisionname String True

The name of the latest revision.

LatestRevision String True

The latest revision.

LatestRevisionId String True

The Id of the latest revision.

Linkedid String True

The Id of the linked record.

ModifiedById String True

The Id of the user who last modified the record.

ModifiedByName String True

The user name of the user who last modified the record.

Name String True

The name of the document.

PublishDate Date False

The date the document is active.

RelatedDocument String True

The related document name.

RelatedDocumentID String False

The Id of the related document.

RelatedDocumentRevision String True

The related document version number.

RelatedDocumentRevisionID String False

The Id of the related document revision.

Revision String True

The revision number.

RevisionCreatedBy String True

The name of the user who created the last revision.

Selectedrevisionfilename String True

The filename of the selected revision.

Selectedrevisionid String True

The Id of the selected revision.

Selectedrevisionname String True

The name of the selected revision.

Source String False

The document type (e.g., Google, box.net, or IBM SmartCloud).

Status String True

The document status.

StatusId String False

The Id of the document status.

SubCategory String False

The Id of the subcategory 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
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

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