Class Index | File Index

Classes


Class Index

_global_


An_Intro_To_REST

REST Quick Start Guide

The basic structure to execute each REST workflow is

<MBUrl>/wf/<theWorkflowName>?<param1>=<value1>&<param2>=<value2>

For example, if you wanted to create a new folder named “TestRest” you could run

http://127.0.0.1:55555/wf/create?src=TestRest

To create multiple folders or files replace TestRest from above with an array of paths the JavaScript array format.


AssetIdToPath

Returns the path of assets based on their assetIDs.

CompressFiles

Compresses a list of assets based on assetID's and returns their paths.

Create

Creates new folders and returns the paths to them.

DecompressFiles

Decompresses assets to a destination folder and returns their paths.

Delete

Deletes files or folders by their AssetIDs or paths.

DeleteApiKey

Deletes an api key

Download

Downloads the given assets zipped.

FolderContents

Returns the names of the files and sub-folders contained in a folder specified by path.

GenerateContactSheet

Creates a contact sheet and returns the contact sheet's URL.

GetApiKey

Creates or retrieves an api key for the given user

GetField

Returns the value of a desired field for the given Asset IDs.

getPreviews

Returns the url of the asset previews

GetSavedSelections

Queries the database for selections created by the current user

GetXMP

Returns a full XMP packet for each of the given Asset IDs.

Import

Imports files or folders and returns their paths.

MoveFilesOrFolders

Moves files or folders and returns their new paths.

PathToAssetID

Returns AssetIDs using asset paths.

QuickSearch

Executes a quick search and returns a Json object with the key value pair (assetId -> fileName)

Rename

Renames folders and files.

Search

Builds an Advanced Search and returns the search results.

SetField

Writes a new value to a field of an asset.

SetXMP

Writes the xmp string to the asset with the given asset id

SubmitAssets

Submits assets to the preview system.

Upload

Uploads a file from the form data into mediabeacon at the given destination or the standard directory

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Sep 30 2016 13:29:19 GMT-0500 (CDT)