REST API Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Introduction to REST API
Quick Start
Examples
Generating an OpenAPI 3.0 Document for sObjects REST API (Beta)
Reference
Versions
Resources by Version
Limits
Describe Global
sObject Basic Information
sObject Describe
sObject Get Deleted
sObject Get Updated
sObject Named Layouts
sObject Rows
sObject Rows by External ID
sObject Blob Get
sObject ApprovalLayouts
sObject Single Approval Process
sObject CompactLayouts
sObject Layouts
sObject Layouts for an Object With Multiple Record Types
sObject Global Publisher Layouts
sObject PlatformAction
sObject Quick Actions
sObject Specific Quick Actions
sObject Quick Action Details
sObject Quick Action Default Values
sObject Quick Action Default Values by ID
sObject Rich Text Image Get
sObject Relationships
sObjects Suggested Articles
sObjects Suggested Articles by ID
sObject User Password
sObject Self-Service User Password
Platform Event Schema by Event Name
Platform Event Schema by Schema ID
Get AppMenu Types
AppMenu Items
AppMenu Mobile Items
Compact Layouts
Consent
Consent Write
Embedded Service Configuration Describe
Invocable Actions
Invocable Actions Custom
Invocable Actions Standard
List View Basic Information
List View Describe
List View Results
List Views for an Object
Support Knowledge with REST API
Parameterized Search
Portability
Process Approvals
Process Rules
Process Rule for an sObject
Process Rule List for an sObject
Product Schedules
Query
Query More Results
QueryAll
QueryAll More Results
Query Performance Feedback (Beta)
Quick Actions
Recent List Views
Recently Viewed Items
Record Count
sObject Relevant Items
Get Knowledge Language Settings
Search
Search Scope and Order
Search Result Layouts
Lightning Toggle Metrics
Lightning Usage by App Type
Lightning Usage by Browser
Lightning Usage by Page
Lightning Usage by FlexiPage
Lightning Exit by Page Metrics
Salesforce Scheduler Resources
Search for Records Suggested by Autocomplete and Instant Results
Search Suggested Article Title Matches
Search Suggested Queries
Salesforce Surveys Translation Resources
Tabs
Themes
Composite
Composite Graph
Composite Batch
Batch Request Body
Batch Response Body
sObject Tree
sObject Collections
PDF

Batch Response Body

Describes the result of a Composite Batch request.

Batch Results

Properties
Name Type Description
hasErrors Boolean true if at least one of the results in the result set is an HTTP status code in the 400 or 500 range; false otherwise.
results Subrequest Result[] Collection of subrequest results.
JSON example
{
   "hasErrors" : false,
   "results" : [{
      "statusCode" : 204,
      "result" : null
      },{
      "statusCode" : 200,
      "result": {
         "attributes" : {
            "type" : "Account",
            "url" : "/services/data/v64.0/sobjects/Account/001D000000K0fXOIAZ"
         },
         "Name" : "NewName",
         "BillingPostalCode" : "94105",
         "Id" : "001D000000K0fXOIAZ"
      }
   }]
}

Subrequest Result

Properties
Name Type Description
result The type depends on the response type of the subrequest.

If the result is an error, the type is a collection containing the error message and error code.

Important

 The response body of this subrequest.
statusCode Integer An HTTP status code indicating the status of this subrequest.
JSON example
{
   "attributes" : {
      "type" : "Account",
      "url" : "/services/data/v64.0/sobjects/Account/001D000000K0fXOIAZ"
   },
   "Name" : "NewName",
   "BillingPostalCode" : "94015",
   "Id" : "001D000000K0fXOIAZ"
}