REST API for Documents

Edit Folder

put

/documents/api/1.2/folders/{folderId}

Change the name or the description of the specified folder.

Request

Supported Media Types

application/json
application/xml

Path Parameters

folderId: string

Globally unique identifier (GUID) for the folder.

Header Parameters

accessToken(optional): string

Applink access token authorizing the current user to access this folder. This parameter is mandatory if appLinkID is used. It can be used as accessToken or AccessToken.
appLinkID(optional): string

Applink ID authorizing the current user to access this folder. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. To work, this applink must have at least the contributor role granted. It can be used as appLinkID or AppLinkID.
dAccessCode(optional): string

Access code needed to use protected public links. It needs to be sent as part of a Cookie header in the following format: dAccessCode-<linkID>=<passcodeValue>
linkID(optional): string

Public link ID of a public link authorizing the current user to access this folder. To work, this public link must have the contributor role granted. It can be used as linkID or LinkID.

The request body defines details of the edit folder request. There are no required attributes.

Root Schema : FolderEditBody

Type: object

The request body defines details of the edit folder request. There are no required attributes.

Show Source

description(optional): string

(Optional) Specify a description for the folder.
name(optional): string

(Optional) Specify the name to assign to the folder.

{
    "description":"The request body defines details of the edit folder request. There are no required attributes.",
    "properties":{
        "name":{
            "type":"string",
            "description":"(Optional) Specify the name to assign to the folder."
        },
        "description":{
            "type":"string",
            "description":"(Optional) Specify a description for the folder."
        }
    }
}

Example Request (application/json)

{
    "name":"backup",
    "description":"my backup folder"
}

Response

Supported Media Types

application/json
application/xml

200 Response

The request was fulfilled.

Root Schema : FolderResponse

Type: object

The response body includes information about the folder.

Show Source

errorCode(optional): string

An error code of zero (0) indicates no errors.

{
    "description":"The response body includes information about the folder.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/FolderDefinition"
        }
    ],
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

Match All

Show Source

object FolderDefinition

Folder metadata information.

{
    "description":"The response body includes information about the folder.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/FolderDefinition"
        }
    ],
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

Nested Schema : FolderDefinition

Type: object

Folder metadata information.

Show Source

childitemsCount(optional): string

Number of items contained in the folder.
createdBy(optional): object User

User information
createdTime(optional): string

Date the folder was created.
description(optional): string

Folder description.
id(optional): string

Globally unique identifier (GUID) for the folder.
modifiedBy(optional): object User

User information
modifiedTime(optional): string

Date the folder was last modified.
name(optional): string

Folder name.
ownedBy(optional): object User

User information
parentID(optional): string

Globally unique identifier (GUID) for the parent folder. If the parent folder is the user's home folder, the value for parentID is self.
size(optional): string

Size of the folder in bytes, including all of the files and folders contained in the folder.
type(optional): string

Item type folder.

{
    "description":"Folder metadata information.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the folder."
        },
        "parentID":{
            "type":"string",
            "description":"<p>Globally unique identifier (GUID) for the parent folder. If the parent folder is the user&#39;s home folder, the value for <code>parentID</code> is <code>self</code>.</p>"
        },
        "name":{
            "type":"string",
            "description":"Folder name."
        },
        "description":{
            "type":"string",
            "description":"Folder description."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>folder</code>."
        },
        "size":{
            "type":"string",
            "description":"Size of the folder in bytes, including all of the files and folders contained in the folder."
        },
        "childitemsCount":{
            "type":"string",
            "description":"Number of items contained in the folder."
        },
        "createdTime":{
            "type":"string",
            "description":"Date the folder was created."
        },
        "modifiedTime":{
            "type":"string",
            "description":"Date the folder was last modified."
        },
        "createdBy":{
            "$ref":"#/definitions/User"
        },
        "ownedBy":{
            "$ref":"#/definitions/User"
        },
        "modifiedBy":{
            "$ref":"#/definitions/User"
        }
    }
}

Nested Schema : User

Type: object

User information

Show Source

displayName(optional): string

The display name for the user.
id(optional): string

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

