Advanced File API Filtering and Sorting
Filtering and sorting on the File and PDF report APIs include support for a variety of filter and sort combinations.
Some filtering and all sorting parameters support sending a list of values separated by comma, which take part of a logical OR filter (the property can be any of the given values).
Filtering
Filtering supports the following query parameter fields:
| Query parameter | Possible values | Description | Allows list of values |
|---|---|---|---|
| startDate | A valid DateTime | no | |
| endDate | A valid DateTime | no | |
| search | A string value | no | |
| scanType |
| yes | |
| storageId | A valid storage id | yes | |
| scanId | A valid scan id | yes | |
| scanWorkflowSnapshotId | A valid snapshot id | yes | |
| processingState |
| State of processing in MDSS | yes |
| result |
| Result of MDSS | yes |
| scanAllResultI | General result of the Scan Instance | yes | |
| scanResultICount | An integer >= 0 | The number of engine results that are not "No threat detected" | yes |
| vulnerabilityCount | An integer >= 0 | The number of vulnerabilities detected | yes |
| dlpDetection | Boolean true or false | DLP detection | no |
| remediations |
| Remediations performed | yes |
Sorting
Sorting supports multiple parameters, which are used if there is an equality between the values of the preceding sort. If multiple sorts are used, the property and order are matched in order between the two lists of values. The following query parameter fields are available:
| Query parameter | Possible values |
|---|---|
| sortBy |
|
| sortOrder |
|
Was this page helpful?