API and Scripting

Download Asset API

API Request GET /review/api/asset/download HEADERS: Cookie Zoom Authenticated Cookie BODY: queryParams Key Description Required Default fuid Asset Id of the file for which metadata has to be exported. Yes – rrn Repository Revision Number of the asset at which metadata has to be exported.  Use “-1” for latest revision. Optional -1 collectionId If asset is …

Download Asset API Read More »

Asset Export Metadata API

API Request GET /review/api/asset/export/metadata HEADERS: Cookie Zoom Authenticated Cookie BODY: formData Key Description Required Default fuid Asset Id of the file for which metadata has to be exported. Yes – rrn Repository Revision Number of the asset at which metadata has to be exported.  Use “-1” for latest revision. Yes – type Type of the …

Asset Export Metadata API Read More »

Subscribe for Events API

API Request POST /review/api/events/assets/subscribe/:idCreate and register the callback. DELETE /review/api/events/assets/subscribe/:idDelete the existing callback with the given id. GET /review/api/events/assets/subscribe/:idGet the details of the existing callback as JSON response. HEADERS: Cookie Zoom Authenticated Cookie PATH PARAM id Unique subscription id(name) for the callback. Must be a unique string such as a GUID which has not been …

Subscribe for Events API Read More »

Zoom Ingest API

API Request POST /review/api/asset/upload HEADERS: Content-Type multipart/form-data Cookie Zoom Authenticated Cookie BODY: formData Key Description Required Default file File data. Use actual file data to upload in multipart form submit. Yes – name Name of the file. Uploaded file name will be used if not given. Optional Name from file field destination The ingest destination …

Zoom Ingest API Read More »

Getchangelists Command

getchangelists [‐c|‐‐changelist v] [‐l|‐‐long‐listing] [‐‐show‐versioned] [‐‐show‐unversioned]   The command supports the following options: ‐c|‐‐changelist v Specify a changelist name. Changelist can be created/edited/deleted, they contain the list of files on which the command will operate ‐l|‐‐long‐listing Print details of associated attributes ‐‐show‐versioned  

Keyword Management Web API

Keyword Stock API Keywords are critical metadata and Zoom offers some special Web APIs targeted towards keywords management. View Keyword Stock Request URL: Request JSON Syntax: The “data” parameter of the request is in JSON format. It must carry, apart from the command name i.e. cmd: getkwstock, a JSON object “message”, which will be interpreted by the …

Keyword Management Web API Read More »

Zoom GUI Launcher Web API

Launch GUI Zoom client installation includes a client proxy service that is automatically installed on the desktop. The proxy listens on HTTP port 7770 for commands. Application plugins can invoke JSP based services on this port to access the local working copy assets as well as invoke commands to launch Zoom UI via the HTTP  …

Zoom GUI Launcher Web API Read More »

Zoom Web API

The Zoom Web APIs allow web services or web clients to access the DAM and Workflow functions easily. Except for the UI Launcher and metadata API, all the other APIs are remote APIs and do not require a local working copy.

Zoom Preview Server API

This section covers the API invocations related to previews and thumbnails in Zoom. All JSON responses contain these standard fields: “success” : “true|false” “errorInfo” : “<Error msg if success is false, else this element will not be present>” “errorCode”: A key that exists in the Zoom message catalog Get Preview or Thumbnail Description:Get thumbnail or preview associated …

Zoom Preview Server API Read More »

Pre-requisites for Zoom APIs

Zoom exposes a rich set of APIs both in the form of command-line client or as JSON-based Web APIs. Before venturing into these APIs, there are a few basics that one would have to understand. This post covers the basic key parameters that are part of the Zoom APIs and some common initialization and connection mechanisms. Entity Definitions Through out the …

Pre-requisites for Zoom APIs Read More »

Zoom Utility Web API

Utility API This section covers some of the utility APIs that will come in handy for IT administrators or users who depend on scripting with Zoom APIs Login Details For purposes of scripting, or even in general, it is vital to know details about the deployment. By issuing the command “getcredentials” via the Web API framework, you can …

Zoom Utility Web API Read More »

Zoom Find Web API

Find API The Zoom Find API allows you to search assets and read metadata from assets inside the Zoom repository. You can search the repository based on a variety of different search parameters. It is required to provide at least 1 search criteria – either filename, changeset, or metadata criteria. Form request data refers to the Http …

Zoom Find Web API Read More »

Zoom User Administration API

Managing Users and Privileges These APIs are invoked on the Zoom Web Management Server. Default TCP port: 8443. The role needed to execute these APIS: Project Admin or Super Admin unless otherwise stated. Form request data refers to the Http Form data that must be sent either as a URL-encoded query parameter or in a POST. Below …

Zoom User Administration API Read More »

Writing Workflow Auto Task Scripts

Target Audience: This article is meant for IT staff or software developers who need to create automation within the Zoom Workflow Framework. Please configure the auto task folder on the Zoom DAM server where auto task scripts will reside as described here. Zoom Workflow framework supports inserting an auto task in the activity graph for …

Writing Workflow Auto Task Scripts Read More »