REST API for Documents

Edit File

put

/documents/api/1.2/files/{fileId}

Change the name of the specified file.

Request

Supported Media Types

application/json
application/xml

Path Parameters

fileId: string

Globally unique identifier (GUID) for the file.

Header Parameters

accessToken(optional): string

Applink access token authorizing the current user to access the parent folder or this file. 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 the parent folder or this file. 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 file. 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 file request. There are no required attributes.

Root Schema : FileEditBody

Type: object

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

Show Source

name(optional): string

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

{
    "description":"<p>The request body defines details of the edit file request. There are no required attributes.</p>",
    "properties":{
        "name":{
            "type":"string",
            "description":"(Optional) Specify the name to assign to the file."
        }
    }
}

Example Request (application/json)

{
    "name":"filev4.txt"
}

Response

Supported Media Types

application/json
application/xml

200 Response

The request was fulfilled.

Root Schema : FileResponse

Type: object

The response body includes information about the file.

Show Source

errorCode(optional): number

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

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

Match All

Show Source

object FileDefinition

File information

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

Nested Schema : FileDefinition

Type: object

File information

Show Source

createdBy(optional): object User

User information
createdTime(optional): string

File creation date.
id(optional): string

Globally unique identifier (GUID) for the file.
mimeType(optional): string

File format of the file.
modifiedBy(optional): object User

User information
modifiedTime(optional): string

File last modified date.
name(optional): string

File 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.
reservationTime(optional): string

Time the file was reserved (excluded from response data if the file is not reserved).
reservedBy(optional): object User

User information
size(optional): string

Size of the file in bytes.
type(optional): string

Item type file.
version(optional): string

File version.

{
    "description":"File information",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the file."
        },
        "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":"File name."
        },
        "mimeType":{
            "type":"string",
            "description":"File format of the file."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>file</code>."
        },
        "size":{
            "type":"string",
            "description":"Size of the file in bytes."
        },
        "version":{
            "type":"string",
            "description":"File version."
        },
        "createdTime":{
            "type":"string",
            "description":"File creation date."
        },
        "modifiedTime":{
            "type":"string",
            "description":"File last modified date."
        },
        "reservationTime":{
            "type":"string",
            "description":"Time the file was reserved (excluded from response data if the file is not reserved)."
        },
        "createdBy":{
            "$ref":"#/definitions/User"
        },
        "ownedBy":{
            "$ref":"#/definitions/User"
        },
        "modifiedBy":{
            "$ref":"#/definitions/User"
        },
        "reservedBy":{
            "$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":"D574378400573ED9D62B3195T0000000000100000001",
    "parentID":"FB4CD874EF94CD2CC1B60B72T0000000000100000001",
    "name":"filev4.txt",
    "type":"file",
    "size":"13",
    "version":"4",
    "createdTime":"2014-02-21T21:32:37Z",
    "modifiedTime":"2014-02-21T21:32:37Z",
    "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 read permission.

404 Response

File ID is not found.

Examples

The following example renames the specified file.

PUT .../files/D574378400573ED9D62B3195T0000000000100000001

Request Header

None.

Request Body

{
    "name": "filev4.txt"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "createdBy": {
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "createdTime": "2014-02-21T21:15:57Z",
    "errorCode": "0",
    "id": "D574378400573ED9D62B3195T0000000000100000001",
    "modifiedBy": {
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName": "userAALoginName",   
        "type": "user"
    },
    "modifiedTime": "2014-02-21T21:21:27Z",
    "name": "filev4.txt",
    "ownedBy": {
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName": "userAALoginName",        
        "type": "user"
    },
    "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
    "size": "13",
    "type": "file",
    "version": "4"
}

Example 2

The following example renames the specified file. The example uses a public link ID because this file is under a folder structure not owned by or shared with the current user.

PUT .../files/D574378400573ED9D62B3195T0000000000100000001

Request Header

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

Request Body

{
    "name": "filev4.txt"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "createdBy": {
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "createdTime": "2014-02-21T21:15:57Z",
    "errorCode": "0",
    "id": "D574378400573ED9D62B3195T0000000000100000001",
    "modifiedBy": {
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "modifiedTime": "2014-02-21T21:21:27Z",
    "name": "filev4.txt",
    "ownedBy": {
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
    "size": "13",
    "type": "file",
    "version": "4"
}

Example 3

The following example renames the specified file. The example uses a public link ID protected by an access code because this file 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 .../files/D574378400573ED9D62B3195T0000000000100000001

Request Header

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345

Request Body

{
    "name": "filev4.txt"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "createdBy": {
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "createdTime": "2014-02-21T21:15:57Z",
    "errorCode": "0",
    "id": "D574378400573ED9D62B3195T0000000000100000001",
    "modifiedBy": {
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "modifiedTime": "2014-02-21T21:21:27Z",
    "name": "filev4.txt",
    "ownedBy": {
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
    "size": "13",
    "type": "file",
    "version": "4"
}

Example 4

The following example requests file renaming. Because this file is under a folder structure not owned by or shared with the current user, an access denied error message is returned.

PUT .../files/D574378400573ED9D62B3195T0000000000100000001

Request Header

None.

Request Body

{
    "name": "filev4.txt"
}

HTTP Status Code

HTTP_STATUS = 403

JSON Response

{
    "errorCode": "-20",
    "errorKey": "!csFldUnableToEditDocumentLink!csCloudItemInsufficientPrivileges,User BB,fFileGUID:D574378400573ED9D62B3195T0000000000100000001,FLD_EDIT_FILE",
    "errorMessage": "Unable to edit foldering information. User 'User BB' has insufficient privilege to access fFileGUID:D574378400573ED9D62B3195T0000000000100000001 with service FLD_EDIT_FILE.",
    "errorType": "file",
    "id": "D574378400573ED9D62B3195T0000000000100000001",
    "name": "filev4.txt",
    "title": "Unable to edit foldering information. User 'User BB' has insufficient privilege to access fFileGUID:D574378400573ED9D62B3195T0000000000100000001 with service FLD_EDIT_FILE.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

Example 5

The following example requests file renaming. This file 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 .../files/D574378400573ED9D62B3195T0000000000100000001

Request Header

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

Request Body

{
    "name": "filev4.txt"
}

HTTP Status Code

HTTP_STATUS = 403

JSON Response

{
    "errorCode": "-18",
    "errorKey": "!csFldUnableToEditDocumentLink!csAccessCodeRequiredForLinkAccess",
    "errorMessage": "Unable to edit foldering information. The access code must be provided to access the link.",
    "errorType": "file",
    "id": "D574378400573ED9D62B3195T0000000000100000001",
    "name": "filev4.txt",
    "title": "Unable to edit foldering information. 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 renames the specified file. The example uses an applink because this file 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 .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518

Request Header

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

Request Body

{
    "name": "fileViaApplink-renamed.txt"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "createdBy": {
        "displayName": "User BB",
        "id": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "type": "user"
    },
    "createdTime": "2017-06-26T15:29:00Z",
    "errorCode": "0",
    "id": "DED694950C14AFF280419F9AB5D17B95F47087F4E518",
    "mimeType": "text/plain",
    "modifiedBy": {
        "displayName": "User BB",
        "id": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "type": "user"
    },
    "modifiedTime": "2017-06-26T20:27:23Z",
    "name": "fileViaApplink-renamed.txt",
    "ownedBy": {
        "displayName": "User AA",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "parentID": "FDC22B65E850730CAA60AF83B5D17B95F47087F4E518",
    "size": "29",
    "type": "file",
    "version": "2"
}