Table of Contents
This API is used to call remote functions over DEP2 protocol.
There are several common principles for mostly all API calls.
Functions are grouped to packages which are similiar to Java packages. Function have to be called with fully qualified name including package name. Use camelCase naming for function names. Package names should be lowercase.
Several functions return list of object. All returned objects are expected to have same structure. General format of returned list:
{ "position": 0, /* Position of the first returned object in the same collection on the server. Position is zero based index */ "count": 10, /* Total number of objects on the server */ "records": [ /* Array of returned objects */ ] }
There are several functions for user managment.
Function name:
documentserver.users.changeMyPassword
Parameter: array with one string: ["new-password"].
Returns array with one bool. True if succeeded, false if failed.
Function name:
documentserver.users.list
Parameter: no parameters
Return list of users in standard format (Section 1.2, “Lists”). Format of user object:
{ /* username of the user */ "username":"donald", /* first name */ "firstname":"Donald", /* last name */ "lastname":"Douglas" }
Document specific functions.
Function name:
documentserver.document.actionList
This function returns list of available actions for the selected document.
Parameters:
ID of the selected document
Version of the document. Can be empty string.
Server specific identifier of current version. Can be empty string.
Returns list of available actions in standard format (Section 1.2, “Lists”). Format of one action:
{ /* Name of the action */ "name":"Add Task to Person", /* URL of the form to start action */ "formUrl":"chrome://documentserver/content/addDocumentTask.xml", /* Description of the action, optional */ "description":"Assign task connected with the document to the specific person" }