/appedit

Use /appedit to

Retrieve the category configuration for an existing application.
Modify the category configuration for an existing application.

Note: The POST JSON contains the entire analytics application, including every category. /appedit cannot accept a configuration for only one category at a time.

/appedit changes application categories. To change application configuration, or to create a new application with the API, use the /config endpoint as described in Create and configure analytics applications.

Synopsis

GET /appedit/$co_short/$org_short/$app_name?token=$token > $json
POST /appedit/$co_short/$org_short/$app_name?token=$token --data @$json

$co_short: Company short name used to filter the request.
$org_short: Organization short name used to filter the request.
$token: Authorization token with the required read or write permissions for the request.
$app_name: Name of the application to be queried.
$json: Path to the request's JSON file.

Example cURL requests

The following example request retrieves the category configuration of an application named AppEdit Test, located under the Technologies company, in the Technologies-RD organization.

curl -s "http://example.company.com:3000/appedit/Technologies/Technologies-RD/AppEdit%20Test?token=TOKEN" > AppEdit-Test.json

The following example request updates the category configuration of an application named AppEdit Test, located under the Technologies company, in the Technologies-RD organization, from the JSON file AppEdit-Upd.json:

curl -s -X POST -H "Content-Type:application/json" --data @AppEdit-Upd.json \
    "http://example.company.com:3000/appedit/Technologies/Technologies-RD/AppEdit%20Test?token=TOKEN"

Python example

Use api_post.py with these command-line arguments:

python api_post.py $host $token /appedit/$co_short/$org_short/$app_name $json

$host: Hostname or URL for the system running V‑Spark.
$token: Authorization token with the required read or write permissions for the request.
$co_short: Company short name used to filter the request.
$org_short: Organization short name used to filter the request.
$app_name: Name of the application to be queried.
$json: Path to the request's JSON file.

Example application JSON

The following sample JSON defines an application named New AppEdit Test:

{
    "Technologies": {
        "Technologies-RD": {
            "New AppEdit Test": {
                "created": "2022-10-10",
                "defaultscoretype": "Hit/Miss",
                "enabled": "on",
                "folders": [
                    "AutoTests"
                ],
                "template": "custom"
            }
        }
    }
}