Use this operation to view the list of all or specific shared files and folders in one or more ObjectStores.
To view all or specific shares for a user, see View Shared Files and Folders.
To remove the share on a folder, see Remove Sharing on a File or Folder.
To update the share settings, see Change Share Settings.
Request
Syntax
GET <webservice>/contentstore/share?shareId={shareId}&contentStoreType={storetype} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>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. |
No |
|
storeType |
Name of the ObjectStore. |
No |
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. |
Response
Response Parameters
|
Parameter |
Description |
Element |
|
capabilities |
The capabilities assigned to ObjectStore users. |
App_GetSharedFoldersResp |
|
cloudId |
The ID generated for the newly created ObjectStore. |
App_GetSharedFoldersResp |
|
contentIndexingEnabled |
Indicates whether content indexing is enabled for the ObjectStore. Valid values are 1 and 0. |
App_GetSharedFoldersResp |
|
dirDelim |
Indicates the delimiter used for the file path in the ObjectStore. |
App_GetSharedFoldersResp |
|
rootGUID |
The GUID of the root folder in the ObjectStore. |
App_GetSharedFoldersResp |
|
backupsetId |
The ID of the auto-created backup set for the ObjectStore. |
App_GetSharedFoldersResp |
|
subclientId |
The ID of the auto-created subclient for the ObjectStore. |
App_GetSharedFoldersResp |
|
syncWebFolderId |
The share ID of the auto-created sync web folder for the ObjectStore or the share ID of the file. |
App_GetSharedFoldersResp |
|
syncWebFolderName |
The name of the auto-created sync web folder for the ObjectStore or the name of the shared file. |
App_GetSharedFoldersResp |
Examples
Sample Request
To view all the shared files and folders:
GET <webservice>/contentstore/share HTTP/1.1
Host: client1.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8To view the shared files and folders from a specific ObjectStore:
GET <webservice>/contentstore/share?contentStoreType=ftplogs HTTP/1.1
Host: client1.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8To view the details for a specific shared file or folder:
GET <webservice>/contentstore/share?shareId=10 HTTP/1.1
Host: client1.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8Sample Response
<App_GetSharedFoldersResp> <shares description="" userPermission="2" canUserEdit="1" ciEnabled="1" status="0"> <lastModified timeValue="1424922057"/> <client clientId="12" clientName="ContentStore" 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&isDirectoryShareBrowse=true&path=7c4e538afe864e25ae415357aa6fa04e&shareFolderId=36" dontSendEmail="1" emailMessage=""/> <paths directory="1" path="7c4e538afe864e25ae415357aa6fa04e"/> </browseInfo> </shares> </App_GetSharedFoldersResp>