Query Cellular Modules (v2.0)
POST/v2.0/api/tenants/:tenant_id/cellular_modules/query
Query the DB for limit number of cellular modules that match query parameters.
Request
Path Parameters
ID of the tenant.
- application/json
Body
- Array [
- ]
aggregate Aggregate
The aggregate number of cellular module that match the query parameters.
data AggregateData[]required
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 of cellular module for a time frame.
Group the cellular module for the query.
Lists the cellular module by ID.
Return the ID of a specified query in the current session.
The query limit.
The limit.
Retrieve information from a field.
List the fields to query.
The total number of query parameters.
Responses
- 200
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
The count of the query list.
The deleted number of queries.
The deleted query IDs.
Description of the query. Max size = 256.
The ID.
Details of the next query.
The tenant ID.
Total number of queries.
items CellularModuleQueryFilter[]
The description of the cellular module. Max size = 256.
The element ID.
Indicates if the GPS is enabled for the cellular module.
The ID of the cellular module.
The name of the cellular module. Max size = 128.urce name.
The primary SIM attribute of the cellular module.
Indicates the radio on attribute.
An information field that can be added to identify the cellular module. Maximum 10 unique tags of length 1024 each are allowed.
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"tenant_id": "string",
"total_count": 0,
"items": [
{
"element_id": "string",
"gps_enable": true,
"id": "string",
"name": "string",
"primary_sim": 0,
"radio_on": true,
"tags": [
"string"
]
}
]
}