View Shared Files and Folders (REST API: GET)

This operation lists all the shared files and folders associated with the user.

Request

Syntax

GET <webservice>/ShareFolder?shareId={SHAREID}&shareType={SHARETYPE}&propertyLevel={PROPERTYLEVEL} 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 Header

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 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. If the shareId is not known, see View Shared Files and Folders to retrieve it.	No
shareType	Specifies the type of share. Valid values are: SHAREDBYME SHAREDWITHME COLLABORATIVESHARES PUBLICLINKS	Yes
PropertyType	The level of details to be listed. Valid levels are: BASIC - returns the list of shares and the basic display properties for the shares EXTENDED - returns the list of shares with basic and extended display properties for the shares ALL - returns the list of shares and all the properties of the share To retrieve all properties, you must provide the shareId.	Yes

Name

Description

Required

shareId

The unique identifier (syncWebFolderId response) returned when you share a file or folder or view the shared files and folders. If the shareId is not known, see View Shared Files and Folders to retrieve it.

shareType

Specifies the type of share. Valid values are:

SHAREDBYME
SHAREDWITHME
COLLABORATIVESHARES
PUBLICLINKS

Yes

PropertyType

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

BASIC - returns the list of shares and the basic display properties for the shares
EXTENDED - returns the list of shares with basic and extended display properties for the shares
ALL - returns the list of shares and all the properties of the share

To retrieve all properties, you must provide the shareId.

Yes

Response

Response Parameters

Parameter	Description	Element
shareType	Value for the type of share. For example, for sharedbyme type, the value is 4.	shares
ciEnabled	Specifies if content indexing is enabled for the share. Valid values are 0 and 1.	shares
userPermission	Specifies the permissions assigned to the user. Valid values are: 0 - no permissions 1 - view permissions, where user can browse, download and restore files 2 - edit permissions, where user can view and also upload files	shares
canReshare	Specifies if the share can be reshared. Valid values are 0 and 1.	shares
isNotificationEnabled	Specifies if email notification is enabled for the share. Valid values are 0 and 1.	shares
hasReshares	Specifies if the share was reshared. Valid values are 0 and 1.	shares
canUserEdit	Specifies if the user can edit the share. Valid values are 0 and 1.	shares
status	Specifies whether the share will be a public share or a private share. Valid values are: 1 - public link with view permissions 4 - public link with edit permissions 0 - private share	shares
clientName	Name of the client from where the share was created.	client
backupsetId	The system-generated ID assigned to the backup set on the client.	client
instanceId	The system-generated ID assigned to the instance on the client.	client
subclientId	The system-generated ID assigned to the subclient on the client.	client
clientId	The system-generated ID assigned to the client from where the share was created.	client
applicationId	The ID of the application type associated with the share. For example, 33 for for file system.	client
userName	The name of the user sent in the request.	owner
userId	The globally unique identifier for the user.	owner
timeValue	The time (in unix format) when the share was created.	created
syncWebFolderId	The share ID for the share. If the syncWebFolderId is not known, use the API to view all the shares to retrieve it.	shareFolder
syncWebFolderName	The name assigned to the share.	shareFolder
edgeClient	Specifies if the share is from Edge Drive. Valid values are 0 and 1.	browseInfo
cloudId	The cloudID of the Index Server associated with the share.	browseInfo
password	The password value in base64 format. Required only if the isSet parameter is 1.	password
isSet	Applies only to public links. Specifies if the public link is password protected. Valid values are 0 and 1.	password
path	The path to the share.	paths
directory	'directory=1' indicates the request item is a folder.	paths
emailMessage	The optional message to include in the email notification for the shared users.	emailInfo
browseUrl	The URL to access the share.	emailInfo
dontSendEmail	Specifies whether an email notification is sent to the shared users. Valid values are: 1- do not send email 0 - send email	emailInfo
timeValue	The time (in unix format) when the share was last modified.	lastModified

Examples

