Loading TOC...

Client API (Document Management)

Use the /documents service to create, replace, update, and delete documents and metadata. You can update documents in their entirety or incrementally. For details, see Manipulating Documents in the REST Application Developer's Guide and Reading and Writing Multiple Documents in the REST Application Developer's Guide.

10 resources
Resource URI Description
/v1/documents (DELETE) Remove documents, or reset document metadata.
/v1/documents (GET) Retrieve document content and/or metadata from the database.
/v1/documents (HEAD) Returns the same headers as an equivalent GET (content/metadata fetch) on the /documents service.
/v1/documents (PATCH) Perform a partial update to content or metadata of a document.
/v1/documents (POST) Insert or update content and/or metadata for multiple documents in a single request.
/v1/documents (PUT) Insert or update document contents and/or metadata, at a caller-supplied document URI.
/v1/documents?extension={ext} (POST) Create a new document with a server-generated database URI.
/v1/documents?uri={db-uri} (POST) Perform a partial update to content or metadata of a document at a caller-specified URI.
/v1/documents/protection (POST) Use this method to protect a temporal document from certain temporal operations, such as update, delete, or wipe, for a specific period of time.
/v1/temporal/collections/{name} (POST) Manage the state of a temporal collection.