The login name for the user.
type(optional): string

Item type user.

{
    "description":"User information",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the user."
        },
        "displayName":{
            "type":"string",
            "description":"The display name for the user."
        },
        "loginName":{
            "type":"string",
            "description":"The login name for the user."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>user</code>."
        }
    }
}

Example Response (application/json)

{
    "id":"F512DA3911603E8AB84A07ACT0000000000100000001",
    "parentID":"FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "name":"backup",
    "description":"my backup folder",
    "type":"folder",
    "size":"0",
    "childItemsCount":"0",
    "createdTime":"2014-02-21T20:56:07Z",
    "modifiedTime":"2014-02-21T20:59:57Z",
    "createdBy":{
        "displayName":"User AA",
        "id":"U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName":"userAALoginName",
        "type":"user"
    },
    "ownedBy":{
        "displayName":"User AA",
        "id":"U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName":"userAALoginName",
        "type":"user"
    },
    "modifiedBy":{
        "displayName":"User AA",
        "id":"U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName":"userAALoginName",
        "type":"user"
    },
    "errorCode":"0"
}

400 Response

Request parameters are not formatted correctly.

403 Response

Forbidden if the user does not have write permission.

404 Response

Folder ID is not found.

Examples

The following example changes the name of the specified folder.

PUT .../folders/F512DA3911603E8AB84A07ACT0000000000100000001

Request Header

None.

Request Body

{
    "name": "backup",
    "description": "my backup folder"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "childItemsCount": "0",
    "createdBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "createdTime": "2014-02-21T20:56:07Z",
    "description": "my backup folder",
    "errorCode": "0",
    "id": "F512DA3911603E8AB84A07ACT0000000000100000001",
    "modifiedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "modifiedTime": "2014-02-21T20:59:57Z",
    "name": "backup",
    "ownedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "parentID": "FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "size": "0",
    "type": "folder"
}

Example 2

The following example changes the name and description of the specified folder. The example uses a public link ID because this folder is under a folder structure not owned by or shared with the current user.

PUT .../folders/F81175D40FF57F19884AED0CB5D17B95F47087F4E518

Request Header

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

Request Body

{
    "name": "UserBBFolderUpdated",
    "description": "User BB folder created via public link - updated"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "childItemsCount": "0",
    "createdBy": {
        "displayName": "User BB",
        "loginName": "userBBLoginName",
        "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
        "type": "user"
    },
    "createdTime": "2016-06-30T23:34:21Z",
    "description": "User BB folder created via public link - updated",
    "errorCode": "0",
    "id": "F81175D40FF57F19884AED0CB5D17B95F47087F4E518",
    "modifiedBy": {
        "displayName": "User BB",
        "loginName": "userBBLoginName",
        "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
        "type": "user"
    },
    "modifiedTime": "2016-06-30T23:42:44Z",
    "name": "UserBBFolderUpdated",
    "ownedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "type": "user"
    },
    "parentID": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518",
    "size": "0",
    "type": "folder"
}

Example 3

The following example changes the name and description of the specified folder. The example uses a public link ID protected by an access code because this folder is under a folder structure not owned by or shared with the current user. An access code (test12345) is submitted as part of a Cookie in the request header.

PUT .../folders/F81175D40FF57F19884AED0CB5D17B95F47087F4E518

Request Header

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345

Request Body

{
    "name": "UserBBFolderUpdated",
    "description": "User BB folder created via public link - updated"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "childItemsCount": "0",
    "createdBy": {
        "displayName": "User BB",
        "loginName": "userBBLoginName",
        "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
        "type": "user"
    },
    "createdTime": "2016-06-30T23:34:21Z",
    "description": "User BB folder created via public link - updated",
    "errorCode": "0",
    "id": "F81175D40FF57F19884AED0CB5D17B95F47087F4E518",
    "modifiedBy": {
        "displayName": "User BB",
        "loginName": "userBBLoginName",
        "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
        "type": "user"
    },
    "modifiedTime": "2016-06-30T23:42:44Z",
    "name": "UserBBFolderUpdated",
    "ownedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "type": "user"
    },
    "parentID": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518",
    "size": "0",
    "type": "folder"
}

