Newer Version Available

This content describes an older version of this product. View Latest

Folder Creation

Enables creation of report and dashboard folders.

Syntax

The following user permissions are needed to access this resource.

  • Manage Dashboards in Public Folders (for dashboard folders)
  • Manage Reports in Public Folders (for report folders)
URI
/services/data/v42.0/folders/
Formats
JSON
HTTP method
Method Description
POST Creates a new folder with the specified name, label, and type.

POST

Creates a new folder with the specified name, label, and type.

/services/data/v42.0/folders/

Request Body
Query Parameter Name Group Since Values Description
folder Object 212 FolderInputRepresentation Specifies the folder name, label, and type.
Response Status
Condition Status Code Payload
Success 201 FolderRepresentation
Missing Perm 403 [ { "errorCode" : "FUNCTIONALITY_NOT_ENABLED", "message" : "<message>]"}]
New/Modified Enumerated Examples
1ConnectFolderTypeEnum: 
2      Report
3      Dashboard
4      Document
5      Email
6      Insights
New/Modified Input Payloads
This payload is for FolderInputRepresentation.
Code Type Minimum Version Description
label String 212 Folder display name.
name String 212 Folder unique name. This is a mandatory field for admins; for non-admins, it is auto-generated.
type ConnectFolderTypeEnum 212 Defined by the type of entity the folder contains.
Sample Request Body
1{
2  "label": "report_folder",
3  "name": "report_folder1",
4  "type": "report"
5}
Sample Output Response
1{
2  "id" : "00lxx000000flSFAAY",
3  "label" : "report_folder",
4  "name" : "report_folder1",
5  "shareRecipientsUrl" : "/services/data/v42.0/folders/00lxx000000flSFAAY/share-recipients?shareType=User&limit=100",
6  "sharesUrl" : "/services/data/v42.0/folders/00lxx000000flSFAAY/shares",
7  "supportedShareTypes" : [ "user", "role", "roleandsubordinates", "roleandsubordinatesinternal", "group", "portalrole", "portalroleandsubordinates", "customerportaluser" ],
8  "type" : "report"
9}