Api.deleteDocument

deleteDocument(containerId, documentId, keepEmptyContainer)

Deletes an individual document.

This method executes asynchronously and returns a promise.

Note

Deleting a document deletes all attached image data. If a document container becomes empty as a consequence of deleting a document and the keepEmptyContainer argument is false (default), the document container is also deleted.

Arguments

• containerId (guid()) – Unique identifier of the document container that contains the document that will be deleted.

• documentId (guid()) – Unique identifier of the document that will be deleted.

• keepEmptyContainer (bool()) – Optional. true if a document container should be kept and not deleted if it becomes empty as a consequence of deleting a contained document. Default: false.

Returns

For error responses, see Error Responses.

If successful, deletes the document.