Home
Retrieving a wiki page
Retrieve an Atom document of a wiki page.
This method returns the Atom entry of a wiki as opposed to a feed of the wiki. To retrieve a feed, see Getting Wikis feeds.
You do not need to authenticate with the server to send a request to retrieve public resources. If authentication is provided, the user must have permission to view the specified resource.
Atom API request details
Method URI Output representation Description GET Construct the URI using the following syntax: /basic/anonymous/api/wiki/{wiki-label}/page/{page-label}/entry wiki page Returns a wiki page without authenticating the request. GET Determine the resource URI in either of the following ways:
- Value of the href attribute of the rel=edit link element for each wiki page Atom entry, which are provided in the wiki pages collection.
- You can construct the URI using the following syntax: /basic/api/wiki/{wiki-label}/page/{page-label}/entry
wiki page Returns a wiki page after authenticating the request. Use this URI to retrieve the Atom document if you plan to update the document and return it using a PUT request.
{wiki-label} is the value of the <td:label> element in the wiki definition Atom entry document and {page-label} is the value of the <td:label> element in the wiki page Atom document.
You can use one or more of these input parameters with the GET request. Separate multiple parameters with an ampersand (&).
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. includeTags Specifies whether or not the tags that are displayed on the wiki welcome page should be included in the returned Atom document. This parameter takes a Boolean value of either true or false. By default, the tags are not returned.
Input
None.
Output
An Atom entry document containing the wiki page entry. Returned HTTP Headers
- HTTP/1.1 200 OK
- Indicates that the wiki page entry was successfully found and returned. If an error occurs, this header will contain one of the error codes below.
- Content-Type: application/atom+xml
- Indicates that the document returned contains data in Atom format.
Error codes
- HTTP/1.1 401 Unauthorized
- HTTP/1.1 404 Not Found
Related reference