Get a feed of wiki pages 

Get a feed that lists all of the pages in a specific wiki.

This returns a feed of the pages in a given wiki.

Table 1. Atom API request details

Resource address Method Input or output representation Description
/basic/anonymous/api/wiki/{wiki-label}/feed GET Feed of wiki page entries A feed of all the pages in a wiki.


{wiki-label} is the value of the <td:label> element of the wiki.

Use one or more of the input parameters to narrow the search for 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 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.
searchString Specifies an optional search string. Only media whose title contains the string will be returned.
sortBy 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.

label

    Organize the entries alphabetically by page label.

modified

    Organize the entries by last modified date.

published

    Organize the entries by the publication date.

recommended

title

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

totalMediaSize

    Organize the entries by total page media size.

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 pages in the myNewWiki wiki, send the following HTTP request:

> GET wikis/basic/anonymous/api/wiki/myNewWiki/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 page content


   

 

});