Connect REST API Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Connect REST API Developer Guide
Introduction
Quick Start
Work with Features
Examples
Resources
Action Links Resources
Activity Reminders Resources
Application for Program
Batch Resource
Bot Version Activation Resource
Briefcase Priming Records Resource
Call Coaching Resources
Clean Resources
CMS Managed Content Resources
Commerce B2B and D2C Resources
Commerce Einstein Webstore Resources
Connect Resources
Content Taxonomy Resources
Content Workspace Permissions Resource
Conversation Application Definition Resource
Conversations Resources
Custom Domain Resources
Customer Asset Lifecycle Management Resources
Data Cloud Resources
Data Integration Resources
Duplicate Resources
Einstein Prediction Service Resources
Prompt Templates Resources
Einstein Recommendation Resources
Email Merge Field Services Resource
Employee Profiles Resources
Enhanced CMS Workspaces Resources
Environment Hub Resources
Experience Cloud CMS Content Search Resource
Experience Cloud Microsites Resources
Experience Cloud Sites Knowledge Resources
Experience Cloud Sites Moderation Resources
Experience Cloud Sites Resources
Experience Model Resources
External Email Services Resource
Field Service Recordset Filter Criteria Resource
Field Service Shifts from Pattern Resource
Files Connect Repository Resources
Files Resources
File Upload Config
File Information
Asset File
Asset File Information
Asset File Content
Asset File Rendition
Asset Files, Batch
File Content
File Image
File Shares
Files Shares Link
File Previews
File Preview
File Rendition
File Information, Batch
Folders Resources
Forecasts Resources
Knowledge Article View Stat Resource
List Share Resources
Managed Topics Resources
Messaging Channels Resource
Microbatching Resources
Motifs Resources
Named Credentials Resources
Navigation Menu Items Resource
Network Data Category Resources
Next Best Action Resources
Notification Settings Resources
Notifications Resources
OAuth Credentials Resources
OAuth Usage Resources
Orchestration Resources
Pardot Business Unit Context Resource
Personalization Resources
Private Connect Resources
Push Notifications Resource
Quick Text Resource
Quip Related Records Resource
Salesforce Omnichannel Inventory Resources
Salesforce Order Management Resources
Salesforce Payments Resources
Salesforce Scheduler Resources
Search Resources
Share Captured Activity Resource
Social Engagement Resources
Social Engagement Setup Resources
Surveys Resources
Topics Resources
Topics on Records Resource
Type System Resources
User Files Resources
Voice Resources
Chatter Resources
Request Bodies
Response Bodies
Appendices
PDF

File Rendition

A rendition of the file. A rendition is a binary preview of the file. The format of the binary depends on the format specified in the request.

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.

Note

Resource
/connect/files/fileId/rendition
/connect/communities/communityId/files/fileId/rendition
Available since version
36.0
In versions 24.0–35.0, use /chatter/files/fileId/rendition and /connect/communities/communityId/chatter/files/fileId/rendition, which require Chatter.
HTTP methods
GET
Request parameters
Name Type Description
page Integer Specify a rendition of a specific page. The first page is 0. If you don’t specify a specific page, a rendition of the first page is returned.

For a PDF file rendition, the rendition is for the entire document. The only valid value is 0: you can’t get the rendition of a single page.

type String Specify the type of rendition to be returned. Default value is THUMB120BY90. Valid values are:
  • PDF
  • THUMB120BY90
  • THUMB240BY180
  • THUMB720BY480
Response body
Binary stream of the rendition.