V-Spark Online Help

Options

In addition to being able to optionally specify the short name of a company or organization to refine the data that is being returned, calls to the /config method take the following parameters to further control their behavior:

Table 1. /config Method Parameters

Name

Type of Value

Valid Values

Description

token

REQUIRED String

33 character token

The root or a company-specific token for the V‑Spark installation about which you want to retrieve information. You cannot successfully call any function in the /config API without an authentication token. The root token for a V‑Spark installation can always be used. A company-specific token can be used for any calls within the scope of that company. The root token for a V‑Spark installation is located in the file /opt/voci/state/vspark/apitoken. The company-specific token is part of the configuration information for the associated company. For an example of programmatically retrieving company tokens and using them with organizations and folders, see Integrating Multiple GET Results Using Python.

tree

Boolean

true, false (default)

This field is optional, and is only used with the DELETE method. Companies that contain users & organizations and organizations that contain folders & applications are not considered to be empty. By default, only empty elements may be deleted from a V‑Spark installation. If set to "true," non-empty companies and organizations will be deleted.

To delete a non-empty element with tree, you will also need to set multi to true to enable multiple items to be deleted at once.

multi

REQUIRED Boolean

true, false (default)

If tree is set to "true." By default, you can only delete a single item at one time in a V‑Spark installation. If set to "true," multiple items may be deleted at the same time as the result of a single DELETE request.



As REST API functions, /config API functions return both an HTTP message and a return code. The success and failure messages associated with various calls to the /config API are listed in the sections that describe those calls.