Get a feed of all wikis 

Get a feed that lists all of the wikis.

This returns a feed of wikis to which the authenticated user has access.

Table 1. Atom API request details

Resource address Method Input or output representation Description
/basic/api/wikis/feed GET Feed of wiki definition Atom entries Gets the collection of all wikis, including private wikis that you have access to.

Use one or more of the input parameters to narrow the search. Separate multiple parameters with an ampersand (&).

Table 2. Input parameters

Parameter Description
includeTags Specifies whether or not the tags that are displayed on the wiki welcome page are included in the returned Atom document. This parameter takes a Boolean value of either true or false. By default, the tags are not returned.
page Page number. Specifies the page to be returned. The default value is 1.
pageSize Page size. Specify the number of entries to return per page.
sI Start index. Specifies the start index (number) in the collection from which the results should be returned. This parameter is ignored if a page parameter is provided.
sortBy String. Specifies what to sort the returned entries by. Options are:
created

    Organize the entries by wiki creation date.

desc

    Organize the entries alphabetically by description.

modified

    Organize the entries by last modified date.

published

    Organize the entries by the publication date.

title

    Organize the entries by title. The title is specified in the <title> element of the entry.

sortOrder Defines the order in which to sort the results. Options are:
asc

    Ascending.

desc

    Descending. This value is the default value.


Example

To get a feed of all wikis, send the following HTTP request:

> GET /wikis/basic/api/wikis/feed HTTP/1.1
> Authorization: Basic ...
> Host: wikis.enterprise.example.com:9088
> Accept: */*

The HTTP response would look as follows:

The following content is returned by the server:


Parent topic

Getting Wikis feeds

Related reference
Wiki defintion content


August 5, 2011 12:18:46 PM
   

 

Aug 5, 2011 12:18:46 PM

});