The feed containing the results of an OpenSearch query consists of entries in formats defined by the individual plug-ins.
The entry format for all system plug-ins (for example, plug-ins that ship with MashupHub) is specified in the following sections. Third-party plug-ins are free to format their OpenSearch results in any manner.
The OpenSearch feed supports paging through OpenSearch extension elements under the Atom <feed>
element. The OpenSearch parameter names are case-sensitive. Following are the parameter names:
Defines the index of the first entry included in the OpenSearch feed. The index starts at 0. itemsPerPage
Defines the number of items included in the feed. totalResults
Defines the total number of results from the query. By default the OpenSearch feed starts with index 0 and include the first set of entries, according to the specified sort order, equal in number to itemsPerPage.
To page through a large result feed, use the startIndex
URL parameters on the OpenSearch query to specify the index and the number of entries to include.
A client should refer to the <category>
element in each entry to determine to what plug-in an entry belongs and how to interpret its content. A client should refer to the element name of the child element under the <content>
element to determine the collection to which an entry belongs.
The server uses the <atom:category>
element to determine which collection plug-in should handle the <entry>
element. Following are the limitations:
- An entry may be categorized in one category only.
- For categories that are used in the catalog UI to group entries, use the <catalog:categories> element in the individual entry formats.
Feed entry: imc3
The format for all system plug-ins in the feeds
collection matches the following example.
Page entry: imc3
The format for page plug-in entries in the pages collection is the following.
REST service entry: imc3
The format for REST Service plug-in entries in the services collection is the following.
Space entry: imc3
The format for Space plug-in entries in the spaces collection is the following.
iWidget entry: imc3
The format for iWidget plug-in entries in the widgets collection is the following.
Generic widget entry: imc3
The format for the generic widget plug-in entries in the widget collection is the following.
Widget template entry: imc3
The format of Widget Template plug-in entries in the widgettemplates collection is the following.
Parent topic: Search API: imc3