Salesforce Reports and Dashboards REST API Developer Guide
jNote: 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.
Folders
Resources for the Analytics Folders API are available at /services/data/<latest API version>/folders. You can query each resource with an HTTP method.
| Resource | Supported HTTP Method | Description |
|---|---|---|
|
/services/data/<latest API version>/folders/ |
POST GET |
Enables creation of report and dashboard folders and subfolders (POST). Gets the list of folders (GET). |
|
Folder Operations /services/data/<latest API version>/folders/<folderid> |
GET PATCH DELETE |
Enables renaming (PATCH), deleting (DELETE), and obtaining information (GET) on the report or dashboard folder or subfolder. |
|
Folder Shares /services/data/<latest API version>/folders/<folderid>/shares |
GET PUT POST |
Extracts a list of current folder shares (GET), adds new shares (POST), or replaces existing shares (PUT). |
|
Folder Share by ID
/services/data/<latest API version>/folders/<folderid>/shares/<shareid> |
GET PATCH DELETE |
For a specified share ID, extracts the share information (GET), updates the access level on the share (PATCH), or deletes the share (DELETE). |
|
Folder Share Recipients /services/data/<latest API version>/folders/<folderid>/share-recipients?shareType=<shareType> |
GET |
Returns a list of folder share recipients (GET). |
|
Folder Child Operations
/services/data/<latest API version>/folders/<folderid>/children/ |
GET |
Returns a list of first-level child folders (subfolders) (GET). |