Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

BatchGetFindings

Returns a list of requested findings from standard scans.

Request Syntax


POST /batchGetFindings HTTP/1.1
Content-type: application/json

{
   "findingIdentifiers": [ 
      { 
         "findingId": "string",
         "scanName": "string"
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

findingIdentifiers

A list of finding identifiers. Each identifier consists of a scanName and a findingId. You retrieve the findingId when you call GetFindings.

Type: Array of FindingIdentifier objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "failedFindings": [ 
      { 
         "errorCode": "string",
         "findingId": "string",
         "message": "string",
         "scanName": "string"
      }
   ],
   "findings": [ 
      { 
         "createdAt": number,
         "description": "string",
         "detectorId": "string",
         "detectorName": "string",
         "detectorTags": [ "string" ],
         "generatorId": "string",
         "id": "string",
         "remediation": { 
            "recommendation": { 
               "text": "string",
               "url": "string"
            },
            "suggestedFixes": [ 
               { 
                  "code": "string",
                  "description": "string"
               }
            ]
         },
         "resource": { 
            "id": "string",
            "subResourceId": "string"
         },
         "ruleId": "string",
         "severity": "string",
         "status": "string",
         "title": "string",
         "type": "string",
         "updatedAt": number,
         "vulnerability": { 
            "filePath": { 
               "codeSnippet": [ 
                  { 
                     "content": "string",
                     "number": number
                  }
               ],
               "endLine": number,
               "name": "string",
               "path": "string",
               "startLine": number
            },
            "id": "string",
            "itemCount": number,
            "referenceUrls": [ "string" ],
            "relatedVulnerabilities": [ "string" ]
         }
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

failedFindings

A list of errors for individual findings which were not fetched. Each BatchGetFindingsError contains the scanName, findingId, errorCode and error message.

Type: Array of BatchGetFindingsError objects

findings