REST API Developer Guide

Introduction to REST API
About REST API
Release Notes
Supported Editions and Required Permissions
REST Resources and Requests
REST API Architecture
Authorization Through External Client Apps or Connected Apps and OAuth 2.0
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
Valid Date and DateTime Formats
Status Codes and Error Responses
API End-of-Life Policy
Quick Start
Examples
Generating an OpenAPI 3.0 Document for sObjects REST API (Beta)
Reference
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Package Version Header

Specifies the version of each package referenced by a client. A package version is a number that identifies the set of components and behavior contained in a package. This header can also be used to specify a package version when making calls to an Apex REST web service.

The Package Version header can be used with the following resources: Describe Global, sObject Describe, sObject Basic Information, sObject Rows, sObject Layouts, Query, QueryAll, Search, and sObject Rows by External ID.

Header Field Name and Values

  • Field name and value: x-sfdc-packageversion-[namespace]: xx.x, where [namespace] is the unique namespace of the managed package and xx.x is the package version.
  • Example: x-sfdc-packageversion-clientPackage: 1.0