Community articleCommon parameters
Added by IBM contributorIBM on June 19, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Lists the parameters that can be used on most subscription API requests.



Lists the parameters that can be used on most subscription API requests.

The following parameters can be included with the input parameters for most requests to retrieve subscription feeds. They may differ slightly by application and by the feed being returned. See the Getting feeds sections for each application API for more information about the parameters supported for a specific feed request.

Table 1. Input parameters

Parameter
Description
email
Internet email address of a user.

Format the HTTP request using the proper URL encoding. For example, the encoded form of the @ symbol is %40 as in:

adam_eventide%40garden.com


Note: Do not use this parameter if IBM® Connections is configured to prevent email addresses from being displayed. Use the userid parameter instead.
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 size accepted differs by application.
search
Well-formed full text search query.
since
Includes items updated after a specified date. For most features, you specify the date using a date-time value that conforms to RFC3339. Use an upper case "T" to separate the date and time, and an uppercase "Z" in the absence of a numeric time zone offset. For example: 2009-01-04T20:32:31.171Z. For Activities, Files, and Forums, you specify the date in the number of milliseconds since January 1, 1970, 00:00:00 GMT time.
sortBy
Specifies what value to use as the basis for organizing the entries returned in the feed. The options for this parameter differ by application. They include the options described in the list below. Not every option is supported on every request; see the application-specific API documentation for more information.
author
Sorts the entries alphabetically by the name of the author of the item.
commented
Sorts the entries by the number of comments or replies an item has received.
count
Sorts the entries by the number of members that belong to the item.
created
Sorts the entries by the date the item was created.
createdBy
Sorts the entries alphabetically by the name of the user who created the item.
date
Sorts the entries by the date on which it was changed to its current moderation status.
desc
Sorts the entries alphabetically by description.
displayName
Sorts the entries alphabetically by display name.
displayOrder
Sorts the entries in the order chosen by the user in the pinned views in the product user interface.
downloaded
Sorts the entries by the number of times the item was downloaded.
itemCount
Sorts the entries by the number of items associated with the item.
label
Sorts alphabetically by the label.
length
Sorts the entries by the size of the file.
modified
Sorts the entries by the last modified date.
popularity
Sorts the entries by how popular the item is.
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.
sharedBy
Sorts the entries alphabetically by the name of the person who shared the item.
sharedWith
Sorts the entries alphabetically by the name of the person with whom the item was shared.
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.
sortOrder
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.
tag
Returns items that have been assigned the specified tag.
userid
Unique ID that represents a specific person.