| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id |
string | ✔️ | A unique identifier for an object. | 12345 |
downstreamId |
?string | ➖ | The third-party API ID of original entity | 12345 |
name |
string | ✔️ | The name of the file | sample.jpg |
description |
?string | ➖ | Optional description of the file | A sample image |
type |
Components\FileType | ✔️ | The type of resource. Could be file, folder or url | file |
path |
?string | ➖ | The full path of the file or folder (includes the file name) | /Documents/sample.jpg |
mimeType |
?string | ➖ | The MIME type of the file. | image/jpeg |
downloadable |
?bool | ➖ | Whether the current user can download this file | |
size |
?int | ➖ | The size of the file in bytes | 1810673 |
owner |
?Components\Owner | ➖ | N/A | |
parentFolders |
array<Components\LinkedFolder> | ➖ | The parent folders of the file, starting from the root | |
parentFoldersComplete |
?bool | ➖ | Whether the list of parent folders is complete. Some connectors only return the direct parent of a file | |
permissions |
?Components\Permissions | ➖ | Permissions the current user has on this file. | |
exportable |
?bool | ➖ | Whether the current file is exportable to other file formats. This property is relevant for proprietary file formats such as Google Docs or Dropbox Paper. | |
exportFormats |
array<string> | ➖ | The available file formats when exporting this file. | [ "application/pdf", "application/vnd.oasis.opendocument.presentation", "text/plain" ] |
customMappings |
array<string, mixed> | ➖ | When custom mappings are configured on the resource, the result is included here. | |
updatedBy |
?string | ➖ | The user who last updated the object. | 12345 |
createdBy |
?string | ➖ | The user who created the object. | 12345 |
updatedAt |
\DateTime | ➖ | The date and time when the object was last updated. | 2020-09-30T07:43:32.000Z |
createdAt |
\DateTime | ➖ | The date and time when the object was created. | 2020-09-30T07:43:32.000Z |