Seedlist 1.0 REST service API

Seedlist 1.0 REST service API

The IBM Lotus Web Content Management API for retrieving application content through a seedlist is based on the REST architecture style. To obtain seedlist content, third party crawlers or administrator applications only need to construct and send HTTP requests to the application servlet. With seedlist format 1.0, the syntax of the seedlist URL has changed All REST API requests are synchronous calls. The order of the parameters in the requests does not matter. The parameter names are case-sensitive and must be entered in the format described here. An HTTP error response (status code 404) is generated in the following situations:

An unknown or unsupported parameter is submitted as part of the request.
Web Content Management cannot resolve the site path or ID.
Web Content Management cannot find any items.

The request is a standard HTTP GET command. The URL is formed by combining the seedlist servlet host name, port number, and path; followed by a collection of name-value pairs (input parameters) separated by ampersand (&) characters.
https://hostname:port_number/seedlist/myserver? SeedlistId=seedlistID OR path_to_site&Source=com.ibm.workplace.wcm.plugins.seedlist.retriever. WCMRetrieverFactory&Action=GetDocuments
seedlist/server is used for anonymous access.
seedlist/myserver is used for authenticated access.

Parameter Default Value Description
SeedlistID No default; must be specified. Identifies the seedlist. This parameter can be specified in either of the following ways:

The UUID of the site.
The path to the site.
For example, library_name/site

Start 0 Defines the start number for currently returned section.
Range 100 Defines the number of returned entries for current section.
Date No default. If not specified, all applicable results are returned. Indicates that entries (documents) that were updated after this date will be retrieved. The date format (compliant to standard ISO 8601) is the following : dateTtimezone, where date is yyyy-MM-dd, time is HH:mm:ss, and zone is ±hhmm. This format includes time zone information, which is critical if the client and server are in different time zones.
Proper HTML URL encoding must be performed (for example, the plus symbol + should be represented as %2B).
Action GetDocuments Defines requested action to execute.

GetDocuments retrieve all underlying documents.
GetNumberOfDocuments returns the number of all underlying documents, typically for debug purposes. This value must be the same as the number of all documents returned from an appropriate GetDocuments request.

Format ATOM Defines the output format : ATOM / HTML/ XML.
Timestamp No default. Indicates the content provider timestamp from a previous crawling session. The timestamp represents for the content provider some snapshot of the content and allows the crawler to get only the content changes on the next crawling. This is used for incremental crawghtling.

Parent topic:
Use the search seedlist 1.0 format

Parameter	Default Value	Description
SeedlistID	No default; must be specified.	Identifies the seedlist. This parameter can be specified in either of the following ways: The UUID of the site. The path to the site. For example, library_name/site
Start	0	Defines the start number for currently returned section.
Range	100	Defines the number of returned entries for current section.
Date	No default. If not specified, all applicable results are returned.	Indicates that entries (documents) that were updated after this date will be retrieved. The date format (compliant to standard ISO 8601) is the following : dateTtimezone, where date is yyyy-MM-dd, time is HH:mm:ss, and zone is ±hhmm. This format includes time zone information, which is critical if the client and server are in different time zones. Proper HTML URL encoding must be performed (for example, the plus symbol + should be represented as %2B).
Action	GetDocuments	Defines requested action to execute. GetDocuments retrieve all underlying documents. GetNumberOfDocuments returns the number of all underlying documents, typically for debug purposes. This value must be the same as the number of all documents returned from an appropriate GetDocuments request.
Format	ATOM	Defines the output format : ATOM / HTML/ XML.
Timestamp	No default.	Indicates the content provider timestamp from a previous crawling session. The timestamp represents for the content provider some snapshot of the content and allows the crawler to get only the content changes on the next crawling. This is used for incremental crawghtling.