queries
Post a Query.Configure and post the query for the required entities.
Execute the query defined by the payload
Path Parameters
- tenantId
Describes clientId of the tenant
Request Body
application/json
- objectType
Query the category type
- Enum:
- resourcealertincidentaudittopologytag
- fields
The list of fields as required when query matches the filter.
- filterCriteria
Describes the string defining all the patterns supported by OpsQL. The filter criteria of the query is create by the supported operators and attribute values. For details on how to create query for OpsQL please refer `https://docs.opsramp.com/platform-features/feature-guides/query-language-reference/query-language-ref/` See "opsql-overview" guide
- aggregateFunction
The supported aggregate function.
- Enum:
- countmaxminavg
- groupBy
Groups the data based on the given fields.
- sortBy
Sorting the resultset based on the field.
- pageNo
Resultset page no.
- pageSize
Data size in each resultset page.
Responses
This endpoint accepts anyOf the following:
object
- results
- pageNo
- pageSize
- nextPage
- descendingOrder
object
- results
- pageNo
- pageSize
- nextPage
- descendingOrder
object
- results
- pageNo
- pageSize
- nextPage
- orderBy
- descendingOrder
object
- results
- pageNo
- pageSize
- nextPage
- descendingOrder