Overview
Retrieve basic page information for the deleted page
- REST Method: GET
- Method Access: public
Uri Parameters
Name |
Type |
Description |
pageid |
string |
An integer page ID of a deleted page |
Query Parameters
Name |
Type |
Description |
authenticate |
bool? |
Force authentication for request (default: false) |
Return Codes
Name |
Value |
Description |
OK |
200 |
The request completed successfully |
Forbidden |
403 |
Administrator access is required |
Message Format
Output:
01 | < page.archive id = "{id}" href = "{uri}" > |
04 | < contents type = "{contenttype}" href = "{uri}" /> |
05 | < user.deleted id = "{id}" href = "{id}" > |
07 | < username >{text}</ username > |
08 | < email hidden = "{bool}" >{text}</ email > |
10 | < date.deleted >{date}</ date.deleted > |
Implementation Notes
When a page is deleted, the page and all files on it are moved into the archive. A page is never permanently deleted; it will remain in the archive until it is restored (POST:archive/pages/{pageid}/restore). While a page is in the archive, it cannot be modified.
Use GET:archive/pages to retrieve a list of pages currently in the archive. You can call GET:archive/pages/{pageid}/info and receive the same response.
C# Code Sample: Retrieve Archived Page Info
The following code example retrieves a summary of all information available for the archived page ID 10168:
Sample Code
2 | p.At( "users" , "authenticate" ).WithCredentials( "admin" , "password" ).Get(); |
3 | p.At( "archive" , "pages" , "10168" ).Get(); |
Sample Response from executing Code
06 | < nick >BrigetteK</ nick > |
07 | < username >BrigetteK</ username > |
08 | < email hidden = "true" /> |
10 | < date.deleted >2008-05-13T22:33:14Z</ date.deleted > |
Implementation notes
Add notes about requirements or config values
Curl Code Sample: Retrieve Archived Page Info
The following command retrieves information of an archived page with page.archive ID = 1:
Sample Response
page.archiveID = 588
07 | < username >test6</ username > |
08 | < email hidden = "true" /> |
09 | < hash.email >989d7c3b24422e0f2ab2da41e3a91434</ hash.email > |
12 | < date.deleted >2010-01-26T22:40:57Z</ date.deleted > |
Implementation notes
curl flags
- -u
- Provides external user authentication.
- -i
- Outputs the HTTP response headers. Useful for debugging.
Permissions
- ADMIN permission is required to execute above command.
Archived Pages
- To view a list of archived pages, follow the instructions here.