V-Spark Online Help

Sample /config/apps JSON Output for an Application

The following sample JSON output is for a single application from the /config/apps API for the applications that have been defined for a single organization.

Figure 1. Sample application output from the /config/apps API
"DocTestCo": {
    "DocTestCo-DocTesting": {
        "Admin App": {
            "created": "2017-06-23",
            "defaultscoretype": "Hit/Miss",
            "enabled": "on",
            "folders": [
                "Test01"
            ],
            "template": "custom"
        },...
    },...
},...


Table 1. /config/apps Fields

Name

Type

Values

Description

created

READ-ONLY date, in YYYY-MM-DD format

The date that the application was created. This field is added by V‑Spark when the application is created.

"created": "2017-06-23",

defaultscoretype

The default type of score to use for categories that are created within this application. Values for this field are "Coverage" or "Hit/Miss."

For more information on the meanings of these score types, refer to the V‑Spark Application Development Guide.

"defaultscoretype": "Hit/Miss",

enabled

Whether or not this application is actively scoring new file uploads to the folders it scores. Values are "on" and "off." Disabled ("off") applications can still be edited and their existing results viewed, but no new results will be created until the application is re-enabled.

"enabled": "on",

folders

The name(s) of the folder(s) this application will score.

"folders": [
"Test01"
],

template

REQUIRED when creating a new application.

The name of the application template on which this application is based, or "custom" indicating that this application is not based on a pre-defined template.

The template option to Copy from existing organization is not supported in the API.

"template": "custom"


For detailed information about the information that is part of the definition of an application, see the section entitled "Creating an Application" in the V‑Spark Management Guide. For information about retrieving and uploading applications using the API, see /appedit API Reference.

The excerpt from the output of calling the /config/apps API shown previously is very similar to the output that you would have received had you made a request about the applications that are associated with an organization by calling an API URL such as /config/DocTestCo/DocTestCo-DocTesting/apps/Admin%20App API, as shown in the next sample JSON.

This sample output is from a V‑Spark installation where the "Doc Test Co" company and the "Doc Testing" organization (with the company short name, "DocTestCo" and the Organization short name of "DocTestCo-DocTesting"), and the Application "Admin App" were previously defined. This output differs only in that it does not need to identify the short name of the company, organization, and application that it refers to, since test values were specified in the URL.

Figure 2. Sample Application output from the /config/CO_SHORT/ORG_SHORT/apps/APPNAME API
{
    "created": "2017-06-23",
    "defaultscoretype": "Hit/Miss",
    "enabled": "on",
    "folders": [
        "Test01"
    ],
    "template": "custom"
}


Note

Application names can contain spaces, which must be URL-encoded by replacing them with %20 when specifying the name of an application as part of a URL.