V-Spark Online Help

Reference for the /status API

The /status API enables you to retrieve status information about the activities that are associated with the folders within a V‑Spark installation. The call can request status information on all folders within the installation, or limit the request to a particular company, organization, or folder.

Synopsis

/status
/status/CO_SHORT
/status/CO_SHORT/ORG_SHORT
/status/CO_SHORT/ORG_SHORT/FOLDERNAME   

Description

As shown in the synopsis, the V‑Spark /status API enables you to retrieve status information about an entire V‑Spark installation, a specific company, a specific organization, or a specific folder. Variables used in a call to the /status API are the following:

CO_SHORT

The short name of the company for which you want to retrieve status information

ORG_SHORT

The short name of the organization that you are using. Finding that information is shown in /transcribe API Reference.

FOLDERNAME

The name of the V‑Spark Folder from which you want to retrieve status information

The call also accepts the following parameters:

TOKEN

The V‑Spark authorization token that you are using to establish permission to retrieve information. You can either use the root token for the target V‑Spark installation (located in the file /opt/voci/state/vspark/apitoken) or the authorization token for the company under which the specified FOLDER is located. Locating your company authorization token is shown in V‑Spark API Permission Requirements.

This parameter is required.

FORMAT

The format of the returned status information. You may specify json or csv format. The default format is json.

When status information is returned in CSV format, the first row in the output provides heading for the data in the other rows in the table.

Tip

Being able to retrieve information from the /status API in CSV format (by passing the format=csv parameter) makes it easy to quickly preview any level of status information. Tools such as spreadsheets typically support importing CSV data. As an example, Sample /status JSON and CSV Output for a Folder shows the CSV output for a folder being previewed in the Libre Office spreadsheet application, Calc.

Content Types

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

  • GET method with csv option returns comma-separated values with the "text/html" MIME type

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

The next few sections illustrate the /status information that is retrieved from the various levels of the hierarchy of a V‑Spark installation.