Available BarTender API

Actions

Submit a script to run

X

Get a list of submitted scripts

X

Update script properties

X

Get a script's running status

X

Get all variable values

X

Get the value of the specified variable

X

Automated print

Performs an automated print job to the specified file path inside a given library

X

Librarian: Configuration

Get current configuration settings

X

Update the current configuration settings

X

Librarian: File changes

Get a collection of file changes

X

Update a file change comment

X

Create a file change comment

X

Librarian: Files

Add a file

X

Add a temporary file

X

Add a temporary file by path

X

Update a file

X

Check out a file

X

Clone a file

X

Copy a file

X

Move a file

X

Hide or show a file

X

Rename a file

X

Delete a file

X

Restore a deleted file

X

Revert a file

X

Purge a file

X

Search all files

X

Add a file attachment

X

Update a file attachment

X

Rename a file attachment

X

Delete a file attachment

X

Get an attachment's content

X

Get a file's content

X

Get a file's content by the file path

X

Get a file's metadata

X

Get a file's metadata by the file path

X

Get a metadata item's value

X

Add a metadata item

X

Update a metadata item

X

Remove all metadata items

X

Remove a metadata item

X

Get a file's permissions

X

Get a file's permissions by the file path

X

Get file permissions for the calling user using the file ID

X

Update a file's permissions

X

Get a file's properties

X

Get a file's properties by the file path

X

Get file permissions for the calling user using the file path

X

Get file permissions for the requested userlookupid

X

Get file permissions for calling user (by path)

X

Search all files (v2)

X

Continue searching all files (v2)

X

Librarian: Folders

Create a folder

X

Update a folder

X

Rename a folder

X

Restore a folder

X

Copy a folder to another folder

X

Move a folder to another folder

X

Delete a folder

X

Get a folder by the folder ID

X

Get a folder's properties by the folder path

X

Get the folder hierarchy

X

Search all folders

X

Get a folder's permissions

X

Get a folder's permissions by the folder path

X

Update a folder's permissions

X

Get a folder's metadata

X

Get a folder's metadata by the folder path

X

Add a metadata item

X

Get a metadata item's value

X

Update a metadata item

X

Remove a metadata item

X

Remove all metadata items

X

Get folder permissions for the calling user

X

Initiates a cursor-based search for folders

X

Continues a cursor-based search for folders

X

Librarian: Items

List items by folder ID

X

List items by folder or file path

X

Purge items by folder ID

X

List items by folder ID (v2)

X

Purge all items by folder ID

X

Retrieve the list of items for a paged query

X

Librarian: Spaces

Get all spaces

X

Get a space's properties by the space name

X

Get a space's properties

X

Update a space

X

Get a space's permissions

X

Update a space's permissions

X

Create a space

X

Marks a space as deleted

X

Get space permissions for the user

X

Print controller: Print history

Retrieve printed items

X

Retrieve print-history job records

X

Retrieve a print-history job record

X

Print controller: Printers

Get printer records

X

Get a printer record

X

Get print-job records from a queue

X

Get print-job information

X

Security: Group

Create a group

X

Update a group

X

Delete a group

X

Get a group

X

Security: Groups

Get all groups

X

Security: Memberships

Create a group-to-group relationship

X

Delete a group-to-group relationship

X

Get users within a group

X

Get group-to-group records

X

Create a user-to-group relationship

X

Delete a user-to-group relationship

X

Get a user's groups

X

Security: Permission

Check user permissions

X

Get permissions descriptions

X

Get a user's permissions information

X

Security: Roles

Create a new role

X

Update a role

X

Get a role

X

Delete a role

X

Get a list of roles

X

Security: User

Get user information

X

Get a user's advanced properties

X

Get a user's 2FA status

X

Delete a user's 2FA phone number

X

Security: Users

Create a new user

X

Update a user

X

Delete a user

X

Search for a user

X

Get information about 2FA support

X

Get all user information

X

Search for users

X