V-Spark Online Help

Reference for the /list API

The /list API enables you to read (GET) the names used in the configuration of a V‑Spark installation.

Synopsis

/list
/list/users
/list/orgs
/list/folders
/list/apps
/list/CO_SHORT/users
/list/CO_SHORT/orgs || /list/CO_SHORT
/list/CO_SHORT/folders
/list/CO_SHORT/apps
/list/CO_SHORT/ORG_SHORT/folders || /list/CO_SHORT/ORG_SHORT
/list/CO_SHORT/ORG_SHORT/apps    

As shown in the synopsis, calls to the V‑Spark /list API can include optional entries that enable you to specify the short name of a company (CO_SHORT) and the short name of an organization within a company (ORG_SHORT) to limit the amount of information that you are retrieving, updating, or adding. See Refining by Companies, Organizations, Folders, and Apps for more information.

Calls to the V‑Spark API without specific company or organization values return all of the name information for the part of the API that you are calling. In other words, a call to /list/DocTestCo only returns information about the organizations under the company whose short name is "DocTestCo". A call to /list returns information about all of the companies that have been defined in the V‑Spark installation that you are querying.

Description

Calls to /list and its methods can GET the following types of name-level information about a V‑Spark installation:

/list

Returns information about companies in a V‑Spark installation

/list/users

Returns information about any users that have been defined in a V‑Spark installation

/list/orgs

Returns information about the organizations that have been defined under companies in a V‑Spark installation

/list/folders

Returns information about the folders that have been defined under organizations in a V‑Spark installation

/list/apps

Returns information about any apps that have been defined in a V‑Spark installation

See Overview of the V‑Spark Hierarchy for information about how a V‑Spark installation is hierarchically organized.

Options

(None)

Content Types

GET method returns JSON-formatted data with the "text/html" MIME type

Errors will be returned with the "text/html" MIME type