Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Create one or more documents with text content:

URL

http://localhost:8080/oledocstore/rest/documents

 

Method

POST

 

Request body

XML

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

 

Request body

Multi-part binary

Bag content

Returns

201 Created & Location

Response XML

 

401 Unauthorized

 

 

415 Unsupported Media Type

 

...

Retrieve a document (Checkout)

URL

http://localhost:8080/oledocstore/rest/documents/[uuid]

 

Method

GET

 

Returns

200 OK & XML or other content

XML or binary content of the document

 

401 Unauthorized

 

 

404 Not Found

 

...

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

URL

http://localhost:8080/oledocstore/rest/documents

 

Method

GET

 

Query string

category=
type=
format=
start=
end 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

 

...

Modify one or more documents:

URL

http://localhost:8080/oledocstore/rest/documents

 

Method

PUT

 

Request Body

XML

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

POST (PUT does not support multi-part request)

 

Request Body

Multi-part binary

Bag content

Returns

200 OK and response

Response XML

 

401 Unauthorized

 

 

404 Not Found

 

 

415 Unsupported Media Type

 

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.

 

 

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

XML

Request XML

Returns

200 OK and response

Response XML

 

401 Unauthorized

 

 

404 Not Found

 

 

415 Unsupported Media Type

 

...