Bulk Sample Status

The Resource URL below is to find the status of bulk number of samples in a single query.

Resource URL

POST https://<MATD_IP>/php/getBulkStatus.php

The following HTTP headers should be specified in the resource URL request:

  • Accept: application/vnd.ve.v1.0+json
  • VE-SDK-API: Base64 encoded "session:user id" string

Input parameters

Input parameter Description
data Contains the below parameter defined in a json string:
  • bulkrequest: This parameter is a json string which accepts following sub-parameters:
    • numRequest: This is a numeric filed which contains the number of samples for which status is queried. The maximum value is 100.
    • jobIDs: This is an array of job ID's.
    • taskIDs: This parameter accepts array of task ID's.
      Note: jobIDs and taskIDs parameters are mutually exclusive.

Examples:

{'data': '{"bulkrequest":{"numRequest":3,"jobIDs":[41,42,47]}}'}

{'data': '{"bulkrequest":{"numRequest":1,"jobIDs":[150]}}'}

{'data': '{"bulkrequest":{"numRequest":1,"taskIDs":[2050]}}'}

{'data': '{"bulkrequest":{"numRequest":4,"taskIDs":[100,156,142,120]}}'}

Output parameters

Output parameter Description
Results Contains json data with following parameters:

numResponse: This is a numeric value which represents number of samples status retrieved. This is equal to numRequest in the input data.

status:This is an array of jobIDs/taskIDs with their analysis status and score.

JobID/taskID status displays following values:

  • -1 — not available
  • 1 — accepted
  • 2 — waiting
  • 3 — analyzing
  • 4 — xmode
  • 5 — completed
  • 6 — cancelled
  • 7 — invalid
  • 8 — discarded

score: The sample score defines the severity of the sample.

The score includes the following values:

  • -6 — Analysis not completed
  • -2 — Failed
  • -1 — Clean
  • 0 — Unverified
  • 1 — Informational
  • 2 — Low
  • 3 — Medium
  • 4 — High
  • 5 — Very High

Example

Status of single jobID:

Input

{'data': '{"bulkrequest":{"numRequest":1,"jobIDs":[4512]}}'}

Output

{"success":true, "results":{"bulkresponse": {"numResponse":1, "status":[{"jobID":4512,"status":5,"score":4}]}}}
Note:
  • When a jobID is not present in the database the status and score values in the response are 6 and -2 respectively.
  • When a jobID of a zip file is passed as input then the least status value among all the samples in the zip file at that moment is returned.

Status of multiple jobIDs:

Input

{'data': '{"bulkrequest":{"numRequest":3,"jobIDs":[41,30,12]}}'}

Output

{"success":true, "results":{"bulkresponse": {"numResponse":3, "status":[{"jobID":41,"status":5,"score":5},{"jobID":30,"status":5,"score":0},{"jobID":12,"status":5,"score":5}]}}}

Status of single taskID:

Input

{'data': '{"bulkrequest":{"numRequest":1,"taskIDs":[16090]}}'}

Output

{"success":true, "results":{"bulkresponse": {"numResponse":1, "status":[{"taskID":16090,"status":3,"score":-6}]}}}
Note:
  • Status '3' in the above response indicates that the sample with taskID '16090' is in analyzing state.
  • When a taskID is not present in the database the status and score values are -1 and -2 respectively.

Status of multiple taskIDs:

Input

{'data': '{"bulkrequest":{"numRequest":3,"taskIDs":[100,156,16109]}}'}

Output

{"success":true, "results":{"bulkresponse": {"numResponse":3, "status":[{"taskID":100,"status":5,"score":5},{"taskID":156,"status":5,"score":4},{"taskID":16109,"status":2,"score":-6}]}}}
Note: Status '2' in the above response indicates that the sample with taskID '16109' is in waiting state.

numRequest does not match with number of jobIDs/taskIDs:

Input
{'data': '{"bulkrequest":{"numRequest":4,"taskIDs":[80,12,15]}}'}

Output

{"success": false, "results": {"desc": "Invalid Request"} }