/dataset/

Get a list of models

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 (DatasetRestApi.get_list) {15}]

optional

The result from the get list query

changed_by

object (Meta22)

optional

changed_by_name

read-onlyoptional

changed_by_url

read-onlyoptional

changed_on_delta_humanized

read-onlyoptional

changed_on_utc

read-onlyoptional

database

object (Meta24)

required

default_endpoint

string | null

optional

explore_url

read-onlyoptional

extra

string | null

optional

integer <int32>

optional

kind

read-onlyoptional

owners

object (Meta23)

optional

schema

string | null

optional

<= 255 characters

sql

string | null

optional

table_name

string

required

<= 250 characters

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_by": {
                "first_name": "string",
                "username": "string"
            },
            "changed_by_name": null,
            "changed_by_url": null,
            "changed_on_delta_humanized": null,
            "changed_on_utc": null,
            "database": {
                "database_name": "string",
                "id": 0
            },
            "default_endpoint": "string",
            "explore_url": null,
            "extra": "string",
            "id": 0,
            "kind": null,
            "owners": {
                "first_name": "string",
                "id": 0,
                "last_name": "string",
                "username": "string"
            },
            "schema": "string",
            "sql": "string",
            "table_name": "string"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠422Parameter Error

🔴500Server Error

Request

Request samples

Responses