/dataset/{pk}

Get an item model

Responses

🟢200OK

application/json

Item from Model

Body

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

string

optional

The item 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

result

object (DatasetRestApi.get)

optional

cache_timeout

integer <int32> | null

optional

columns

object (Meta27)

required

database

object (Meta25)

required

datasource_type

read-onlyoptional

default_endpoint

string | null

optional

description

string | null

optional

extra

string | null

optional

fetch_values_predicate

string | null

optional

<= 1000 characters

filter_select_enabled

boolean | null

optional

integer <int32>

optional

is_sqllab_view

boolean | null

optional

main_dttm_col

string | null

optional

<= 250 characters

metrics

object (Meta26)

required

offset

integer <int32> | null

optional

owners

object (Meta28)

optional

schema

string | null

optional

<= 255 characters

sql

string | null

optional

table_name

string

required

<= 250 characters

template_params

string | null

optional

url

read-onlyoptional

show_columns

array[string]

optional

A list of columns

show_title

string

optional

A title to render. Will be translated by babel

Example:

Show Item Details

Example

{
    "description_columns": {
        "column_name": "A Nice description for the column"
    },
    "id": "string",
    "label_columns": {
        "column_name": "A Nice label for the column"
    },
    "result": {
        "cache_timeout": 0,
        "columns": {
            "changed_on": "2019-08-24T14:15:22Z",
            "column_name": "string",
            "created_on": "2019-08-24T14:15:22Z",
            "description": "string",
            "expression": "string",
            "filterable": true,
            "groupby": true,
            "id": 0,
            "is_active": true,
            "is_dttm": true,
            "python_date_format": "string",
            "type": "string",
            "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
            "verbose_name": "string"
        },
        "database": {
            "database_name": "string",
            "id": 0
        },
        "datasource_type": null,
        "default_endpoint": "string",
        "description": "string",
        "extra": "string",
        "fetch_values_predicate": "string",
        "filter_select_enabled": true,
        "id": 0,
        "is_sqllab_view": true,
        "main_dttm_col": "string",
        "metrics": {
            "changed_on": "2019-08-24T14:15:22Z",
            "created_on": "2019-08-24T14:15:22Z",
            "d3format": "string",
            "description": "string",
            "expression": "string",
            "extra": "string",
            "id": 0,
            "metric_name": "string",
            "metric_type": "string",
            "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
            "verbose_name": "string",
            "warning_text": "string"
        },
        "offset": 0,
        "owners": {
            "first_name": "string",
            "id": 0,
            "last_name": "string",
            "username": "string"
        },
        "schema": "string",
        "sql": "string",
        "table_name": "string",
        "template_params": "string",
        "url": null
    },
    "show_columns": [
        "string"
    ],
    "show_title": "Show Item Details"
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠422Parameter Error

🔴500Server Error

Request

Request samples

Responses