api/Documents

Operations for working with documents.

Endpoint Description
POST Uploads and registers a document using the supplied metadata.
DELETE {id} Deletes a document.
GET {id} Retrieves information (metadata) for a document.
GET {id}/CanConvertToPdf Determines whether a document supports conversion to PDF.
GET {id}/CanPreview Determines whether a document supports previewing.
PUT {id}/CheckIn Checks an updated version of a document back into the library so that other users can see the changes.
POST {id}/CheckOut Checks a document out of the library so that other users cannot modify it.
GET {id}/CheckoutStatus Retrieves the checkout status of a document.
GET {id}/Download Downloads a document.
GET {id}/Preview Downloads a document preview.
GET {id}/Serialized Retrieves a serialized representation of a document's metadata.
POST {id}/UndoCheckout Removes the checkout status from a document.
POST Generate Generates a document using a particular template.
GET Search Searches documents, matching a particular term.
GET Settings Retrieves a list containing the document libraries configured for the practice.
GET Tagged Retrieves a list of documents with the specified tag.