/query/

Get a list of queries, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.

Responses

🟢200OK

application/json

Items from Model

Body

count

number

optional

The total record count on the backend

description_columns

object

optional

column_name

string

optional

The description for the column name. Will be translated by babel

Example:

A Nice description for the column

ids

array[string]

optional

A list of item ids, useful when you don't know the column id

label_columns

object

optional

column_name

string

optional

The label for the column name. Will be translated by babel

Example:

A Nice label for the column

list_columns

array[string]

optional

A list of columns

list_title

string

optional

A title to render. Will be translated by babel

Example:

List Items

order_columns

array[string]

optional

A list of allowed columns to sort

result

array[object (QueryRestApi.get_list) {15}]

optional

The result from the get list query

changed_on

string <date-time> | null

optional

database

object (Meta30)

required

end_time

number | null

optional

executed_sql

string | null

optional

integer <int32>

optional

rows

integer <int32> | null

optional

schema

string | null

optional

<= 256 characters

sql

string | null

optional

sql_tables

read-onlyoptional

start_time

number | null

optional

status

string | null

optional

<= 16 characters

tab_name

string | null

optional

<= 256 characters

tmp_table_name

string | null

optional

<= 256 characters

tracking_url

string | null

optional

user

object (Meta29)

optional

Example

{
    "count": 0,
    "description_columns": {
        "column_name": "A Nice description for the column"
    },
    "ids": [
        "string"
    ],
    "label_columns": {
        "column_name": "A Nice label for the column"
    },
    "list_columns": [
        "string"
    ],
    "list_title": "List Items",
    "order_columns": [
        "string"
    ],
    "result": [
        {
            "changed_on": "2019-08-24T14:15:22Z",
            "database": {
                "database_name": "string"
            },
            "end_time": 0,
            "executed_sql": "string",
            "id": 0,
            "rows": 0,
            "schema": "string",
            "sql": "string",
            "sql_tables": null,
            "start_time": 0,
            "status": "string",
            "tab_name": "string",
            "tmp_table_name": "string",
            "tracking_url": "string",
            "user": {
                "first_name": "string",
                "id": 0,
                "last_name": "string",
                "username": "string"
            }
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠422Parameter Error

🔴500Server Error

Request

Request samples

Responses