API View

In API View, you can execute API commands.

The API View

To execute an API command, do any of the following:

• Press Enter

• Press F9

• Press Shift+Enter

• In the Edit menu, select Run

• Click the Run button on the toolbar.

Double-click an element in the result log to copy the value to the clipboard. Press Ctrl when double-clicking to paste the value into the active input control at the current cursor position.

Click and hold the left mouse button for 1 second on any value representing a valid Documentum r_object_id to load the respective object into the Object Navigator (see Object Navigator)

Certain API commands can be executed without a connected session (such as getservermap, getdocbrokermap or connect).

To open the API command help, click the API Command Help button to the right of the Command field. You can then search for API commands or you can insert a command by double-clicking the command input field.

The context menu of the result log contains some additional functionality:

Menu item	What It Does
Dump Object	Creates a dump of an r_object_id.
Open File	Opens the file if a full filename is supplied in the log, for example after a getfile command.
Login as…	Opens a new session with the login ticket data under the cursor after a getlogin command.