Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

sObject Rich Text Image Get

Gets the specified image data from a specific rich text area field in a given record. To get an image, you must have a record with an image uploaded to a rich text area field.

The sObject Rich Text Image Get resource isn’t compatible with Composite API requests, because it returns binary data instead of data in JSON or XML formats. Instead, make individual sObject Blob Get requests to retrieve blob data.

Note

Syntax

URI: /services/data/vXX.X/sobjects/sObject/id/richTextImageFields/fieldName/contentReferenceId

Formats: Binary data

HTTP Method: GET

Authentication: Authorization: Bearer token

Parameters

Parameter	Description
sObjectName	Indicates the name of the standard object of the record.
id	The ID of the object.
fieldName	The name of the rich text area field.
contentReferenceId	The reference ID that uniquely identifies an image within a rich text area field. You can obtain the reference by retrieving information for the object. The description shows the contents of the rich text area field. The refid parameter of the image (`0EMRM00000002Ip` in this example) is the contentReferenceId.

Example rich text area field contents:

1{
2   "attributes" : {
3      "type" : "Lead",
4      "url" : "/services/data/v67.0/sobjects/Lead/00QRM000003ZfDb2AK"
5   },
6   "Id" : "00QRM000003ZfDb2AK",
7   ...
8   "ContactPhoto__c" : 
9   "Sarah Loehr and her two dogs.
10   <img alt=\"Sarah Loehr.\" 
11   src=\"https://MyDomainName.file.force.com/servlet/rtaImage?
12   eid=00QRM000003ZfDb&amp;
13   feoid=00NRM000001E73j&amp;
14   refid=0EMRM00000002Ip\"></img>"
15}

Example

For an example of retrieving the blob data from a rich text area field, see Get an Image from a Rich Text Area Field.

REST API Developer Guide

sObject Rich Text Image Get

Syntax

Example

See Also