Librarian API |
The Librarian API provides REST endpoints that you can use to manage the spaces, folders, and files that comprise Librarian, which is the document management system for BarTender Cloud.
By default, every Librarian repository comes with two spaces: “Main,” which is intended for typical document storage, and “$temp,” which is a hidden space that is intended for temporary files.
Temporary files are automatically deleted after approximately a month has passed. If the “$temp” space begins to run low on storage, it might proactively delete files that are less than a month old to make more storage available.
|
Note: For more information, you can view the API reference by using ReDoc. In ReDoc, you can expand the items in the left navigation pane and then scroll to find the commands that you want. You can copy each command to your development environment and customize it as needed. To view the API reference in ReDoc, enter the following URL in the browser address bar: https://am1.bartendercloud.com/api/librarian_reference/redoc |
The following Librarian APIs are available.
Configuration
The Configuration API includes commands that you can use to get configuration information for all spaces and to update the space configuration.
When you configure Librarian spaces, you can customize your experience with them. This can include using file path aliases to simplify lengthy content URIs.
|
Action |
Command |
Description |
|---|---|---|
|
|
Gets the current configuration settings. |
|
|
|
Updates the current configuration settings. |
Files
The Files API includes commands that you can use to create, update, delete, and otherwise manage your files and their associated permissions, attachments, properties, and metadata.
|
Action |
Command |
Description |
|---|---|---|
|
|
Adds a file. |
|
|
|
Creates a temporary file in a specified location in Librarian. |
|
|
|
Creates a temporary file in a specified location in Librarian. The location is specified by the file path. |
|
|
|
Updates a file. |
|
|
|
Checks out a file. |
|
|
|
Clones a file. |
|
|
|
Copies a file. |
|
|
|
Moves a file and all of its associated versions from one folder to another. |
|
|
|
Hides or shows a file. |
|
|
|
Renames a file. |
|
|
|
Deletes a file. |
|
|
|
Restores a deleted file. |
|
|
|
Reverts a file. |
|
|
|
Purges a file. |
|
|
|
Searches all files. |
|
|
|
Adds a file attachment. |
|
|
|
Updates an existing file attachment. |
|
|
|
Renames a file attachment. |
|
|
|
Deletes a file attachment. |
|
|
|
Gets the content of a file attachment. |
|
|
|
Gets the content of a file. |
|
|
|
Gets the content of a file by using the file path. |
|
|
|
Gets the metadata for a file. |
|
|
|
Gets metadata for a file by using the file path. |
|
|
|
Gets the value of a metadata item. |
|
|
|
Adds a metadata item. |
|
|
|
Updates a metadata item. |
|
|
|
Removes all metadata items. |
|
|
|
Removes a metadata item. |
|
|
|
Gets a file's permissions. |
|
|
|
Gets a file's permissions by using the file path. |
|
|
|
Gets the file permissions for the calling user. |
|
|
|
Updates the permissions that are explicitly applied to a target file version. |
|
|
|
Gets a file's properties. |
|
|
|
Gets a file's properties by using the file path. |
File Changes
The File Changes API includes commands that you can use to retrieve file changes and create and update file change comments.
|
Action |
Command |
Description |
|---|---|---|
|
|
Gets the changes that are associated with a file. |
|
|
|
Updates a file change comment. |
|
|
|
Creates a new file change comment. |
Folders
The Folders API includes commands that you can use to create, update, delete, and otherwise manage your folders and their associated permissions, properties, and metadata.
|
Action |
Command |
Description |
|---|---|---|
|
|
Creates a new folder. |
|
|
|
Updates an existing folder. |
|
|
|
Renames an existing folder. |
|
|
|
Restores a folder that was previously deleted. |
|
|
|
Copies a folder to another folder. |
|
|
|
Moves a folder to another folder. |
|
|
|
Deletes a folder. |
|
|
|
Gets a folder by using the folder ID. |
|
|
|
Gets the properties of a folder by using the folder path. |
|
|
|
Gets the folder hierarchy for a specified folder. |
|
|
|
Searches all folders that match the user-provided criteria. |
|
|
|
Gets the permissions that are associated with a folder. |
|
|
|
Gets permissions for a folder by using the folder path. |
|
|
|
Gets the permissions that are associated with a folder for a specific user. |
|
|
|
Updates a folder's permissions. |
|
|
|
Gets the metadata for a folder. |
|
|
|
Gets the metadata for a folder by using the folder path. |
|
|
|
Adds a metadata item for a folder. |
|
|
|
Gets the value of a metadata item for a folder. |
|
|
|
Updates a metadata item for a folder. |
|
|
|
Removes a metadata item for a folder. |
|
|
|
Removes all of the metadata items for a folder. |
Items
The Items API includes commands that you can use to list or purge (permanently delete) files, folders, and subfolders.
|
Action |
Command |
Description |
|---|---|---|
|
|
Lists items in a folder by using the folder ID. |
|
|
|
Lists items in a folder by using the folder or file path. |
|
|
|
Purges items in the target folder by using the folder ID. |
Spaces
The Spaces API includes commands that you can use to retrieve and update space information, properties, and permissions.
|
Action |
Command |
Description |
|---|---|---|
|
|
Gets all spaces. |
|
|
Gets a space's properties by name. |
|
|
|
Gets a space's properties. |
|
|
Updates a space. |
|
|
|
Gets the permissions for a space. |
|
|
|
Updates the permissions for a space. |