ID: 1917

Zoom GUI Launcher Web API

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  proxy.

Request URL:

Request Query Parameters:

server:  Zoom Server host:port or server alias

branch: null // Placeholder for future

remotepath: Fully qualified path in Zoom repository

rrn: Default -1 (latest) or a long corresponding to revision number

cmdname:  Command for which to launch the UI on the desktop

block: true or false. //Block the JSP call till the launched UI exists

extraargs: Command specific arguments to pass via the UI launcher


The cmdname parameter can be one of the following:

cmdname Description
autoco Silently checkout the file and open it in the registered application such as Adobe Illustrator
checkout Launch normal checkout dialog
showlog Launch Visual version history log
status Launch the Status popuop to show local & remote status
update Launch Update from server dialog
cset Launch popup to view the change sets
commit Launch the check-in dialog to commit the files in a local working copy
import Launch the import dialog
open_location Launch OS file browser with the folder containing the asset opened
workflow Launch the Workflow Task manager
asset_browser Launch the Visual Asset Browser
revert Launch the Revert command to revert the changes to last checked out state
setting Launch the Settings dialog
repobrowser Launch the Zoom file browser
lock Launch the lock/unlock dialog
reveal Launch the OS file browser with the asset revealed on the local working copy folder
open Launch the application and open the asset as a read-only copy if it’s not checked out



Returns a string, “true” | “false”, to indicate if the GUI was launched successfully or not.