/list

Use /list to retrieve summary V‑Spark system configuration and entity names. /list supports GET requests only. For detailed configuration output, use /config.

Synopsis

/list?token=$token
/list/users?token=$token
/list/orgs?token=$token
/list/folders?token=$token
/list/apps?token=$token

/list/$co_short/users?token=$token
/list/$co_short/orgs?token=$token || /list/$co_short?token=$token
/list/$co_short/folders?token=$token
/list/$co_short/apps?token=$token

/list/$co_short/$org_short/folders?token=$token || /list/$co_short/$org_short?token=$token
/list/$co_short/$org_short/apps?token=$token

$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.

Endpoints

/list: Returns all companies.
/list/users: Returns all users.
/list/orgs: Returns all organizations.
/list/folders: Returns all folders.
/list/apps: Returns all applications.

Example cURL request

The following example request retrieves a list of all organizations.

curl -s 'http://www.example.com:3000/list/orgs?token=$token'

Example JSON output

/list

[
    "TestCompany",
    "Testing",
    "DocTestCo",
    "WebAPITest",
    "Limitedhours",
    "CNCO",
    "JWebAPITest"
]

/list/users

"DocTestCo": [
    "joe.user",
    "bill.generic"
],

/list/orgs

"DocTestCo": [
    "DocTestCo-DocTesting"
],...

/list/$co_short/orgs

[
    "DocTestCo-DocTesting"
]

/list/folders

"DocTestCo": {
    "DocTestCo-DocTesting": [
        "Test01"
    ]
},...

/list/$co_short/$org_short/folders

[
    "Test01"
]

/list/apps

"DocTestCo": {
    "DocTestCo-DocTesting": [
        "Testing CallbackTest",
        "Manager App",
        "Admin App"
    ]
},...

/list/$co_short/apps

[
    "Testing CallbackTest",
    "Manager App",
    "Admin App"
]

Python example

Use api_get_config.py to test /list as in this example request for a list of all organizations:

python api_get_config.py $host $token /list/orgs/ $http_code $output_file

$host: Hostname or URL for the system running V‑Spark.
$token: Authorization token with the required read or write permissions for the request.
$http_code: The HTTP code expected to be returned with the response.
$output_file: File path for query output.