queries

Configure and send a query request to retrieve the desired entities based on specified parameters.

Execute the query defined by the payload

Path Parameters

  • tenantIdstringrequired

    Describes clientId of the tenant

Request Body

application/json

  • objectTypestring

    Query the category type

    Enum:
    resourcealerttickettopologytag
  • fieldsarray of strings

  • fileterCriteriastring

  • sortBystring

    Specifies the attribute used to sort the results. This field is optional. If not provided, the API returns results in the default order, which may not be ideal for paginated responses. The attribute must be one of the fields included in the response.

  • sortByOrderstring

    Sort order for results based on the sortBy attribute. Defaults to ASC (ascending order) if not specified.

    Enum:
    ASCDESC

    Default: ASC

  • pageNointeger

  • pageSizeinteger

    Default: 100

    Minimum: 1

    Maximum: 500

      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...