Query DB for Tenant Extensions (v2.0)
POST/sdwan/v2.0/api/ws/extensions/query
Query the DB for limit number of tenant extensions that match the query params.
Request
- application/json
Body
- Array [
- ]
aggregate Aggregate
Aggregate
data AggregateData[]
The details of the aggregate data.
Value of the aggregate data.
View the aggregate date.
The field value.
The name of the query response.
Possible values: [max
, count
, min
, avg
, sum
]
The operator values.
The aggregate statistics.
The unit.
Dest Page
GetDeleted
Group By
The ID.
Last Query Ts
Limit
Retrieved Fields
Retrieved Fields Mask
Total Count
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
The actual count.
The deleted number.
The deleted IDs.
Description of the query. Max size = 256.
The ID.
Details of the next query.
Total number.
items ExtensionQueryFilter[]
List the disabled extensions.
The ID.
The name of the extension. Max size = 128.
The extension namespace. Values = ^[a-z][a-z0-9/]*[a-z0-9]+$
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"total_count": 0,
"items": [
{
"conf": {},
"disabled": true,
"id": "string",
"name": "string",
"namespace": "string"
}
]
}
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": "INVALID_REQUEST_ERROR_0001"
},
{
"code": "INVALID_REQUEST_DUPLICATE_KEY"
}
]
}
}