API Tester

The API Tester page enables you to enter methods directly in the API text field by typing the method name and its arguments as a continuous string, with commas separating the parts.

For example, the following command creates a folder: 

API> create,s0,dm_folder

Note

Methods entered in the API text field bypass the Documentum Foundation Classes (DFC) and directly access the Documentum Client Libraries (DMCL). Therefore, the DFC cannot perform its usual validation of the methods.

To run server APIs:

  1. Select Tools > Api Tester.

    The API Tester page is displayed.

  2. Select Single-Line Command Entry or Script (multi-line) Entry.

  3. Enter the API.

    • If you are in Single-Line mode, enter the command and any necessary data in the Command and Data text boxes.

    • If you are in Script Entry mode, type the method and its arguments in the Commands text box.

  4. To display the SQL statement produced by the query, select Show the SQL.

  5. Click Execute.

    The results are returned.