Query Element Status Objects for Tenant (v2.3)
POST/v2.3/api/tenants/:tenant_id/elements/status/query
Query and get element the status objects for a tenant.
Request
Path Parameters
- application/json
Body
- Array [
- ]
aggregate Aggregate
The aggregate number of element status that match the query parameters.
data AggregateData[]
The details of the aggregate data.
Value of the aggregate data.
View the aggregate date.
Field
The name of the query response.
Possible values: [max
, count
, min
, avg
, sum
]
Operator
QoS application aggregate statistics.
The unit.
The destination page.
The number element status deleted for a time frame.
Group the element status for the query.
List the element status by ID.
Return the ID of a specified query in the current session.
The query limit.
The limit.
Query using query parameters.
Retrieve information from a field.
List the fields to query.
Specify the order in which you want the search criteria to display.
The total number of query parameters.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- ]
The actual count.
The deleted number.
The deleted IDs.
Description of the query. Max size = 256.
The ID.
Details of the next query.
The tenant ID.
Total number.
items ElementStatusQuery[]
aggregate Aggregate
The aggregate number of element status that match the query parameters.
data AggregateData[]
The details of the aggregate data.
Value of the aggregate data.
View the aggregate date.
Field
The name of the query response.
Possible values: [max
, count
, min
, avg
, sum
]
Operator
QoS application aggregate statistics.
The unit.
The destination page.
The number element status deleted for a time frame.
Group the element status for the query.
List the element status by ID.
Return the ID of a specified query in the current session.
The query limit.
The limit.
Query using query parameters.
Retrieve information from a field.
List the fields to query.
Specify the order in which you want the search criteria to display.
The total number of query parameters.
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"tenant_id": "string",
"total_count": 0,
"items": [
{
"aggregate": {
"data": [
{
"value": 0,
"view": {}
}
],
"field": "string",
"name": "string",
"operator": "max",
"statistic": "string",
"unit": "string"
},
"dest_page": 0,
"getDeleted": true,
"group_by": [
"string"
],
"id": "string",
"last_query_ts": 0,
"limit": 0,
"next_query": {},
"query_params": {},
"retrieved_fields": [
"string"
],
"retrieved_fields_mask": true,
"sort_params": {},
"total_count": 0
}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "ELEMENT_STATUS_NOT_FOUND"
}
]
}
}