Check out a File
get
/api/restapi/document/file/{id}/checkout
Send a request to this endpoint to check out a file. A copy of file will also be downloaded after checkout.
- To checkout a file which has scan status SCAN_PENDING or SCAN_ERROR or SCAN_INCONCLUSIVE or SCAN_FAILED, send the corresponding scan status or combination of scan statuses (comma separated) in the query parameter.
- A file which has a scan status SCAN_FAILED can be checked out but the file will not be downloaded.
- scanStatus query parameter is not required to checkout a file which has scan status SCAN_CLEARED or SCAN_DISABLED
Request
Path Parameters
-
id(required): integer(int64)
The system-generated identifier of a file.
Query Parameters
-
scanStatus: string
Allowed Values : One or more from [ SCAN_PENDING, SCAN_ERROR, SCAN_INCONCLUSIVE, SCAN_FAILED ] separated by comma.
- Send this query parameter to checkout the file which has the specified scan status.
- Example : "scanStatus=SCAN_PENDING,SCAN_ERROR". The File will be checked out even if the scan status is SCAN_PENDING or SCAN_ERROR
There's no request body for this operation.
Back to TopResponse
200 Response
Successful operation
204 Response
The file which has a scan status SCAN_FAILED will be checked out but cannot be downloaded.
400 Response
The file is already checked out by another user.
404 Response
The requested file does not exist, or you do not have access to it.