Retrieve a file from the trash
Retrieve a file from the recycle bin.This method returns the Atom document of the file. If you want to retrieve a feed, see Getting a feed of the files in the recycle bin.
See Authenticating requests for information about how to authenticate the request. The requestor must have permission to access the specified file.
Table 1. Atom API request details
Method URI Output representation Description GET /basic/api/userlibrary/{userid}/recyclebin/{document-id}/entry file Atom document Returns a file from the specified user's recycle bin. GET /basic/api/myuserlibrary/recyclebin/{document-id}/entry file Atom document Returns a file from your recycle bin.
- {userid} is the value of the <snx:userid> of the person who owns the file. See Search Profiles for information about how to determine a person's user ID.
- {document-id} is the value of the <td:uuid> of the file and can be found in the file's Atom document.
You can use this input parameters with the GET request.
Table 2. Input parameters
Parameter Description acls Specifies whether or not the permissions for each user should be displayed for each entry in the returned Atom document. This parameter takes a Boolean value of either true or false. By default, the permission information is not returned.
Input
None.
Output
An Atom entry document representing the file.Returned HTTP headers
HTTP/1.1 200 OK
Indicates that the file was successfully found and returned. If an error occurs, this header contains one of the error codes.
Content-Type: application/atom+xml
Indicates that the document returned contains data in Atom format.
- HTTP/1.1 401 Unauthorized
- HTTP/1.1 404 Not Found
Parent topic
Work with files in the trash
});