Pilot Release: No warranty or guarantee of availability
Table of Contents
Getting Started with the Force.com REST API............................................................................3
Chapter 1: Introducing the Force.com REST API...............................................................3
Understanding Force.com REST Resources......................................................................................................3
Using Compression............................................................................................................................................4
Chapter 2: Quick Start.......................................................................................................6
Prerequisites.......................................................................................................................................................6
Step One: Obtain a Salesforce.com Developer Edition Account......................................................................6
Step Two: Set Up Authorization.......................................................................................................................7
Step Three: Send HTTP Requests with cURL.................................................................................................9
Step Four: Walk Through the Sample Code....................................................................................................10
Using REST Resources..............................................................................................................16
Chapter 3: Working with Objects and Records...................................................................16
List Available REST API Versions..................................................................................................................17
List Available REST Resources.......................................................................................................................17
Get a List of Objects.......................................................................................................................................17
Retrieve Metadata for an Object.....................................................................................................................18
Get Field and Other Metadata for an Object..................................................................................................19
Get Field Values from Records........................................................................................................................20
Get Attachment Content from a Record.........................................................................................................21
Execute a SOQL Query..................................................................................................................................21
Search for a String...........................................................................................................................................22
Create a Record...............................................................................................................................................23
Update a Record..............................................................................................................................................24
Delete a Record...............................................................................................................................................25
REST API Reference................................................................................................................26
Chapter 4: Reference........................................................................................................26
Versions............................................................................................................................................................27
Resources by Version........................................................................................................................................27
Describe Global...............................................................................................................................................28
SObject Basic Information..............................................................................................................................29
SObject Describe.............................................................................................................................................31
SObject Row....................................................................................................................................................33
SObject Blob Retrieve.....................................................................................................................................34
Query...............................................................................................................................................................35
Search..............................................................................................................................................................37
Error Response................................................................................................................................................38
i
Table of Contents