Get a feed that lists all of the wikis of which the authenticated user is a member.
This returns a feed of wikis of which the authenticated user is a member.
Table 1. Atom API request details
| /basic/api/mywikis/feed||A feed of all wikis that the authenticated user is a member of.|
Use one or more of the input parameters to narrow the search. Separate multiple parameters with an ampersand (&).
Table 2. Input parameters
|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.|
|role||Limits the wikis returned to only those that the authenticated user has the specified role in. Options are:
The default value is reader.|
|page||Page number. Specifies the page to be returned. The default value is 1, which returns the first page.|
|ps||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.
|sI||Start index. Number. Specifies the start index in the collection from which the results should be returned. This parameter is ignored if a page parameter is provided. The default value is 1.|
|sortBy||String. Specifies what to sort the returned entries by. Options are:|
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.desc
Sorts the entries alphabetically by description.downloaded
Sorts the entries by the number of times the item was downloaded. In this context, it means the number of times the page was viewed.modified
Sorts the entries by the last modified date.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.updated
Sorts the entries by the last time the item was updated.The default value is modified.
|sortOrder||Specifies the order in which to sort the results. The options are: |
Sorts the results in ascending order.desc
Sorts the results in descending order.Descending is the default value.
To get a feed of all the wikis that the authenticated user is a member of, send the following HTTP request:
Parent topic: Getting Wikis feeds
> GET /wikis/basic/api/mywikis/feed HTTP/1.1
> Authorization: Basic ...
> Host: wikis.enterprise.example.com:9088
> Accept: */*