Common parameters 

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. For most applications, the default is 1. For Blogs, the default is 0.
ps

Note: This parameter is called pageSize in the Files and Wikis APIs.

Page size. Specify the number of entries to return per page.
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

Note: This parameter is called sortFields in the Activities API and sortField in the Communities API. In the Bookmarks API, it is referred to as sort.

Specifies what value to use as the basis for organizing the entries returned in the feed. The options for this parameter differ by application.
sortOrder Specifies the order in which to sort the results. The options for this parameter differ by application.
tag Returns items that have been assigned the specified tag.
userid Unique ID that represents a specific person.


Parent topic

Common API


   

 

});