REST API Developer Guide

1 REST API Developer GuideVersion , Winter 22 @salesforcedocsLast updated: September 9, 2021 Copyright 2000 2021 , inc. All rights reserved. salesforce is a registered trademark of , inc.,as are other names and marks. Other marks appearing herein may be trademarks of their respective 1: REST API.. 1 What Is REST API?.. 2 API Compatible Editions and Development Environments.. 2 REST Resources and Requests.. 3 REST API Architecture.. 4 Compression Headers.. 5 Conditional Request Headers.. 6 Send REST Requests with cURL.. 8 Authorization Through Connected Apps and OAuth .. 9 Perform Cross-Origin Requests from Web Browsers.. 10 Valid Date and DateTime Formats.. 11 API End-of-Life.. 11 Chapter 2: Quick Start.. 12 Quick Start Prerequisites.

2 13 Step One: Set Up Authorization.. 14 Step Two: Walk Through the Sample Code.. 14 Using Workbench.. 19 Chapter 3: Examples.. 21 Getting Information About My Organization.. 22 List Available REST API Versions.. 22 List Organization Limits.. 23 List Available REST Resources.. 26 Get a List of Objects.. 26 Get an Image from a Rich Text Area Field.. 27 Get a List of Objects If Metadata Has Changed.. 28 Working with Object Metadata.. 28 Retrieve Metadata for an Object.. 29 Get Field and Other Metadata for an Object.. 30 Get Object Metadata Changes.. 31 Working with Records.. 31 Create a Record.. 32 Update a Record.. 33 Delete a Record.. 34 Get Field Values from a Standard Object Record.. 34 Get Field Values from an External Object Record by Using the salesforce ID.

3 35 Get Field Values from an External Object Record by Using the External ID StandardField.. 35 Retrieve a Record Using an External ID.. 36 Insert or Update (Upsert) a Record Using an External ID.. 37 Traverse Relationships with Friendly URLs.. 41 Get Attachment Content from a Record.. 45 Get a List of Deleted Records Within a Given Timeframe.. 46 Get a List of Updated Records Within a Given Timeframe.. 47 Delete Lightning Experience Event Series.. 47 Working with Searches and Queries.. 49 Execute a SOQL Query.. 49 Execute a SOQL Query that Includes Deleted Items.. 51 Get Feedback on Query Performance.. 52 Search for a String.. 53 Get the Default Search Scope and Order.. 56 Get Search Result Layouts for Objects.. 57 View Relevant Items.

4 59 Insert or Update Blob Data.. 61 Working with Recently Viewed Information.. 66 View Recently Viewed Records.. 67 Mark Records as Recently Viewed.. 67 Managing User Passwords.. 68 Manage User Passwords.. 68 Working with Approval Processes and Process Rules.. 70 Get a List of All Approval Processes.. 71 Submit a Record for Approval.. 71 Approve a Record.. 72 Reject a Record.. 72 Bulk Approvals.. 73 Get a List of Process Rules.. 74 Get a Particular Process Rule.. 75 Trigger Process Rules.. 75 Using Event Monitoring.. 76 Describe Event Monitoring Using REST.. 77 Query Event Monitoring Data with REST.. 78 Get Event Monitoring Content from a Record .. 79 Download Large Event Log Files Using cURL with REST.

5 79 Delete Event Monitoring Data.. 80 Query or View Hourly Event Log Files.. 81 Using Composite Resources.. 83 Execute Dependent Requests in a Single API Call.. 83 Update an Account, Create a Contact, and Link Them with a Junction Object.. 86 Update a Record and Get Its Field Values in a Single Request.. 87 Upsert an Account and Create a Contact.. 88 Create Nested Records.. 89 Create Multiple Records.. 91 ContentsUsing a Composite Graph.. 92 Chapter 4: Reference.. 97 Versions.. 102 Resources by Version.. 103 Limits.. 103 Describe Global.. 106sObject Basic Information.. 107sObject Describe.. 108sObject Get Deleted.. 109sObject Get Updated.. 110sObject Named Layouts.. 111sObject Rows.. 112sObject Rows by External ID.

