Get All Tokens of a Query
get
/api/database/Queries/readTokens
Gets all the tokens of a query that matches the specified ID. The specified query must already have tokens for a successful result.
Request
Query Parameters
-
id(required): integer
The query ID.Example:
1001
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulGetOperation
The response body for a successful get operation.
-
object
type
Nested Schema : SuccessfulGetOperation
Type:
object
The response body for a successful get operation.
Show Source
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The list of tokens of the specified query.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : items
Type:
Show Source
object
-
DefaultValue: integer
The default value for the token.Example:
1
-
TokenIndex: integer
The token index.Example:
1
-
TokenName: string
The token name.Example:
Zone
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
-
Array of:
object items
An error.
Nested Schema : items
Type:
object
An error.