File resource

Delete file from recycle bin

OVERVIEW

This API method deletes a file from the recycle bin. The file is permanently deleted from the system and cannot be retrieved after the operation.

The operation fails and returns an access denied message if the target file does not exist.

Request

DELETE       /api/1/files/{fileid}/recycle

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.

 

Example Response:

DELETE        http://clientinstance.highq.com/clientinstance/api/1/files/123/recycle

 

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

Last Updated: Jun 09,2023