Retrieving a wiki
Added by IBM contributorIBM | Edited by IBM contributorPaul Bastide on December 21, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

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.

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 (&).

 

Input
Method URI Description
GET /wikis/{auth}/api/wiki/{wiki-label}/entry Retrieves the Atom document representation of the wiki after authenticating the request. Alternatively, use 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.
Note: Use this URI to retrieve the Atom document if you plan to update the document and return it using a PUT request.
GET /wikis/{auth}/anonymous/api/wiki/{wiki-label}/entry
Content Type: application/atom+xml
Name Type Optional Description
wiki-label
string No The value of the <td:label> element in the wiki definition Atom entry document
The label is also the Community Uuid
auth
enumerated No The authorization protocol being used by your application to access Connections Cloud. `
Authorized values:
  • basic
  • oauth
Name Type Optional Description
acls
boolean Yes 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
boolean Yes 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.
Name Type Optional Description
Authorization
enumerated No The authentication mechanism selected by your application to access the API.
Basic is the Base64 encoding of the IBM Connections Cloud username and password: Base64(username:password). For example, Base64(twatson@us.ibm.com:password).
Bearer is the oauth 2.0 access token that is generated when the user grants your application access to IBM Connections Cloud services.
See the reference topic "OAuth 2.0 APIs for web server flow" for more information.
Authorized values:
  • bearer
  • basic
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the request was received successfully.
401
Unauthorized. Returned when no authenticated user or no userid, email, or key parameter are provided on the request.
404
page not found