ShowTable of Contents
This content applies to Lotus Quickr 8.5 for WebSphere Portal only.
The API for retrieving an application content through a Seedlist is based on the REST architecture style. Thus, third party crawler or administrator application only need to construct and send HTTP requests to the Application Servlet for obtaining the Seedlist content.
All REST API requests are synchronous calls. The order of the parameters in the requests do not matter. The parameter names are case-sensitive; they must be entered in the format documented. Any unknown or unsupported parameters submitted as part of a request will result in an HTTP error response (status code 404).
The request is a standard HTTP GET command. The URL is formed by combining the Seedlist Servlet host name, port and path; as well as a collection of name-value pairs (input parameters) separated by & characters.
Some examples are listed below:
* seedlist/server for anonymous access
* seedlist/myserver for authenticated access
The parameters are divided into public
Public URL Parameters
|Start ||defines start number for currently returned section ||0|
|Range ||defines number of returned entries for current section ||100|
|Date ||entries (documents) that were updated after this date will be retrieved. The date format (compliant to standard ISO 8601) is the following : T||Default?|
|Action ||defines requested action to execute :
- GetChildren - retrieve immediate children(seedlists+documents)
- GetDocuments - retrieve all underlying documents
- GetNumberOfDocuments - return number of all underlying documents, mostly, for debug purposes. Must be the same as number of all documents from appropriate GetDocuments request)
|Format ||defines output format : ATOM / HTML/ XML||ATOM|
|Locale ||Locale of request client (See ISO 639 and ISO 3166 for valid values, e.g. "en_US" ) ||servlet request locale |
|Timestamp ||Content Provider timestamp from previous crawling. The timestamp represents for the Content Provider some snapshot of the content and allows the crawler to get only the delta of content changes on the next crawling. This is used for incremental crawling. ||Default?|
Internal URL Parameters
|SeedlistId||is ID string that represents required seedlist node (no SeedlistId means root id) ||0|
|State|| is a serialized representation of the ongoing crawling state for current seedlist. This information is internal for the Content Provider and used for optimization ||100|
We are assuming that the client which sent the request is already authenticated and logged in.