Get Run Status
Determine the status of a given run (collection or review generation).
GET https://instance.securid.com/aveksa/command.submit?cmd=getRunStatus
Request
Parameters
| getRunStatus | |
| format | properties - (Default) key=value. most useful when requesting a single object. If multiple objects are returned, values is a csv. ie key=value1,value2,value3 where value1 is the value for the first object, value2 is the value for the 2nd object, etc.json - Useful format for parsing into javascript or other languages. See www.json.org for details. |
| The id of the run to delete. |
Headers
Bearer token | |
| Accept | application/json |
| Content-Type | application/json |
Response
Parameters
type | Executed command name |
overall-status | The overall status of the run. Possible values are New, Running, Completed, Aborted |
start-time | The time the run started. |
completed-time | The time the run completed. This property is only returned if the run is completed. |
Examples
Request
- Curl
- Python
curl -K -X GET \
"https://instance.securid.com/aveksa/command.submit?cmd=getRunStatus&run-id=1&format=json" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"
import requests,json
url = "https://instance.securid.com/aveksa/command.submit"
params = {
"cmd": "getRunStatus",
"run-id": "1",
"format": "json"
}
headers = {
'Authorization': 'Bearer <token>',
'Content-Type': 'application/json'
}
response = requests.get(url, params=params, headers=headers)
if response.status_code == 200:
data = response.json()
print(data)
else:
print(f"Request failed with status code {response.status_code}")
Response
- 200
- 404 Invalid Parameter
- 412 Missing Parameter
{
"data": {
"type": "getRunStatus",
"overall-status": "Completed",
"start-time": "2022-03-24 10:34:01",
"completed-time": "2022-03-24 10:34:06"
}
}
<html>
<head>
<title>Error</title>
</head>
<body>The run-id 144444 is invalid. Query
String=cmd=getRunStatus&format=json&run-id=144444</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The parameter run-id is required. Query String=cmd=getRunStatus&format=json</body>
</html>