Lucene Web Service API

Introduction

The core of Lucene Web Service API is primarily based on the Atom Publishing Protocol, with a few extensions. We've added the ability to get and set properties of any index or the service itself. For searching, we've based our implementation on the OpenSearch 1.1 protocol. The contents section of an Atom Entry sent to or received from the web service is based on the XOXO Microformat.

Summary

Resource	Method	Description	Client Content	Server Content
Service	GET	Retrieves a list of indices		AtomPP introspection document
Service	POST	Create an index	Atom Entry
Service.Properties	GET	Retrieves the list of properties for the service		Atom Entry
Service.Properties	POST	Adds/updates individual properties	Atom Entry
Service.Properties	PUT	Updates the entire list of properties	Atom Entry
Index	GET	Most recent modified documents		Atom Feed
Index	GET (with ?query)	Searches the index		Atom Feed
Index	DELETE	Deletes an index
Index	POST	Create a document	Atom Entry
Index.Properties	GET	Retrieves the list of properties for the index		Atom Entry
Index.Properties	POST	Adds/updates individual properties	Atom Entry
Index.Properties	PUT	Updates the entire list of properties	Atom Entry
OpenSearch Description	GET	Gets the OpenSearch Description document		OSD Document
Document	GET	Gets a document from the index		Atom Entry
Document	PUT	Updates a document	Atom Entry
Document	DELETE	Deletes a document

Notes

• A note about HTTP Verbs
• Exception Handling
• Multi-Index Operations
• Multi-Document Operations
• XOXO Usage

Resources

• Service API
• Service.Properties API
• Index API
• Index.Properties API
• Index Search API
• Document API