Query for Toolkit Sessions (v2.0)
POST/v2.0/api/tenants/:tenant_id/toolkitsessions/query
Query the DB for toolkit sessions that match query parameters.
Request
Path Parameters
The tenant ID.
- application/json
Body
- Array [
- ]
aggregate Aggregate
The aggregate number of passages 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 passages deleted for a time frame.
Group the passages for the query.
List the passages 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 [
- ]
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 PassageQueryFilter[]
The element ID.
Id
Indicate if passage is inactive. True or False.
The session ID.
Possible values: [ACTIVE
, REMOVED
, REMOVE_IN_PROGRESS
]
The passage state.
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"tenant_id": "string",
"total_count": 0,
"items": [
{
"element_id": "string",
"id": "string",
"inactive": true,
"session_id": "string",
"state": "ACTIVE"
}
]
}
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": "BAD_REQUEST"
}
]
}
}