Chatter REST API Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

File Summary

Description of a file.

For all rendition properties, note the following: Renditions are processed asynchronously and might not be available immediately after the file has been 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
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
flash​RenditionStatus 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 included in the user’s Salesforce Files folder, and is synced between that folder and Chatter; false otherwise. Medium, 29.0 26.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 String ISO8601 date string, for example, 2011-02-25T18:24:31.000Z 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 logged in 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:
  • Chatter—file came from Chatter
  • Content—file came from content
  • FileField—file came from a record or other form
 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
pdfRendition​Status 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:
  • PendingAccess—File is pending publishing.
  • PrivateAccess—File is private.
  • PublicAccess—File is public.
 Small, 29.0 29.0
recordViewUrl String The URL of the Chatter REST API record view resource for this record, or null if this record does not have a record view layout, or if “Connect Records API” is not enabled for this organization, or if the record type isn’t supported. Small, 30.0 30.0
renditionUrl String URL to the rendition resource for the file. Renditions are processed asynchronously and might not be available immediately after the file has been uploaded. Medium, 29.0 26.0
renditionUrl​240By180 String URL to the 240px by 180px rendition for the file, if available. Renditions are processed asynchronously and might not be available immediately after the file has been uploaded. Medium, 29.0 29.0
renditionUrl​720By480 String URL to the 720px by 480px rendition for the file, if available. Renditions are processed asynchronously and might not be available immediately after the file has been uploaded. Medium, 29.0 29.0
sharingRole String The sharing role of the file. One of these values:
  • Admin—Owner permission, but doesn’t own the file.
  • Collaborator—Viewer permission, and can edit, change permissions, and upload a new version of a file.
  • Owner—Collaborator permission, and can make a file private, and delete a file.
  • Viewer—Can view, download, and share a file.
  • WorkspaceManaged—Permission controlled by the library.
 Medium, 29.0 29.0
textPreview String Text preview of the file if available, null otherwise. Big, 30.0 30.0
thumb​120By90​​RenditionStatus String Specifies the rendering status of the 120 x 90 preview image of the file. One of these values:
  • Processing—Image is being rendered.
  • Failed—Rendering process failed.
  • Success—Rendering process was successful.
  • Na—Rendering is not available for this image.
 Small, 29.0 24.0
thumb​240By180​​RenditionStatus String Specifies the rendering status of the 240 x 180 preview image of the file. One of these values:
  • Processing—Image is being rendered.
  • Failed—Rendering process failed.
  • Success—Rendering process was successful.
  • Na—Rendering is not available for this image.
 Small, 29.0 24.0
thumb​720By480​​RenditionStatus String Specifies the rendering status of the 720 x 480 preview image of the file. One of these values:
  • Processing—Image is being rendered.
  • Failed—Rendering process failed.
  • Success—Rendering process was successful.
  • Na—Rendering is not available for this image.
 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