ON PREMISES SOLUTIONS

getSubmissionStatus

Returns the final status of the detonation.

Parameters

Parameter

Type

Optional

Description

submissionId

String

No

The ID of the submission for which the status should be retrieved.

Return value

This method returns an Object containing the status:

  • status - an Integer representing the final status. It can have one of the following values:

    • 1 - completed, if the detonation was successful

    • 2 - pending, if the detonation is currently in progress

    • 3 - failed, if the detonation failed

    • 4 - not supported, if the file cannot be detonated

Example

Request:

  {
     "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
     "jsonrpc": "2.0",
     "method": "getSubmissionStatus",
     "params": {
        "submissionId": "sp02_1547807011_936_e5"
     }
  }   

Response:

  {
    "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
    "jsonrpc": "2.0",
    "result": {
      "status": 1
    }
  }