Folder Share by ID

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/v41.0/folders/<folderId>/shares/<shareId>

Formats

JSON

HTTP methods

Method	Description
GET	Returns information for the specified folder share.
PATCH	Updates the access level on the specified folder share.
POST	Deletes the specified folder share.

Parameters

Parameter	Description
folderId	ID of the folder containing the share.
shareId	Perform the operation for this unique folder share ID.

GET

Response Body

Property	Type	Description
accessType	ConnectFolderAccessTypeEnum	Type of access: View, Edit, or Manage
shareId	ID	Unique identifier of the share.
shareType	ConnectFolderShareTypeEnum	Type of share. The following are the supported share types. Group. Users in a specified public group. Role. Users with a specified role. RoleAndSubordinates. Users with a specified role and users with a role subordinate to that role. RoleAndSubordinatesInternal. Users with a specified role and users with a role subordinate to that role, except public portal users. Organization. All internal users. AllPrmUsers. All PRM Portal users. User. The specified individual user. PartnerUser. The specified individual user of a partner portal. AllCspUsers. All Customer Success Portal users. CustomerPortalUser. The specified individual user of a customer portal. PortalRole. Users with a specified role in a portal. PortalRoleAndSubordinates. Portal users with a specified role, and portal users with a role subordinate to that role. ChannelProgramGroup. PRM Portal users who are members of the specified channel programs and levels group.
sharedWithId	ID	Unique identifier of the share recipient.
sharedWithLabel	String	Label of the share recipient.
url	ConnectUri	URL of the share.

Status Codes

Condition	Code	Payload
Success	200	FolderShareRepresentation
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>" } ]

Output Example

1{
2“shareId”		: “004xx000001Sy1GAAS”
3“accessType”		: “manage”,
4“shareType”		: “user”
5“sharedWithId”	: “005xx000001Sy1GAAS”
6“sharedWithLabel”	: “User1”
7}

PATCH

Request Body

Query Param Name	Group	Since	Values	Description
folder	Object	210	FolderShareInputRepresentation	Folder share input representation.

Status Codes

Condition	Code	Payload
Success	200	FolderShareRepresentation
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"accessType" : "manage",
3"shareType" : "user",
4"shareWithId" : "005R0000000Kg8yIAC"
5}

DELETE

Status Codes

Condition	Code	Payload
Success	200	NA
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>" } ]