Community articleGetting a feed of wiki pages
Added by IBM contributorIBM on April 9, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

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



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

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

Use one or more of the input parameters to narrow the search for the GET request. Separate multiple parameters with an ampersand (&).
Input
Method URI Description
GET /wikis/basic/anonymous/api/wiki/{wiki-label}/feed A feed of all the pages in a wiki.
Name Type Optional Description
wiki-label
string No {wiki-label} is the value of the <td:label> element of the wiki.
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 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
int Yes Page number. Specifies the page to be returned. The default value is 1, which returns the first page
ps
int Yes Page size. Specifies the number of entries to return per page. The default value is 10. The maximum value you can specify is 500.
Note: This parameter replaces the pageSize parameter. The pageSize parameter is supported for backwards compatibility only; it will be deprecated in a future release.
sl
int Yes Start index. Specifies the start index (number) in the collection from which the results should be returned. The value of this parameter is ignored if a page parameter value is provided. The default value is 1.
sortBy
enumerated Yes
String. Specifies what to sort the returned entries by. Options are:
commented
Sorts the entries by the number of comments or replies an item has received.
created
Sorts the entries by the date the item was created.
downloaded
Sorts the entries by the number of times the item was downloaded. In the context of a wiki, this means the number of times a wiki page was viewed.
label
Sorts alphabetically by the label.
length
Sorts the entries by the size of the file.
published
Sorts the entries by the date the item was published (usually related to atom:published element).
recommended
Sorts the entries by the number of times the item was recommended.
title
Sorts the entries alphabetically by title. The title used is the text that is displayed in the <title> element of each entry in the feed.
totalMediaSize
Sorts the entries by the size of the media associated with the item.
updated
Sorts the entries by the last time the item was updated.
The default value is published.
Authorized values:
  • commented
  • created
  • downloaded
  • label
  • published
  • recommended
  • title
  • totalMediaSize
  • updated
sortOrder
enumerated Yes
Specifies the order in which to sort the results. The options are:
asc
Sorts the results in ascending order.
desc
Sorts the results in descending order.
Descending is the default value.
Authorized values:
  • asc
  • desc
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the request was received successfully.
References
Examples
To get a feed of pages in the myNewWiki wiki
> GET wikis/basic/anonymous/api/wiki/myNewWiki/feed HTTP/1.1

> Authorization: Basic ...

> Host: wikis.enterprise.example.com:9088

> Accept: */*