Query DB for DEM Site Config (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/demsiteconfigs/query

Query the DB for DEM site configs that match query parameters.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

application/json

Body

Query Details for Dem site configs

aggregate Aggregate

Aggregate

data AggregateData[]

The details of the aggregate data.

Array [

value number

Value of the aggregate data.

view object

View the aggregate date.

]

field string

Field

name string

The name of the query response.

operator string

Possible values: [max, count, min, avg, sum]

Operator

statistic string

QoS application aggregate statistics.

unit string

The unit.

dest_page int32

Dest Page

getDeleted boolean

GetDeleted

group_by string[]

Group By

id string

Id

last_query_ts int64

Last Query Ts

limit int32

Limit

next_query object
query_params object
retrieved_fields string[]

Retrieved Fields

retrieved_fields_mask boolean

Retrieved Fields Mask

sort_params object
total_count int64

Total Count

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

deleted_count int64

The deleted number.

deleted_ids string[]

The deleted IDs.

description

Description of the query. Max size = 256.

id string

The ID.

next_query object

Details of the next query.

tenant_id string

The tenant ID.

total_count int64

Total number.

items DemSiteConfigQueryFilter[]
Array [
adem_enabled boolean
The site ADEM enabled. True or False.
id string
The ID.
site_id stringrequired
The site ID.
tenant_id stringrequired
Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "adem_enabled": true,
      "id": "string",
      "site_id": "string",
      "tenant_id": "string"
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "BAD_QUERY_REQUEST"
      }
    ]
  }
}

Loading...