Quick Start Command Descriptions

The following provides descriptions and examples for each Quick Start Command. In all of the examples, the <IPADDRESS> variable can be the IP address or DM server name. The user name is jdoe, the password is Password123, and your DM library name is entered after the library= entry.

To create a folder:

  • Use the NEWFOLDER command to create a folder.

    Example 7-1: NEWFOLDER

    http://IPADDRESS/eDOCS/quickstart/execute?show=NEWFOLDER&user=jdoe:Password123&library=prilibdevmay

To create a document:

  • Use the NEWDOCUMENT command to create a document.

    Example 7-2: NEWDOCUMENT

    http://IPADDRESS/eDOCS/quickstart/execute?show=NEWDOCUMENT&user=jdoe:Password123&library=prilibdevmay

To create a workspace:

  • Use the NEWWORKSPACE command to create a workspace.

    Example 7-3: NEWWORKSPACE

    http://IPADDRESS/eDOCS/quickstart/execute?show=NEWWORKSPACE&user=jdoe:Password123&library=prilibdevmay

To create a paper document:

  • Use the NEWPAPERDOCUMENT command to create a paper document.

    Example 7-4: NEWPAPERDOCUMENT

    http://IPADDRESS/eDOCS/quickstart/execute?show=NEWPAPERDOCUMENT&user=jdoe:Password123&library=prilibdevmay

To retrieve the Recently Edited Documents list:

  • Use the RECENTLIST command to retrieve recently edited documents or folders for a specific user.

    Example 7-5: RECENTLIST

    http://IPADDRESS/eDOCS/quickstart/execute?show=RECENTLIST&user=jdoe:Password123&library=prilibdevmay

To retrieve the Quick Search list:

  • Use the QSEARCHLIST command to retrieve a quick search list.

    Example 7-6: QSEARCHLIST

    http://IPADDRESS/eDOCS/quickstart/execute?show=QSEARCHLIST&user=jdoe:Password123&library=prilibdevmay

To retrieve checked-out documents:

  • Use the CHECKEDOUTLIST command to retrieve checked-out documents.

    Example 7-7: CHECKEDOUTLIST

    http://IPADDRESS/eDOCS/quickstart/execute?show=CHECKEDOUTLIST&user=jdoe:Password123&library=PRILIBDEVMAY

To retrieve public folders:

  • Use the PUBLICFOLDERLIST command to retrieve a list of public folders.

    Example 7-8: PUBLICFOLDERLIST

    http://IPADDRESS/eDOCS/quickstart/execute?show=PUBLICFOLDERLIST&user=jdoe:Password123&library=PRILIBDEVMAY

To retrieve workspaces:

  • Use the WORKSPACELIST command to retrieve all workspaces.

    Example 7-9: WORKSPACELIST

    http://IPADDRESS/eDOCS/quickstart/execute?show=WORKSPACELIST&user=jdoe:Password123&library=PRILIBDEVMAY

You can delete a document, folder, workspace, or workspace contents; however, the Quick Start Commands require an extra parameter. For example, to delete a document or folder, you must specify the document number; for workspaces, you must specify the System ID.

To delete a document or folder:

  1. Use the DELETE command to delete a document or folder.

  2. Specify the document number after the command name, separated by a colon.

    Example 7-10: DELETE

    For example, if the document number is 100, enter DELETE:100.

    http://IPADDRESS/eDOCS/quickstart/execute?show=DELETE:100&user=jdoe:Password123&library=PRILIBDEVMAY

To delete a workspace:

  1. Use the DELETEWORKSPACE command to delete a workspace.

  2. Specify the System ID of the workspace after the command name, separated by a colon.

    Example 7-11: DELETEWORKSPACE

    For example, if the System ID is 1000, enter DELETEWORKSPACE:1000.

    http://IPADDRESS/eDOCS/quickstart/execute?show=DELETEWORKSPACE:1000&user=jdoe:Password123&library=PRILIBDEVMAY

To delete workspace contents:

  1. Use the WORKSPACECONTENTS command to delete the contents of a workspace.

  2. Specify the System ID of the workspace after the command name, separated by a colon.

    Example 7-12: WORKSPACECONTENTS

    For example, if the System ID is 2000, enter WORKSPACECONTENTS:2000.

    http://IPADDRESS/eDOCS/quickstart/execute?show=WORKSPACECONTENTS:2000&user=jdoe:Password123&library=PRILIBDEVMAY

Top of page