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.

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

Formats: Binary data

HTTP Method: GET

Authentication: Authorization: Bearer token

Parameters

ParameterDescription
sObjectNameIndicates the name of the standard object of the record.
idThe ID of the object.
fieldNameThe name of the rich text area field.
contentReferenceIdThe 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:

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

See Also