Delete file
OVERVIEW
This API method deletes a file and placed it in the recycle bin. The file being deleted should be an active file in the system.
A separate API call is required to permanently delete the file.
A normal user cannot delete their file when document approval is enabled and the document has not been approved by the admin.
Request
DELETE /api/1/files/{fileid}
Parameters
Parameter Name | Value | Description |
---|---|---|
fileid | Int | The ID for the file in question |
Request body
No request body is required for this call.
Response
API endpoint returns a 200 OK in case of a successful operation. The API returns a 200 OK even if the document was already deleted before the API operation.
Example Response
DELETE http://clientinstance.highq.com/clientinstance/api/1/files/1234
XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
<ref>130</ref>
<summary>Access denied</summary>
</error>
JSON:
{
"summary": "Access denied",
"ref": "130",
"link": null
}
Comments
0 Comments