Example 1: To view the basic properties of a share that was share.

Sample Request

GET <webservice>/ShareFolder?shareID=262173&shareType=SHAREDBYME&propertyLevel=BASIC HTTP/1.1
 Host: client.mydomain.com
 Accept: application/json
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

{ "shares": [ { "description": "", "shareType": 4, "ciEnabled": true, "userPermission": 2, "isVisible": true, "canReshare": false, "hasReshares": 0, "canUserEdit": true, "isExpired": false, "status": 1, "client": { "clientName": "EdgeDrive", "backupsetId": 13058, "instanceId": 1, "subclientId": 14435, "clientId": 4751, "applicationId": 33 }, "owner": { "userGUID": "F90E7E80-43E0-40DC-AA13-0FCDA48B434F", "userName": "company\\user1", "userId": 2855 }, "created": { "timeValue": "1538579737" }, "shareFolder": { "syncWebFolderId": 262173, "syncWebFolderName": "test1" }, "browseInfo": { "edgeClient": true, "cloudId": 97301, "password": { "password": "", "isSet": false }, "paths": [ { "path": "c33b0ed340284066bd23d4331c5bf354", "directory": false } ], "emailInfo": { "emailMessage": "", "browseUrl": "/webconsole/gtl.do?gid=JJgnNzY4cE7sn", "dontSendEmail": true } }, "lastModified": { "timeValue": "1538579737" } } ], "resp": {}
}

Example 2: To view the extended properties of a share.

Sample Request

GET <webservice>/ShareFolder?shareID=262173&shareType=SHAREDBYME&propertyLevel=EXTENDED HTTP/1.1
 Host: client.mydomain.com
 Accept: application/json
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

{ "shares": [ { "shareType": 4, "userPermission": 2, "canReshare": false, "isNotificationEnabled": true, "pendingInvitations": 0, "isExpired": false, "status": 1, "client": { "clientName": "EdgeDrive", "subclientId": 14435, "clientId": 4751, "applicationId": 33 }, "owner": { "userName": "company\\user1", "userId": 2855 }, "created": { "timeValue": "1538579737" }, "shareFolder": { "syncWebFolderId": 262173, "syncWebFolderName": "test1" }, "browseInfo": { "edgeClient": true, "cloudId": 97301, "password": { "password": "", "isSet": false }, "paths": [ { "path": "c33b0ed340284066bd23d4331c5bf354", "directory": false } ], "emailInfo": { "emailMessage": "", "browseUrl": "/webconsole/gtl.do?gid=JJgnNzY4cE7sn", "dontSendEmail": true } } } ], "resp": {}
}

Example 3: To view all the properties of a share.

Sample Request

GET <webservice>/ShareFolder?shareId=262173&shareType=SHAREDBYME&propertyLevel=ALL HTTP/1.1
 Host: client.mydomain.com
 Accept: application/json
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

{ "shares": [ { "description": "", "shareType": 4, "ciEnabled": true, "userPermission": 2, "canReshare": false, "isNotificationEnabled": true, "hasReshares": 0, "canUserEdit": true, "status": 1, "client": { "clientName": "EdgeDrive", "backupsetId": 13058, "instanceId": 1, "subclientId": 14435, "clientId": 4751, "applicationId": 33 }, "owner": { "userName": "company\\user1", "userId": 2855 }, "created": { "timeValue": "1538579737" }, "shareFolder": { "syncWebFolderId": 262173, "syncWebFolderName": "test1" }, "browseInfo": { "edgeClient": true, "cloudId": 97301, "password": { "password": "", "isSet": false }, "paths": [ { "path": "c33b0ed340284066bd23d4331c5bf354", "directory": false } ], "emailInfo": { "emailMessage": "", "browseUrl": "/webconsole/gtl.do?gid=JJgnNzY4cE7sn", "dontSendEmail": true } }, "lastModified": { "timeValue": "1538579737" } } ], "resp": {}
}