Skip to main content

archive/pages/{pageid} (GET) (SAP KC)

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:

<page.archive id="{id}" href="{uri}">
  <title>{text}</title> 
  <path>{text}</path> 
  <contents type="{contenttype}" href="{uri}" /> 
  <user.deleted id="{id}" href="{id}">
    <nick>{text}</nick> 
    <username>{text}</username> 
    <email hidden="{bool}">{text}</email> 
  </user.deleted>
  <date.deleted>{date}</date.deleted> 
</page.archive>

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

Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
p.At("archive", "pages", "10168").Get();

Sample Response from executing Code

<page.archive id="10168" href="http://deki-hayes/@api/deki/archive/pages/10168/info">
  <title>MyPage</title> 
  <path>MyPage</path> 
  <contents type="application/x.deki0702+xml" href="http://deki-hayes/@api/deki/archive/pages/10168/contents" /> 
  <user.deleted id="20" href="http://deki-hayes/@api/deki/users/20">
    <nick>BrigetteK</nick> 
    <username>BrigetteK</username> 
    <email hidden="true" /> 
  </user.deleted>
  <date.deleted>2008-05-13T22:33:14Z</date.deleted> 
</page.archive>

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 Code

curl -u admin:password -i http://mindtouch.address/@api/deki/archive/pages/1

Sample Response

page.archiveID = 588

<page.archive id="588" href="http://192.168.59.128/@api/deki/archive/pages/588/info">
  <title>Test</title>
  <path>Test</path>
  <contents type="application/x.deki0805+xml" href="http://192.168.59.128/@api/deki/archive/pages/588/contents"/>
  <user.deleted id="88" href="http://192.168.59.128/@api/deki/users/88">
    <nick>test6</nick>
    <username>test6</username>
    <email hidden="true"/>
    <hash.email>989d7c3b24422e0f2ab2da41e3a91434</hash.email>
    <uri.gravatar>http://www.gravatar.com/avatar/989d7c3b24422e0f2ab2da41e3a91434</uri.gravatar>
  </user.deleted>
  <date.deleted>2010-01-26T22:40:57Z</date.deleted>
</page.archive>

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.