> CommCell Console > Tools & Utilities > Developer Tools > REST API > REST API Reference > File Operations for Shares

View Shared Files and Folders (REST API: POST)

This operation lists the share details of all the shares or a specific share for a user, using the POST method.

Deprecated

This rest api is deprecated. For similar functionality, use View Shared Files and Folders (REST API: GET).

Request

Syntax

To view the share details of all the shares:

POST webservice/GetSharedFolders HTTP/1.1
 Host: host name
 Accept: application/xml
 Authtoken: authentication token
 Content-type: application/xml
 <App_GetSharedFoldersReq propertyLevel=""/>

To view the share details of a single share:

POST webservice/GetSharedFolders HTTP/1.1
 Host: host name
 Accept: application/xml
 Authtoken: authentication token
 Content-type: application/xml
 <App_GetSharedFoldersReq propertyLevel=""> 
 <shareInfo> 
     <shareFolder syncWebFolderId=""/> 
 </shareInfo> 
 </App_GetSharedFoldersReq>

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 Header

Name

Description

Host

The host name of the Web Server or the Command Center 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

An XML element is required. See Syntax. The following table displays the parameters for the request body.

Name

Description

Elements

propertyLevel

The level of details to be listed. Valid levels are:

  • 10 - returns the list of shares and the basic display properties for the shares

  • 20 - returns the list of shares with basic and extended display properties for the shares

  • 30 - returns the list of shares and all the properties of the share

App_GetSharedFoldersReq

syncWebFolderId

The share ID for the share. If the syncWebFolderId is not known, use the API to view all the shares to retrieve it.

nameValues

Examples

Sample Request

To view all the shares:

POST webservice/GetSharedFolders HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
 Content-type: application/xml
 <App_GetSharedFoldersReq propertyLevel="30"/>

To view the share details of a specific shared file:

POST webservice/GetSharedFolders HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
 Content-type: application/xml
 <App_GetSharedFoldersReq propertyLevel="30">
 <shareInfo> 
     <shareFolder syncWebFolderId="1137"/> 
 </shareInfo> 
 </App_GetSharedFoldersReq>
Sample Response
<App_GetSharedFoldersResp> <shares description="" userPermission="2" canUserEdit="1" ciEnabled="1" status="0"> <lastModified timeValue="1424922057"/> <client clientId="12" clientName="store1" applicationId="33" instanceId="1" backupsetId="46" subclientId="50"/> <owner userId="7" userName="user1"/> <shareFolder syncWebFolderId="36" syncWebFolderName="Pictures"/> <sharedTo permission="1" userType="1"> <sharedBy userId="7"/> <user userId="9" userName="domain\user1"/> <group/> <externalGroup/> </sharedTo> <browseInfo cloudId="1" edgeClient="1" contentStoreType="testing"> <emailInfo browseUrl="/webconsole/browse/MyDrive.do?displayName=Pictures&amp;isDirectoryShareBrowse=true&amp;path=7c4e538afe864e25ae415357aa6fa04e&amp;shareFolderId=36" dontSendEmail="1" emailMessage=""/> <paths directory="1" path="7c4e538afe864e25ae415357aa6fa04e"/> </browseInfo> </shares> </App_GetSharedFoldersResp>

Supported Error Codes

Code

Status

Description

400

Bad Request

The request is missing required parameters.

403

Forbidden

Error cased due to one of the following reasons:

  • The user does not have access to the share

  • The file requested is not accessible inside the share

  • Download operation is not allowed. This can happen if you attempt to download a folder.

404

Not Found

The specified file does not exist.
×

Loading...