V-Spark Online Help

Reference for the /appedit API

The /appedit API enables you to retrieve the category/phrase configuration of a custom application for archival purposes, or so that you can modify it using an external editor. You can then upload the modified application for use within V‑Spark.

Synopsis

GET /appedit/CO_SHORT/ORG_SHORT/APPNAME?token=TOKEN
POST /appedit/CO_SHORT/ORG_SHORT/APPNAME?token=TOKEN

Description

The variables used in a call to the /appedit API are the following:

CO_SHORT

The short name of the company whose category configuration you would like to retrieve or upload

ORG_SHORT

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

APPNAME

The name of the V‑Spark application whose category configuration you would like to retrieve or upload

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 ORG_SHORTj is located. Locating a company's authorization token is shown in V‑Spark API Permission Requirements.

. Content Types
  • POST method expects to receive JSON with the "application/json" MIME type

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

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