Use this operation to add, modify or delete users or change the share and user permissions on a shared file or folder.
Request
Syntax
PUT <webservice>/ShareFolder/{shareId} HTTP/1.1 Host: <host name> Accept: application/xml Authtoken: <authentication token> Content-type: application/xml <update_share_template.xml>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Parameters
Name |
Description |
Required |
shareID |
The unique identifier (syncWebFolderId response) returned when you share a file or folder or view the shared files and folders in the ObjectStore or Edge Drive. For example, see Sharing a File or Folder or View Shared Files and Folders. |
Yes |
Request Headers
Name |
Description |
Host |
The host name of the Web Server or Web Console used in the API request. |
Accept |
The format of the response. Valid values are: application/xml or application/json. |
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
Request Body
Download the update_share_template.xml file required for this request. The following table displays the parameters for the update_share_template.xml file.
Parameter |
Description and Parameter Values |
Element |
Parent Element |
sharedToOperationType |
Specifies if the users\user groups listed in the update request will be added, replaced, or removed from the existing user\user group list. This parameter is used only when you need to modify the user list for an existing share. Valid values are:
|
shareInfo |
App_UpdateSharedFolderReq |
status |
Specifies whether the share is a public share or a private share. To create a public share, enter value 1. |
shareInfo |
App_UpdateSharedFolderReq |
dontSendEmail |
Specifies whether an email notification is sent to the shared users. Valid values are:
|
emailInfo |
browseInfo |
emailMessage |
The optional message to include in the email notification for the shared users. |
emailInfo |
browseInfo |
permission |
The access permissions assigned to the shared user or user group. Valid values are:
|
sharedTo |
App_UpdateSharedFolderReq |
userType |
Specifies the type of entity to which the file or folder is being shared. Valid values are:
|
sharedTo |
App_UpdateSharedFolderReq |
username |
The user account name to which the file or folder is being shared. Required only if the userType is 1. |
user |
sharedTo |
|
The email address to which the file or folder will be shared. Required only if the userType is 2. |
sharedTo |
App_ShareInfo |
userGroupName |
The CommCell user group name to which the file or folder will be shared. Required only if the userType is 3. |
group |
sharedTo |
externalGroupName |
The external AD user group name to which the file or folder will be shared. Required only if the userType is 4. |
externalGroup |
sharedTo |
Response
Parameter |
Description |
Element |
errorCode |
The possible error codes. Valid values are:
|
App_GenericResp |
errorString |
The description of the error code. Not all error codes have an error string. |
App_GenericResp |
Examples
Sample Request
To view all the shared files and folders:
PUT <webservice>/ShareFolder/10 HTTP/1.1 Host: client1.mydomain.com Accept: application/xml Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8 Content-type: application/xml <update_share_template.xml>
Sample Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_GenericResp errorCode="0"/>