Synopsis

GET /status?token=$token
GET /status/$co_short?token=$token
GET /status/$co_short/$org_short?token=$token
GET /status/$co_short/$org_short/$folder?token=$token

$co_short

Company short name used to filter the request.

$org_short

Organization short name used to filter the request.

$folder

Folder used to filter the request.

$token

Authorization token with the required read or write permissions for the request.

$format (optional)

Specify format=csv to return comma-separated values. By default, format=json.

Example requests

The following request retrieves the status in JSON for a single folder named Test01.

curl -s 'http://example.company.com/status/co1/co1-orgA/Test01?token=$token'

The following request retrieves the status in CSV for a single folder named Test01.

curl -s 'http://example.company.com/status/co1/co1-orgA/Test01?format=csv&token=$token'

Example Python implementation

Use api_get_test.py with these command-line arguments to retrieve JSON with the status of a single folder.

python api_get_test.py $host $token /status/$co_short/$org_short/$folder ''

$host

Hostname or URL for the system running V‑Spark.

Use api_config_status.py to retrieve processing status for all system folders.

Example folder output

JSON output for a single folder resembles this example.

{
    "mode": "active",
    "servers": {
        "srvr1": "OK"
    },
    "jobmgr": {
        "192.168.150.71": {
            "numerrs": 0,
            "timestamp": "2019-06-24_18:45:58",
            "hostname": "srvr2",
            "numtranscoding": 0,
            "version": "2.4.0-0",
            "starttime": "2019-06-21_20:25:07",
            "numdecoding": 0
        }
    },
    "queued": {
        "count": 0,
        "lastactive": "2019-06-24T18:36:15.000Z"
    },
    "analyzing": {
        "lastactive": "2019-06-24T18:45:58.000Z",
        "count": "2"
    },
    "error": {
        "lastactive": null,
        "count": "0"
    }
}      

The same call, but with format=csv, returns this CSV output.

"company","organization","folder","mode","servers","queued.count",\
"queued.lastactive","decoding.count","decoding.lastactive","analyzing.count",\
"analyzing.lastactive","error.count","error.lastactive"
"DocTestCo","DocTestCo-DocTesting2","folder2","active","{""srvr1"":""OK""}",0\
,,,,"0",\
,"0",      

Example company output

JSON output for a company resembles this example.

{
    "DocTestCo-DocTesting1": {},
    "DocTestCo-DocTesting2": {
        "folder2": {
            "mode": "active",
            "servers": {
                "srvr1": "OK"
            },
            "jobmgr": {
                "192.168.150.71": {
                    "numerrs": 0,
                    "timestamp": "2019-06-24_18:40:28",
                    "hostname": "srvr1",
                    "numtranscoding": 0,
                    "version": "2.4.0-0",
                    "starttime": "2019-06-21_20:25:07",
                    "numdecoding": 0
                }
            },
            "queued": {
                "count": 0,
                "lastactive": "2019-06-24T18:36:15.000Z"
            },
            "analyzing": {
                "lastactive": "2019-06-24T18:45:58.000Z",
                "count": "2"
            },
            "error": {
                "lastactive": null,
                "count": "0"
            }
        },...
    },...
}      
            

The same call, but with format=csv, returns this CSV output.

"company","organization","folder","mode","servers","queued.count",\
"queued.lastactive","decoding.count","decoding.lastactive","analyzing.count",\
"analyzing.lastactive","error.count","error.lastactive"
"DocTestCo","DocTestCo-DocTesting2","folder2","active","{""srvr1"":""OK""}",0,\
,,,"0",,"0",
"DocTestCo","DocTestCo-DocTesting3","folder3","active","{""srvr1"":""OK""}",0,\
"2019-06-18T18:58:30.000Z",,,"0","2019-06-18T18:59:29.000Z","0",
"DocTestCo","DocTestCo-DocTesting3","folder33","active","{""srvr1"":""OK""}",0,\
"2019-06-18T19:01:12.000Z",,,"0","2019-06-18T19:14:44.000Z","2","2019-06-18T19:14:00.000Z"

Example organization output

JSON output for a single organization resembles this example.

{
    "DocTestCo-DocTesting2": {
        "folder2": {
            "mode": "active",
            "servers": {
                "srvr1": "OK"
            },
            "jobmgr": {
                "192.168.150.71": {
                    "numerrs": 0,
                    "timestamp": "2019-06-24_18:40:28",
                    "hostname": "srvr1",
                    "numtranscoding": 0,
                    "version": "2.4.0-0",
                    "starttime": "2019-06-21_20:25:07",
                    "numdecoding": 0
                }
            },
            "queued": {
                "count": 0,
                "lastactive": "2019-06-24T18:36:15.000Z"
            },
            "analyzing": {
                "lastactive": "2019-06-24T18:45:58.000Z",
                "count": "2"
            },
            "error": {
                "lastactive": null,
                "count": "0"
            }
        },...
    }
}      

The same call, but with format=csv, returns this CSV output.

"company","organization","folder","mode","servers","queued.count",\
"queued.lastactive","decoding.count","decoding.lastactive","analyzing.count",
"analyzing.lastactive","error.count","error.lastactive"
"DocTestCo","DocTestCo-DocTesting","Test01","active","{""asrsrvr1"":""OK""}",0,\
"2017-06-16 09:06:45.584507060 -0400",0,"2017-06-16 09:05:45.451651713 -0400",0,\
"2017-06-16 09:15:24.235266461 -0400",1,"2017-05-18 12:46:55.780155897 -0400"