Submit Result API Endpoint

This API endpoint allows querying the response data of the underlying processor node, to which the broker submitted the accepted file. It will contain the application server ID, HTTP status code, result as well as the position in queue, if not submitted yet. If the file was submitted to a processor node, the state will be SUCCESS. Possible state values are: QUEUED, FAILED, SUCCESS.

Note: this API is very lightweight and can be used to quickly obtain the queue position and submission status. For retrieval of the actual reporting, the /task API should be used.

Syntax

GET https://<ip>:<port>/submit-result

Parameters

NameTypeRequired?Description
serectStringYAuthentication secret
submitIDStringYSubmit ID as returned by /submit

Example Response

JSON
Copy
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Next to read:
Task API Endpoint

See the "Technical Datasheet" for a complete list of features: https://docs.opswat.com/filescan/datasheet/technical-datasheet

On This Page
Submit Result API EndpointSyntaxParametersExample Response