REST API for Content Management 1.1

Get Shared Folder Users

get

/documents/api/1.1/shares/{folderId}/items

Get information about a shared folder and the users who share it.

Request

Supported Media Types

application/json
application/xml

Path Parameters

folderId: Type: string

Required: true

Globally unique identifier (GUID) for the folder. If the referenced folder is the user's home folder, the value for folderId is self
.

Body Parameter

The request body defines details of the get shared folder users request. There are no required attributes.

Root Schema : ShareFolderUsersBody

The request body defines details of the get shared folder users request. There are no required attributes.

Properties

currentOnly: Type: string

Include only the specified folder (true) or include the specified folder along with all nested folders (false). By default, this option is false.

Example application/json


{
    "currentOnly":"true"
}

Response

Supported Media Types

application/json
application/xml

200 Response

The request was fulfilled.

Body

The response body includes information about the get shared folder users operation.

Root Schema : ShareFolderUsersResponse

The response body includes information about the get shared folder users operation.

Properties

count: Type: string

The number of items listed on the page.
errorCode: Type: string

An error code of zero (0) indicates no errors.
id: Type: string

Globally unique identifier (GUID) for the folder.
items: Type: array items

Additional Properties Allowed:
type: Type: string

Item type share.

Nested Schema : items

Type: array

Items

Type: object ShareDefinition

Additional Properties Allowed:

Share information

Nested Schema : ShareDefinition

Share information

Properties

role: Type: string

Allowed Values: [ "viewer", "downloader", "contributor" ]

Access level for the shared item.
type: Type: string

Item type share.
user: Type: object UserWithLoginName

Additional Properties Allowed:

User information.

Nested Schema : UserWithLoginName

User information.

Properties

displayName: Type: string

The display name for the user.
id: Type: string

Globally unique identifier (GUID) for the user.
loginName: Type: string

The login name for the user.
type: Type: string

Item type user.

Example application/json


{
    "count":"1",
    "id":"F1321DC48E3B123D02DBEE88T0000000000100000001",
    "type":"share",
    "errorCode":"0",
    "items":{
        "type":"share",
        "role":"manager",
        "user":{
            "id":"U7ECC74059E0FEDFEC66BF5AT00000000001",
            "displayName":"User BB",
            "loginName":"userBBLoginName",
            "type":"user"
        }
    }
}

400 Response

Request parameters are not formatted correctly.

403 Response

Forbidden if the user does not have read permission.

404 Response

Folder ID is not found.

Examples

The following example grants manager-level access to the specified folder.

GET .../shares/F1321DC48E3B123D02DBEE88T0000000000100000001/items?currentOnly=true

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "count": "1",
    "errorCode": "0",
    "id": "F1321DC48E3B123D02DBEE88T0000000000100000001",
    "type": "share",
    "items": [
        {
            "type": "share",
            "user": {
                "displayName": "User BB",
                "loginName": "userBBLoginName",
                "id": "U7ECC74059E0FEDFEC66BF5AT00000000001",
                "type": "user"
            },
            "role": "manager"
        }
    ]
}