Api Rest
DOWNLOAD
First things first !
To download this implementation guide, click the download button below.
If you need more information about the implementation guide, you can read the Table of Contents below.
Chapter Introduction to REST API
About REST API
Release Notes
Supported Editions and Required Permissions
REST Resources and Requests
REST API Architecture
Authorization Through Connected Apps and OAuth
Headers
Assignment Rule Header
Call Options Header
Compression Headers
Conditional Request Headers
Duplicate Rule Header
Limit Info Header
MRU Header
Package Version Header
Query Options Header
Warning Header
Send REST Requests with cURL
Configure Salesforce CORS Allowlist
Valid Date and DateTime Formats
Status Codes and Error Responses
API EndofLife Policy
Chapter Quick Start
Using cURL
Step One Sign up for Salesforce Developer Edition
Step Two Set Up Authentication
Step Three Walk Through the Sample Code
Using Other Tools
Chapter Examples
Getting Information About My Organization
List Available REST API Versions
List Org Limits
List Available REST Resources
Get a List of Objects
Get a List of Objects If Metadata Has Changed
Working with Object Metadata
Get Metadata for an Object
Get Field and Other Metadata for an Object
Get Object Metadata Changes
Working with Records
Create a Record
Update a Record
Delete a Record
Get Field Values from a Standard Object Record
Get Field Values from an External Object Record by Using the Salesforce ID
Field
Get a Record Using an External ID
Insert or Update Upsert a Record Using an External ID
Traverse Relationships with Friendly URLs
Get a List of Deleted Records Within a Given Timeframe
Get a List of Updated Records Within a Given Timeframe
Delete Lightning Experience Event Series
Working with Searches and Queries
Execute a SOQL Query
Execute a SOQL Query that Includes Deleted Items
Get Feedback on Query Performance Beta
Search for a String
Get the Default Search Scope and Order
Get Search Result Layouts for Objects
View Relevant Items
Get an Image from a Rich Text Area Field
Insert or Update Blob Data
Get Blob Data
Working with Recently Viewed Information
View Recently Viewed Records
Mark Records as Recently Viewed
Managing User Passwords
Manage User Passwords
Working with Approval Processes and Process Rules
Get a List of All Approval Processes
Submit a Record for Approval
Approve a Record
Reject a Record
Bulk Approvals
Get a List of Process Rules
Get a Particular Process Rule
Trigger Process Rules
Using Event Monitoring
Describe Event Monitoring Using REST
Query Event Monitoring Data with REST
Get Event Monitoring Content from a Record
Download Large Event Log Files Using cURL with REST
Delete Event Monitoring Data
Query or View Hourly Event Log Files
Using Composite Resources
Execute Dependent Requests in a Single API Call
Update an Account Create a Contact and Link Them with a Junction Object
Update a Record and Get Its Field Values in a Single Request
Upsert an Account and Create a Contact
Create Nested Records
Create Multiple Records
Using Composite Graphs
Using a Composite Graph
allOrNone Parameters in Composite and Collections Requests
Chapter Generating an OpenAPI Document for sObjects REST API Beta
Chapter Reference
Versions
Resources by Version
Limits
Describe Global
sObject Basic Information
Get Object Metadata Using sObject Basic Information
Create Records Using sObject Basic Information
sObject Describe
sObject Get Deleted
sObject Get Updated
sObject Named Layouts
sObject Rows
Get Records Using sObject Rows
Update Records Using sObject Rows
Delete Records Using sObject Rows
sObject Rows by External ID
Get Records Using sObject Rows by External ID
Create Records Using sObject Rows by External ID
Upsert Records Using sObject Rows by External ID
Delete Records Using sObject Rows by External ID
Return Headers Using sObject Rows by External ID
sObject Blob Get
sObject ApprovalLayouts
Get Approval Layouts
Return Headers for Approval Layouts
sObject Single Approval Process
Get a Layout for a Single Approval Process on a Specified Object
Return Headers for a Single Approval Process on a Specified Object
sObject CompactLayouts
Get Compact Layouts Using sObject CompactLayouts
Return Headers Using sObject CompactLayouts
sObject Layouts
Get Layouts and Descriptions for a Specified Object
Return Layout Headers for a Specified Object
sObject Layouts for an Object With Multiple Record Types
Get Layouts and Descriptions for an Object With Multiple Record Types
Return Layout Headers for an Object With Multiple Record Types
sObject Global Publisher Layouts
Get Global Publisher Layouts and Descriptions
Return Headers for All Global Publisher Layouts
sObject PlatformAction
sObject Quick Actions
Get sObject Quick Actions
Return Headers Using sObject Quick Actions
sObject Specific Quick Actions
Get Specific sObject Quick Actions
Create Records Using Specific sObject Quick Actions
Return Headers Using Specific sObject Quick Actions
sObject Quick Action Details
Get sObject Quick Action Details
Return Headers Using sObject Quick Action Details
sObject Quick Action Default Values
Get sObject Quick Action Default Values
Return Headers Using sObject Quick Action Default Values
sObject Quick Action Default Values by ID
Get sObject Quick Action Default Values by ID
Return Headers Using sObject Quick Action Default Values by ID
sObject Rich Text Image Get
sObject Relationships
Get Records Using sObject Relationships
Update Records Using sObject Relationships
Delete Records Using sObject Relationships
sObjects Suggested Articles
sObjects Suggested Articles by ID
sObject User Password
Get User Password Expiration Status
Set User Password
Reset User Password
Return Headers Using sObject User Password
sObject SelfService User Password
Get SelfService User Password Expiration Status
Set SelfService User Password
Reset SelfService User Password
Return Headers Using sObject SelfService User Password
Platform Event Schema by Event Name
Platform Event Schema by Schema ID
Get AppMenu Types
AppMenu Items
Get AppMenu Items
Return Headers of App Menu Item Requests
AppMenu Mobile Items
Get AppMenu Mobile Items
Return Headers of AppMenu Mobile Item Requests
Compact Layouts
Consent
Compile Consent Settings
Compile Multiple Types of Consent Settings
Use the Consent API with Data Cloud
Consent Write
Embedded Service Configuration Describe
Get Embedded Service Configuration
Return Headers for Embedded Service Configuration
Invocable Actions
Get Invocable Actions
Return HTTP Headers for Invocable Actions
Invocable Actions Custom
Get Custom Invocable Actions
Return HTTP Headers for Custom Invocable Actions
Invocable Actions Standard
Get Standard Invocable Actions
Return HTTP Headers for Standard Invocable Actions
List View Basic Information
List View Describe
List View Results
List Views for an Object
Support Knowledge with REST API
Data Category Groups
Data Category Detail
Articles List
Articles Details
Parameterized Search
Search with Parameters in the URI
Search with Parameters in the Request Body
Portability
Compile Data for a Portability Request
Get the Status of Your Portability Request
Process Approvals
Get Process Approvals
Submit Approve or Reject Process Approvals
Return HTTP Headers for Process Approvals
Process Rules
Get Process Rules
Trigger Process Rules
Return HTTP Headers for Process Rules
Process Rule for an sObject
Get a Process Rule for an sObject
Trigger a Process Rule for an sObject
Return HTTP Headers for a Process Rule of an sObject
Process Rule List for an sObject
Get Process Rules for an sObject
Return HTTP Headers for Process Rules of an sObject
Product Schedules
Get Product Schedules
Create Product Schedules
Delete Product Schedules
Query
Data Cloud Query Profile Parameters
Query More Results
QueryAll
QueryAll More Results
Query Performance Feedback Beta
Quick Actions
Get Quick Actions
Create Records Using Quick Actions
Return Headers of Quick Actions
Recent List Views
Recently Viewed Items
Record Count
Record Count Response Body
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
Scheduling
Get Appointment Slots
Get Appointment Candidates
Request Bodies
Response Bodies
Search for Records Suggested by Autocomplete and Instant Results
Search Suggested Article Title Matches
Search Suggested Queries
Salesforce Surveys Translation Resources
Add or Change the Translation of a Survey Field
Languages
Delete the Translated Value of a Survey Field
Delete the Translated Value of Multiple Survey Fields in One or More Languages
Get Translated Value of a Survey Field
Get the Translated Values of Multiple Survey Fields in One or More Languages
Tabs
Get Tabs
Return Headers Using Tabs
Themes
Composite
Send Multiple Requests Using Composite
Get a List of Composite Resources
Composite Graph
Composite Subrequest
Composite Graph Limits
Composite Batch
Batch Request Body
Batch Response Body
sObject Tree
sObject Tree Request Body
sObject Tree Response Body
sObject Collections
Create Records Using sObject Collections
Get Records Using sObject Collections
Get Records With a Request Body Using sObject Collections
Update Records Using sObject Collections
Upsert Records Using sObject Collections
Delete Records Using sObject Collections
