Service Info: library
Service Description
This service provides the operations needed to work with the document library.
Available Operations
The following operations are available for the library service. You can click on each operation to see detailed information about that operation.
| Operation | Description |
|---|---|
| documentAdd | Invoke this operation to add a document. A copy of the document will be taken and stored in the Hornbill file store. |
| documentChangeOwner | Invoke this operation to change the ownership of one or more documents. Unless ownership change is forced, the person being given the ownership will be assigned a task and must accept or decline ownership of the document(s). You need to be the current owner of the specified document(s) or have an ADMIN privilege level or have changeDocumentOwner System Right to change a document(s) ownership |
| documentChangeStatus | Invoke this operation to change the status of one or more documents. |
| documentDelete | Deletes one or more documents from your library. Any documents deleted with this operation are instantly removed from the system. Documents that are version managed will also be removed along with all previous version, change history and so on. |
| documentGet | Invoke this operation to get information about the specified document. |
| documentGetList | Invoke this operation to get a list of documents. It returns active and draft documents but not retired documents. |
| documentGetReadingPrescriptions | Invoke this operation to return a list of prescribed reading prescription properties for the specified document. |
| documentGetVersions | Invoke this operation to get a list of document versions. This only works on documents that have been created with revision control enabled. |
| documentLibraryCreate | Invoke this operation to create a new library. A library does not have its own content, it is simply a container which can be given visibility to documents from any number of co-workers libraries. The purpose of a library is to make it easy to provide visibility to a collection of documents rather than having to assign individual visibility to each co-worker or guest. |
| documentLibraryDelete | Invoke this operation to delete a library. Please note that this operation is not reversible. Deleting a library does not delete the documents that library holds reference to. |
| documentLibraryGet | Invoke this operation to get details of a given library. |
| documentLibraryGetList | Invoke this operation to get a list of libraries available to you |
| documentLibraryShare | Invoke this operation to share/unshare a library with a user. Sharing the library with read only permission will allow them to access documents shared with this library but will not allow them to share their own documents with this library. |
| documentLibraryUpdate | Invoke this operation to update a library. |
| documentLockContent | Invoke this operation to lock a document so you can freely edit it without fear of content conflicts. By locking the document you are preventing anyone else from uploading changes. You can only lock the document if you are either the owner or you have a modifyContent share permission. |
| documentSearchByTag | Invoke this operation to search for documents tagged with one or more tags. |
| documentShare | Invoke this operation to share/unshare a document you are the owner of with other users or libraries. |
| documentUnlockContent | Invoke this operation to unlock a document you previously locked. Or, if you are the owner and want to forcibly remove a lock placed on your document by one of the people you have shared with you can set the "force" parameter to true. |
| documentUpdate | Invoke this operation to update a document that is already in your library. |
| imageShareCreate | Use this operation to create an image share. |
| imageShareDelete | Use this operation to delete an image share. |
| imageShareGetInfo | Use this operation to get an image share details. |
| imageShareGetList | Use this operation to get a list of image shares. Image content can be accessed via [Your Instance API Endpoint]/dav/share/img/inline/yU7Pt0tHYyw [Your Instance API Endpoint]/dav/share/img/download/yU7Pt0tHYyw [Your Instance API Endpoint]/dav/share/img/thumbnail/yU7Pt0tHYyw |
| imageShareUpdate | Use this operation to update an image share. |
| libraryChangeOwner | Invoke this operation to change the owner of a library. You can change ownership if you own the library or you have super user privs |
| librarySearchByTag | Invoke this operation to search for documents tagged with one or more tags inside a library. |
| libraryTagCount | Invoke this operation to get counts of tags inside a library. |
| prescribedReadingConfirm | Invoke this operation to you have read a document have been prescribed to read. |
| prescribedReadingRequest | Invoke this operation to prescribe reading of a document you are the owner of, for one or more users. |
| tagCreate | Invoke this operation to create a new tag. |
| tagDelete | Invoke this operation to delete one or more existing tags. |
| tagGetList | Invoke this operation to get a list of tags. If you do not specify a language, your current language is assumed. |
| tagGroupCreate | Invoke this operation to create a new tag. |
| tagGroupDelete | Invoke this operation to delete a tag group. All tags and tag links associated with this tag group will be deleted. |
| tagGroupList | Invoke this operation to get the list of tag groups. |
| tagLinkObject | Invoke this operation to tag a specific object. |
| tagSearch | Invoke this operation to search for objects that are tagged with one or more tags. |
| tagUnlinkObject | Invoke this operation to remove a tag association from a specific object. |
| tagUpdate | Invoke this operation to update an existing tag. |