1. API
  2. REST API
  3. REST API Endpoint Reference
  4. Attachments

Attachments

Attachments are files uploaded and stored in SuiteProjects Pro and associated with records. Each attachment include the attachment file as well as file metadata.

Available methods

None — To work with attachments, use the endpoints and methods specific to the object the attachments are associated with.

Attachment object properties

An attachment is a file uploaded and stored in SuiteProjects Pro and associated with a record. Each attachment includes file metadata as well as the file itself. The Attachment object includes the file metadata.

The Attachment object has the following properties:

Property

Description

Type

Read-only

Query allowed

Sorting allowed

attachmentCategoryId

The internal ID of the attachment category.

integer($int64)

—

Yes

Yes

created

The date the attachment was created.

string($date-time)

Yes

Yes

—

fileName

The filename of the attached file.

string

—

Yes

Yes

fileType

The file type. This is used for tracking purposes.

string

Yes

Yes

—

hasThumbnail

A 1/0 field indicating if a thumbnail image is available for the attachment. Returned only if the Attachment Thumbnail and Attachment Viewer feature is enabled for your SuiteProjects Pro account.

string

Yes

Yes

—

id

The unique internal identifier of the attachment.

integer($int64)

Yes

Yes

Yes

isExcludedFromAlert

A 1/0 field indicating if the attachment is excluded from the alert system.

Boolean

—

Yes

—

isFolder

A 1/0 field indicating if other attachment records have this attachment record as a parent.

Boolean

—

Yes

—

isLocked

A 1/0 field indicating if the attachment is locked for editing.

Boolean

—

Yes

—

isViewable

A 1/0 field indicating if the attachment is viewable using the Attachment Viewer feature. Returned only if the Attachment Thumbnail and Attachment Viewer feature is enabled for your SuiteProjects Pro account.

Boolean

Yes

Yes

—

lockedBy

The internal ID of the employee who uploaded the file. The value is 0 (zero) if unlocked.

integer($int64)

—

Yes

—

name

The display name of the attachment.

string

—

Yes

Yes

notes

Notes about the attachment. This attribute is used for keyword search.

string

—

Yes

—

size

The file size in bytes.

number($float)

Yes

Yes

—

updated

The date the attachment was last updated or modified.

string($date-time)

Yes

Yes

Yes

uploadedBy

The internal ID of the employee who uploaded the file.

integer($int64)

Yes

Yes

—

workspaceId

The internal ID of the workspace associated with the attachment. The value is 0 (zero) if the attachment is not associated with a workspace.

integer($int64)

Yes

Yes

—
Note:

Access to certain object types and object attributes depend on the business logic configured for your SuiteProjects Pro account. It may vary depending on the role and access privileges associated with the access token and with the user who authorized the application.

Required and read-only attributes also depend on the business logic configured for each specific SuiteProjects Pro account. Some fields such as id, created, and updated are system-generated and always read-only.