queries

Post a Query.Configure and post the query for the required entities.

Execute the query defined by the payload

Path Parameters

  • tenantIdstringrequired

    Describes clientId of the tenant

Request Body

application/json

  • objectTypestringrequired

    Query the category type

    Enum:
    resourcealertincidentaudittopologytag
  • fieldsarray of strings

    The list of fields as required when query matches the filter.

  • filterCriteriastring

    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

  • aggregateFunctionstring

    The supported aggregate function.

    Enum:
    countmaxminavg
  • groupByarray of strings

    Groups the data based on the given fields.

  • sortBystring

    Sorting the resultset based on the field.

  • pageNonumber

    Resultset page no.

  • pageSizenumber

    Data size in each resultset page.

      Loading Examples...

      Responses

      This endpoint accepts anyOf the following:

      object

      • resultsarray

      • pageNointeger

      • pageSizeinteger

      • nextPageboolean

      • descendingOrderboolean

      object

      • resultsarray

      • pageNointeger

      • pageSizeinteger

      • nextPageboolean

      • descendingOrderboolean

      object

      • resultsarray

      • pageNonumber

      • pageSizenumber

      • nextPageboolean

      • orderBystring

      • descendingOrderboolean

      object

      • resultsarray

      • pageNointeger

      • pageSizeinteger

      • nextPageboolean

      • descendingOrderboolean

      Loading Examples...