Get List of Risks

post

https://{hostname}/api/risk/v2/risks/pages

Use this API to retrieve a paginated list of risks based on search criteria and sorting options.

Query Params

page

int32

≥ 0

Defaults to 0

Results page to be retrieved (0..N)

size

int32

1 to 100

Defaults to 20

Number of records per page (1..50)

sort

string

enum

Defaults to createdDate,desc

Sorting criteria in the format: property(,asc|desc). Default sort order is descending.

Body Params

filters

object

Map of field names to their filter values for exact matching +This will be a Map of String Key and Object value. 'fieldname' key is mandatory to be passed, followed by value, example could be like name as some riskName

predicates

array of objects

Set of attribute predicates for complex search conditions

predicates

fullTextSearch

string

Full text search term to search across risk fields

visibleColumns

array of strings

List of column names to include in the response

visibleColumns

includeHierarchicalChildInventoryRisks

boolean

Defaults to false

Include risks associated with inventory related as children in Inventory hierarchy

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

200OK

429Too Many Requests. For more information, see API Rate Limits.