/dataset/{pk}

PUT

/dataset/{pk}

Changes a Dataset

Request

Path Params

Body Params application/json

Example

{
    "cache_timeout": 0,
    "columns": [
        {
            "column_name": "string",
            "description": "string",
            "expression": "string",
            "filterable": true,
            "groupby": true,
            "id": 0,
            "is_active": true,
            "is_dttm": true,
            "python_date_format": "string",
            "type": "string",
            "uuid": "string",
            "verbose_name": "string"
        }
    ],
    "database_id": 0,
    "default_endpoint": "string",
    "description": "string",
    "extra": "string",
    "fetch_values_predicate": "string",
    "filter_select_enabled": true,
    "is_sqllab_view": true,
    "main_dttm_col": "string",
    "metrics": [
        {
            "d3format": "string",
            "description": "string",
            "expression": "string",
            "id": 0,
            "metric_name": "string",
            "metric_type": "string",
            "warning_text": "string"
        }
    ],
    "offset": 0,
    "owners": [
        0
    ],
    "schema": "string",
    "sql": "string",
    "table_name": "string",
    "template_params": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/dataset/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cache_timeout": 0,
    "columns": [
        {
            "column_name": "string",
            "description": "string",
            "expression": "string",
            "filterable": true,
            "groupby": true,
            "id": 0,
            "is_active": true,
            "is_dttm": true,
            "python_date_format": "string",
            "type": "string",
            "uuid": "string",
            "verbose_name": "string"
        }
    ],
    "database_id": 0,
    "default_endpoint": "string",
    "description": "string",
    "extra": "string",
    "fetch_values_predicate": "string",
    "filter_select_enabled": true,
    "is_sqllab_view": true,
    "main_dttm_col": "string",
    "metrics": [
        {
            "d3format": "string",
            "description": "string",
            "expression": "string",
            "id": 0,
            "metric_name": "string",
            "metric_type": "string",
            "warning_text": "string"
        }
    ],
    "offset": 0,
    "owners": [
        0
    ],
    "schema": "string",
    "sql": "string",
    "table_name": "string",
    "template_params": "string"
}'

Responses

🟢200OK

application/json

Dataset changed

Body

Example

{
    "id": 0,
    "result": {
        "cache_timeout": 0,
        "columns": [
            {
                "column_name": "string",
                "description": "string",
                "expression": "string",
                "filterable": true,
                "groupby": true,
                "id": 0,
                "is_active": true,
                "is_dttm": true,
                "python_date_format": "string",
                "type": "string",
                "uuid": "string",
                "verbose_name": "string"
            }
        ],
        "database_id": 0,
        "default_endpoint": "string",
        "description": "string",
        "extra": "string",
        "fetch_values_predicate": "string",
        "filter_select_enabled": true,
        "is_sqllab_view": true,
        "main_dttm_col": "string",
        "metrics": [
            {
                "d3format": "string",
                "description": "string",
                "expression": "string",
                "id": 0,
                "metric_name": "string",
                "metric_type": "string",
                "warning_text": "string"
            }
        ],
        "offset": 0,
        "owners": [
            0
        ],
        "schema": "string",
        "sql": "string",
        "table_name": "string",
        "template_params": "string"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-04 22:27:17

/dataset/{pk}

/dataset/{pk}/refresh