Folder Operations

Syntax

The following user permissions are needed to access this resource.

GET:

• View Dashboards in Public Folders (for dashboard folders)
• View Reports in Public Folders (for report folders)

PATCH/DELETE:

• Manage Dashboards in Public Folders (for dashboard folders)
• Manage Reports in Public Folders (for report folders)

URI

/services/data/v42.0/folders/<folderid>

Formats

JSON

HTTP methods

Method	Description
GET	Gets information about the folder that has the specified folder ID.
PATCH	Updates the label or name of the folder with the specified folder ID. All users with the appropriate permissions can change the folder label. Only admin users can change the folder name.
DELETE	Deletes the folder that has the specified folder ID.

Parameters

Parameter	Description
folderId	Specifies a unique folder ID.

GET

Gets information about the folder that has the specified folder ID.

/services/data/v42.0/folders/<folderid>

New/Modified Input Payload

FolderRepresentation

Field	Type	Minimum Version	Description
label	String	212	Folder display name.
name	String	212	Folder unique name.
namespace	String	212	Namespace prefix to differentiate custom object and field names from those in use by other organizations.
type	ConnectFolderTypeEnum	212	Defined by the type of entity the folder contains.

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}

PATCH

/services/data/v42.0/folders/<folderid>

Request Body

Query Parameter Name	Group	Since	Values	Description
folder	Object	212	FolderInputRepresentation	Users with edit access on the folder can change label . Admins can change name . type cannot be changed.

Response Status

Condition	Code	Payload
Success	200	FolderRepresentation
Missing perm	403	[ { "errorCode" : "FUNCTIONALITY_NOT_ENABLED", "message" : "<message>]"}]
No such folder, Unsupported folder type, Unauthorized (missing access on a specific folder)	404	[ { "errorCode" : "<errorCode>", "message" : "<message>" } ]

Sample Request Body

1{
2  "id" : "00lxx000000flSFAAY",
3  "label": "report_folder1",
4  "name": "report_folder1"
5}

Sample Raw Response

1{
2  "id" : "00lxx000000flSFAAY",
3  "label" : "report_folder1",
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}

DELETE

Deletes the folder that has the specified folder ID.

/services/data/v42.0/folders/<folderid>

Response Status

Condition	Code	Payload
Success	200
Missing perm	403	[ { "errorCode" : "FUNCTIONALITY_NOT_ENABLED", "message" : "<message>]"}]
No such folder, Unsupported folder type, Unauthorized (missing access on a specific folder)	404	[ { "errorCode" : "<errorCode>", "message" : "<message>" } ]