6 114sObject Blob Retrieve.. 115sObject ApprovalLayouts.. 116sObject CompactLayouts.. 117 Describe Layouts.. 122sObject PlatformAction.. 124sObject Quick Actions.. 125sObject Rich Text Image Retrieve.. 126sObject Relationships.. 127sObject Suggested Articles.. 128sObject User Password.. 131 Platform Event Schema by Event Name.. 131 Platform Event Schema by Schema ID.. 135 AppMenu.. 140 Compact Layouts.. 144 Consent.. 146 Use the Consent API with salesforce CDP.. 153 Consent Write.. 156 Embedded Service Configuration Describe.. 158 Invocable Actions.. 160 Standard Invocable Actions.. 161 Custom Invocable Actions.. 165 List View Describe.. 166 List View Results.. 169 List Views.. 179 Support Knowledge with REST API.

7 182 Data Category Groups.. 183 Data Category Detail.. 185 Articles List.. 187 Articles Details.. 191 Parameterized Search.. 195 ContentsPortability.. 203 Process Approvals.. 205 Process Rules.. 207 Product Schedules.. 208 Query.. 210 salesforce CDP Query Profile Parameters.. 212 QueryAll.. 213 Quick Actions.. 214 Recent List Views.. 215 Recently Viewed Items.. 216 Record Count.. 217 Record Count Response Body.. 218 Relevant Items.. 219 Retrieve Knowledge Language Settings.. 220 Search.. 221 Search Scope and Order.. 222 Search Result Layouts.. 222 Lightning Toggle Metrics.. 223 Lightning Usage by App Type.. 224 Lightning Usage by Browser.. 225 Lightning Usage by Page.. 226 Lightning Usage by FlexiPage.

8 228 Lightning Exit by Page Metrics.. 229 salesforce Scheduler Resources.. 230 Scheduling.. 230 Get Appointment Slots.. 231 Get Appointment Candidates.. 235 Request Bodies.. 238 Response Bodies.. 239 Search for Records Suggested by Autocomplete and Instant Results.. 241 Search Suggested Article Title Matches.. 247 Search Suggested Queries.. 249 salesforce Surveys Translation Resources.. 251 Add or Change the Translation of a Survey Field.. 252 Add or Update the Translated Value of Multiple Survey Fields in One or MoreLanguages.. 253 Delete the Translated Value of a Survey Field.. 255 Delete the Translated Value of Multiple Survey Fields in One or More Languages.. 255 Get Translated Value of a Survey Field.. 256 Get the Translated Values of Multiple Survey Fields in One or More Languages.

9 258 Tabs.. 259 Themes.. 261 Composite Resources.. 263 Composite.. 264 ContentsComposite Graphs.. 281 Batch.. 295sObject Tree.. 300sObject Collections.. 306 Headers.. 318 Assignment Rule Header.. 319 Call Options Header.. 319 Duplicate Rule Header.. 320 Limit Info Header.. 321 Package Version Header.. 321 Query Options Header.. 322 Warning Header.. 322 Status Codes and Error Responses.. 322 ContentsCHAPTER 1 REST APIREST API provides you with programmatic access to your data in salesforce . The flexibility and scalabilityof REST API make it an excellent choice for integrating salesforce into your applications and for performingcomplex operations on a large this chapter .. What Is REST API? API CompatibleEditions andUse this Guide to set up your deployment environment and learn about advanced details regarding dataaccess.

10 However, understanding and using REST API requires basic familiarity with software development,web services, and the salesforce user you want to get right to the action, the Quick Start Guide covers the basics to get you up and running. REST Resources andRequestsIf you re looking for more context about salesforce APIs, check out the list of ALSO:Trailhead: Lightning Platform API BasicsWhich API Do I Use? REST API Architecture CompressionHeaders Conditional RequestHeaders Send REST Requestswith cURL AuthorizationThrough ConnectedApps and OAuth Perform Cross-OriginRequests from WebBrowsers Valid Date andDateTime Formats API End-of-Life1 What Is REST API?REST API is one of several web interfaces that you can use to access your salesforce data without using the salesforce user API access, you can perform operations and integrate salesforce into your applications as you can use REST API tools to create, manipulate, and search data in salesforce by sending HTTP requests to endpoints in on where you send requests, you access and operate on different pieces of information, called resources.