Chatter REST API Developer's Guide
jNewer Version Available
File Summary
Description of a file.
For all rendition properties, note the following: For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded.
| Property | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| checkSum | String | MD5 checksum for the file | Big, 29.0 | 26.0 |
| contentSize | Integer | Size of the file in bytes | Small, 29.0 | 24.0 |
| contentHubRepository | Files Connect Repository | The external data source associated with this file, or null if it doesn’t point to an external file. | Small, 32.0 | 32.0 |
| contentModifiedDate | Date | An ISO 8601 format date string, for example, 2011-02-25T18:24:31.000Z. File-specific modified date, which is updated only for direct file operations, such as rename. Modifications to the file from outside of Salesforce can update this date. | Small, 32.0 | 32.0 |
| contentUrl | String | If the file is a link, returns the URL, otherwise the string “null” | Small, 29.0 | 24.0 |
| description | String | Description of the file | Medium, 29.0 | 24.0 |
| downloadUrl | String | URL to the file | Small, 29.0 | 26.0 |
| externalDocumentUrl | String | The external URL this file points to, or null if it doesn’t point to an external file. | Small, 32.0 | 32.0 |
| externalFilePermissionInformation | External File Permission Information | External file permission information, such as available groups, available permission types, and current sharing status, or null for non-external files or when includeExternalFilePermissionsInfo is false. | Big, 35.0 | 35.0 |
| flashRenditionStatus | String | Specifies if a flash preview version of the file has been rendered | Big, 29.0 | 24.0 |
| fileExtension | String | Extension of the file | Small, 29.0 | 26.0 |
| fileType | String | Type of file, such as PDF, PowerPoint, and so on | Medium, 29.0 | 24.0 |
| id | String | 18-character ID of the file | Small, 29.0 | 24.0 |
| isInMyFileSync | Boolean | true if the file is synced withSalesforce Files Sync; false otherwise. | Medium, 29.0 | 26.0 |
| isMajorVersion | Boolean | true if the file is a major version; false if the file is a minor version. Major versions can’t be replaced. | Medium, 31.0 | 31.0 |
| mimeType | String | MIME type of the file | Medium, 29.0 | 26.0 |
| moderationFlags | Moderation Flags | Flags for this file. Community moderators can view and take action on flagged
items. If the communityModeration property of the Features response body is false, this property is null. |
Big, 30.0 | 30.0 |
| modifiedDate | Date | An ISO 8601 format date string, for example, 2011-02-25T18:24:31.000Z. Modifications to the file from within Salesforce update this date. | Small, 29.0 | 24.0 |
| motif | Motif | Small, medium, and large icons indicating that the object is a file. The motif
can also contain the object’s base color. The icon is not a preview of the file. |
Small, 29.0 | 27.0 |
| mySubscription | Reference | If the context user is following this file, this contains information about the subscription, otherwise returns null | Medium, 29.0 | 23.0 |
| name | String | Name of the file | Small, 29.0 | 24.0 |
| origin | String | Specifies the file source. Valid values are:
|
Big, 29.0 | 24.0 |
| owner | User Summary | Owner of the file | Small, 29.0 | 24.0 |
| parentFolder | Reference | A reference to the parent folder. | Small, 29.0 | 28.0 |
| pdfRenditionStatus | String | Specifies if a PDF preview version of the file has been rendered | Big, 29.0 | 24.0 |
| publishStatus | String | The publish status of the file. One of these values:
|
Small, 29.0 | 29.0 |
| renditionUrl | String | URL to the rendition resource for the file. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. | Medium, 29.0 | 26.0 |
| renditionUrl240By180 | String | URL to the 240px by 180px rendition for the file, if available. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. | Medium, 29.0 | 29.0 |
| renditionUrl720By480 | String | URL to the 720px by 480px rendition for the file, if available. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded. | Medium, 29.0 | 29.0 |
| repositoryFileUrl | String | The URL of the Chatter REST API resource giving access to the external repository file properties, or null if this file doesn’t point to an external file. | Small, 32.0 | 32.0 |
| sharingOption | String |
Sharing option of the file. Values are:
|
Medium, 35.0 | 35.0 |
| sharingRole | String | The sharing role of the file. One of these values:
|
Medium, 29.0 | 29.0 |
| textPreview | String | Text preview of the file if available, null otherwise. | Big, 30.0 | 30.0 |
| thumb120By90RenditionStatus | String |
Specifies the rendering status of the 120 x 90 preview image of the
file. One of these values:
|
Small, 29.0 | 24.0 |
| thumb240By180RenditionStatus | String |
Specifies the rendering status of the 240 x 180 preview image of the
file. One of these values:
|
Small, 29.0 | 24.0 |
| thumb720By480RenditionStatus | String |
Specifies the rendering status of the 720 x 480 preview image of the
file. One of these values:
|
Small, 29.0 | 24.0 |
| title | String | Title of the file | Small, 29.0 | 24.0 |
| type | String | ContentDocument | Small, 29.0 | 24.0 |
| url | String | URL for the file | Small, 29.0 | 24.0 |
| versionNumber | String | Version number of the file | Medium, 29.0 | 24.0 |