Page Comparison

...

Returns:

List of uuid's uuid’s – uuids of the ingested documents

...

DocStore API as per design principles of REST

6.1 Create

Create one or more documents with text content:

URL	http://localhost:8080/oledocstore/rest/documents
Request Method	POST
Returns	201 Created & Location
	401 Unauthorized
	415 Unsupported Media Type

Modify a document:

If the specified document does not exist, it is not created by this command.

URL	http://localhost:8080/ oledocstore/documents/[uuid]
Method	PUT
Request	XML	Request XML
Returns	200 OK
	401 Unauthorized
	404 Not Found

Content Type	multipart/form-data
Content Disposition	text/xml
Content	Request XML
Returns	201 Created & Location	Response XML Need to add "Location" field for each document in response xml
	401 Unauthorized
	415 Unsupported Media Type

Create one or more documents with binary content (PDF, DOC etc)

URL	http://localhost:8080/oledocstore/rest/documents
Method	POST
Content Type	multipart/form-data
Content Disposition	application/octet-stream
Content	Bag content
Returns	201 Created & Location	Response XML
	401 Unauthorized
	415 Unsupported Media Type

Modify one or more documents:

If the specified document does not exist, it is not created by this command.

6.2 Retrieve

Retrieve a document (Checkout)

URL	http://localhost:8080/oledocstore/rest/documents/[uuid]
Method PUT	GET
Returns	200 OK & XML or other content	XML or binary content of the document
	401 Unauthorized

Request Body	XML	Request XML
Returns	200 OK
	401 Unauthorized
	404 Not Found 404 Not Found

Q: Do we need to identify the user who initiated this request?

Retrieve (references to) one or more documents: (like getUUIDs function in docstore)

URL	http://localhost:8080/oledocstore/rest/documents
Method	GET
Query string (Params append to the url)	category= type= format= start= rows=
Returns	200 OK and XML	Response xml with start, end, and next(url) fields and link info about documents in this page
	401 Unauthorized
	404 Not Found

Retrieve one or more documents with binary content (PDF, DOC etc)

URL	http://localhost:8080/oledocstore/rest/documents
Method	GET
Query string	requestContent=	Request XML
Returns	201 Created & Location	Response content type: text/xml If all the documents have xml content, the response xml will be sent. Response content type: If at least one document has binary content, then bag content will be sent with response.xml and content files (PDF, DOC etc)
	401 Unauthorized
	415 Unsupported Media Type

6.3

...

Retrieve a documentUpdate

If the specified document does not exist, it is not created by this command.

Modify one or more documents:

URL	http://localhost:8080/oledocstore/rest/documents/[uuid]
Method GET	PUT
Request Body	Request XML
Returns	200 OK & and response	Response XML
	401 Unauthorized
	404 Not Found

...


	415 Unsupported Media Type

Modify one or more documents with binary content (PDF, DOC etc):

URL	http://localhost:8080/oledocstore/rest/documents
Method	GET	Query string	Category= Type= Format= Start= End=	POST (PUT does not support multi-part request)
Request Body	Bag content
Returns	200 OK and response	Response XML
	401 Unauthorized
	Returns	200 OK and XML 404 Not Found
401 Unauthorized	415 Unsupported Media Type	404 Not Found

6.4 Delete

Delete a document:

URL	http://localhost:8080/oledocstore/rest/documents/[uuid]
Method	DELETE
Returns 204	No Content On success, no response body is returned. 200 OK and response	Response XML
	401 Unauthorized
	404 Not Found
	415 Unsupported Media Type

Delete one or more documents

URL	http://localhost:8080/oledocstore/rest/documents/
Method	DELETE
Request Body	Request XML Request XML
Returns	200 OK and response	Response XML
	401 Unauthorized
	404 Not Found
	415 Unsupported Media Type

...

Versions Compared