Retrieve a wiki
Retrieve an Atom document of a wiki.This method returns the Atom entry of a wiki as opposed to a feed of the wiki. If you want 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.
Table 1. Atom API request details
Method URI Output representation Description GET Construct the URI using the following syntax: /basic/anonymous/api/wiki/{wiki-label}/entry wiki definition Retrieves the Atom document representation of the wiki without authenticating the request. GET Determine the resource URI in either of the following ways:
- The value of the href attribute of the <link rel="edit"> or <link rel="self"> elements in the wiki definition Atom entry of the wiki, which is available from the public wikis, available wikis collection, or my wikis feed.
- You can construct the URI using the following syntax: /basic/api/wiki/{wiki-label}/entry
wiki definition Retrieves the Atom document representation of the wiki after authenticating the request. Note: Use this URI to retrieve the Atom document if you plan to update the document and return it using a PUT request.
Note: {wiki-label} is the value of the <td:label> element in the wiki definition Atom entry document.You can use one or more of these input parameters with the GET request. Separate multiple parameters with an ampersand (&).
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. 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 definition entry.Returned HTTP headers
HTTP/1.1 200 OK
Indicates that the wiki definition 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.
- HTTP/1.1 401 Unauthorized
- HTTP/1.1 404 Not Found
Parent topic
Work with wikisRelated reference
Wiki defintion content
});