Example 4

The following example requests a name and description update for the specified folder. Because this folder is under a folder structure not owned by or shared with the current user, an access denied error message is returned.

PUT .../folders/F81175D40FF57F19884AED0CB5D17B95F47087F4E518

Request Header

None.

Request Body

{
    "name": "UserBBFolderUpdated",
    "description": "User BB folder created via public link - updated"
}

HTTP Status Code

HTTP_STATUS = 403

JSON Response

{
    "description": "User BB folder created via public link - updated",
    "errorCode": "-20",
    "errorKey": "!csFldUnableToEditFolder!csCloudItemInsufficientPrivileges,User BB,fFolderGUID:F81175D40FF57F19884AED0CB5D17B95F47087F4E518,FLD_EDIT_FOLDER",
    "errorMessage": "Unable to edit folder. User 'User BB' has insufficient privilege to access fFolderGUID:F81175D40FF57F19884AED0CB5D17B95F47087F4E518 with service FLD_EDIT_FOLDER.",
    "errorType": "folder",
    "id": "F81175D40FF57F19884AED0CB5D17B95F47087F4E518",
    "name": "UserBBFolderUpdated",
    "title": "Unable to edit folder. User 'User BB' has insufficient privilege to access fFolderGUID:F81175D40FF57F19884AED0CB5D17B95F47087F4E518 with service FLD_EDIT_FOLDER.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

Example 5

The following example requests a name and description update for the specified folder. This folder is under a folder structure not owned by or shared with the current user, and only a public link protected by an access code is available. An error is returned because the access code was not submitted as part of the request.

PUT .../folders/F81175D40FF57F19884AED0CB5D17B95F47087F4E518

Request Header

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

Request Body

{
    "name": "UserBBFolderUpdated",
    "description": "User BB folder created via public link - updated"
}

HTTP Status Code

HTTP_STATUS = 403

JSON Response

{
    "description": "User BB folder created via public link - updated",
    "errorCode": "-18",
    "errorKey": "!csFldUnableToEditFolder!csAccessCodeRequiredForLinkAccess",
    "errorMessage": "Unable to edit folder. The access code must be provided to access the link.",
    "errorType": "folder",
    "id": "F81175D40FF57F19884AED0CB5D17B95F47087F4E518",
    "name": "UserBBFolderUpdated",
    "title": "Unable to edit folder. The access code must be provided to access the link.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

Example 6

The following example changes the description of the specified folder. The example uses an applink because this folder is under a folder structure not owned by or shared with the current user. The applink ID and access token are submitted in the request header.

PUT .../folders/F64529EF770DCF96F029ED82B5D17B95F47087F4E518

Request Header

appLinkID: LF5Bxj4TPo_p4n4qWn0tbKTicR2cTUJKv7X_ng9E7ry93rRuDokPqS1d6-wKwhb_wtcGYFDsI_cNMxeKQ-HR-FXQhiVoGRTYM_MPZY8qpICfYU94mmnMjM_cvsRhKMzc0NJgvwEJfqqDwPsAVrhc8cmg==
accessToken: 352FpiMmW66PeYI1Gh5b83I9CXRwZhLfYAu4TXdqpzD8uNKUBMZVVJ3ZvivUW8kQ

Request Body

{
    "description": "subFolderTestByUserB CONTRIBUTOR applink - EDITED"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "childItemsCount": "1",
    "createdBy": {
        "displayName": "User BB",
        "id": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "type": "user"
    },
    "createdTime": "2017-06-16T18:10:05Z",
    "description": "subFolderTestByUserB CONTRIBUTOR applink - EDITED",
    "errorCode": "0",
    "id": "F64529EF770DCF96F029ED82B5D17B95F47087F4E518",
    "modifiedBy": {
        "displayName": "User BB",
        "id": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "type": "user"
    },
    "modifiedTime": "2017-06-19T20:11:33Z",
    "name": "subFolderTestByUserB",
    "ownedBy": {
        "displayName": "User AA",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "parentID": "FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518",
    "size": "0",
    "type": "folder"
}