JSON API Reference

Applies to Collaborator 14.5, last modified on May 06, 2024

Complete reference on all API objects and methods is available at the following URL:


The reference lists all the commands that are available to JSON web service and describes the fields of the request and response objects.

API reference documentation uses Javadoc notation to describe the objects, methods and interfaces. In order to use the command, object or field in your JSON requests, you need to convert the Javadoc notation to Java Script Object Notation.

To determine a name of the desired JSON field, remove the "get" prefix from the method name and put the first letter to lower case.

For example, a Javadoc description for the LoginTicketRequest interface says that it has the getLogin and getPassword methods.

A JSON object that corresponds to this interface will look like this:

{"login": "jsmith", "password": "js123"}

See Also

JSON API Web Services
How To

Highlight search results