Task API Endpoint
This API endpoint allows querying the reporting data returned by the underlying processor node. Based on an optional "all" parameter, a high-level or complete report can be retrieved. For convenience sake, the submission ID ("ID" as returned by /submit) or a combination of the processor node task ID ("taskID") and application server ID ("appServerID") must be provided. The "nocache" parameter is optional and determines whether cached reporting data (if available) may be returned or if the underlying processor node is to be re-queried.
Syntax
GET https://<ip>:<port>/task
Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| serect | String | Y | Authentication secret |
| submitID | String | Y | Submit ID as returned by /submit |
| appServerID | String | Y | Must be provided in combination with "taskID", if "submitID" is not provided |
| taskID | String | Y | Must be provided in combination with "appServer-ID", if "submitID" is not provided |
| all | Boolean | N | Reject submitted files, if their hash (MD5/SHA-256) is on an internal or external whitelist |
| nocache | Boolean | N | Disallow returning cached reporting data (if available). It is not recommended to set this flag, as the underlying processor nodes may clean up expired tasks triggering a 404 response code. |
Example Response
{ "processTime": 535, "result": {}}Was this page helpful?