REST API for Documents

Reserve File

post

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

Reserve the specified file. A file reservation lets other users (or processes) know that the file is in use.

Request

Supported Media Types

application/json
application/xml

Path Parameters

fileId: string

Globally unique identifier (GUID) for the file.

Header Parameters

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.

Response

Supported Media Types

application/json
application/xml

200 Response

The request was fulfilled.

Root Schema : FileReserveResponse

Type: object

The response body includes information about the reserve operation.

Show Source

errorCode(optional): number

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

Globally unique identifier (GUID) for the file.
reservationDate(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.
.
reservedBy(optional): object User

User information
type(optional): string

Item type file.

{
    "description":"The response body includes information about the reserve operation.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the file."
        },
        "reservationDate":{
            "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>."
        },
        "reservedBy":{
            "$ref":"#/definitions/User"
        },
        "type":{
            "type":"string",
            "description":"Item type <code>file</code>."
        },
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

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":"D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD",
    "reservationDate":"2015-06-15T19:34:17.000Z",
    "reservedBy":{
        "displayName":"User AA",
        "id":"U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName":"userAALoginName",
        "type":"user"
    },
    "type":"file",
    "errorCode":"0"
}

403 Response

Forbidden if the user does not have read permission.

404 Response

File ID is not found.

Examples

The following example reserves the specified file.

POST .../files/D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD/reserve

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "id": "D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD",
    "reservationDate": "2015-06-15T19:34:17Z",
    "reservedBy": {
       	"displayName": "User AA",
	"id": "U0EAA20910FAF3052ACB79E4T00000000001",
	"loginName": "userAALoginName",
	"type": "user"
    },
    "type": "file"
}

Example 2

The following example reserves 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.

POST .../files/D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD/reserve

Request Header

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "id": "D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD",
    "reservationTime": "2016-06-30T21:16:22Z",
    "reservedBy": {
        "displayName": "User BB",
        "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
        "loginName": "userBBLoginName",
        "type": "user"
    },
    "type": "file"
}

Example 3

The following example reserves 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.

POST .../files/D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD/reserve

Request Header

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "id": "D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD",
    "reservationTime": "2016-06-30T21:16:22Z",
    "reservedBy": {
        "displayName": "User BB",
        "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
        "loginName": "userBBLoginName",
        "type": "user"
    },
    "type": "file"
}

Example 4

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

POST .../files/D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD/reserve

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 403

JSON Response

{
    "errorCode": "-20",
    "errorKey": "!csFldCouldNotSetReservation!csCloudItemInsufficientPrivileges,User BB,fFileGUID:D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD,FLD_SET_RESERVATION",
    "errorMessage": "Could not set reservation. User 'User BB' has insufficient privilege to access fFileGUID:D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD with service FLD_SET_RESERVATION.",
    "id": "D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD",
    "title": "Could not set reservation. User 'User BB' has insufficient privilege to access fFileGUID:D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD with service FLD_SET_RESERVATION.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

Example 5

The following example requests reservation of the specified file. 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.

POST .../files/D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD/reserve

Request Header

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

Request Body

None.

HTTP Status Code

HTTP_STATUS = 403

JSON Response

{
    "errorCode": "-18",
    "errorKey": "!csFldCouldNotSetReservation!csAccessCodeRequiredForLinkAccess",
    "errorMessage": "Could not set reservation. The access code must be provided to access the link.",
    "id": "D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD",
    "title": "Could not set reservation. The access code must be provided to access the link.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}