Class Index

Classes


Class Index


Intro

A Brief intro to the REST API V2

AclManager_DELETE

Removes acls

AclManager_GET

Collects ACL info

AclManager_PUT

Creates or updates acls

Assets

Collects assets data

AssetsByPath

Gets the asset info given their path

CheckIn

Upload a new version of an asset into MediaBeacon

CheckOut

Check out an asset or cancel the check out of an asset

CompressFiles

Compresses the given assets into a single zip asset

Conversion

Submits assets to the preview system to be converted to another format/resolution/scale/etc.

Create

Creates empty files and folders

DecompressFiles

Decompresses compressed files such as .zip files

Delete

Deletes Directories and Files

deleteApiKey

delete an Api Key.

Dictionary

Shows the dictionaries and their words

Directories

Shows the directory objects

Download

Downloads assets

Facets

Shows facets for a field

Fields

Shows the field definitions in MediaBeacon

GetApiKey

Get an Api Key for the current user in MB

GetDiscussion

Collects the discussions for the assets.

GetLinks

Collects the asset links information

GetXmp

Returns the xmp for the assets as a string

GroupManager_DELETE

Removes groups

GroupManager_GET

Collects Group info

GroupManager_POST

Creates groups

GroupManager_PUT

Creates or updates groups

Groups

Shows all of the current users groups/acls

Import

Imports files or folders

Move

Moves files and directories.

QuickSearch

Runs a quick search for assets.

Rename

Renames files and directories.

SavedSearches

Shows the saved searches available to the current user.

SavedSelections

Shows the saved selections available for the current user.

Search

Runs a search for assets.

SetDiscussion

Adds discussions to assets

SetFields

Writes a values to assets

SetLinks

Creates asset links

SetXmp

Set the XMP for an asset

TypeAhead

Provide search options from R3search given a query

Upload

Upload an asset into MediaBeacon

UserInfo

Shows the current users information

UserManager_DELETE

Removes users

UserManager_GET

Collects user info

UserManager_POST

Creates new users

UserManager_PUT

Creates or updates new users

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Nov 20 2020 16:14:16 GMT-0600 (CST)