Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#301 - Documents nuanced behavior in REST API for BLOB field retrieval #302

Merged
merged 1 commit into from
May 3, 2017
Merged

#301 - Documents nuanced behavior in REST API for BLOB field retrieval #302

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -473,6 473,12 @@ document = client.query('select Id, Name, Body from Document').first
File.open(document.Name, 'wb') { |f| f.write(document.Body) }
```

**Note:** The example above is only applicable if your SOQL query returns a single Document record. If more than one record is returned,
the Body field contains an URL to retrieve the BLOB content for the first 2000 records returned. Subsequent records contain the BLOB content
in the Body field. This is confusing and hard to debug. See notes in [Issue #301](https://github.com/ejholmes/restforce/issues/301#issuecomment-298972959) explaining this detail.
**Executive Summary:** Don't retrieve the Body field in a SOQL query; instead, use the BLOB retrieval URL documented
in [SObject BLOB Retrieve](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_sobject_blob_retrieve.htm)

* * *

### Custom Apex REST endpoints
Expand Down