Skip to main content
Version: Next

DatasetRestApi.put

always_filter_main_dttmboolean
Default value: false
cache_timeoutintegernullable
catalogstringnullable

Possible values: <= 250 characters

columns object[]
  • Array [
  • advanced_data_typestringnullable

    Possible values: non-empty and <= 255 characters

    column_namestringrequired

    Possible values: non-empty and <= 255 characters

    descriptionstringnullable
    expressionstringnullable
    extrastringnullable
    filterableboolean
    groupbyboolean
    idinteger
    is_activebooleannullable
    is_dttmbooleannullable
    python_date_formatstringnullable

    Possible values: non-empty and <= 255 characters

    typestringnullable
    uuidstring<uuid>nullable
    verbose_namestringnullable
  • ]
  • database_idinteger
    default_endpointstringnullable
    descriptionstringnullable
    external_urlstringnullable
    extrastringnullable
    fetch_values_predicatestringnullable

    Possible values: <= 1000 characters

    filter_select_enabledbooleannullable
    folders object[]
  • Array [
  • childrenundefined[]nullable
    descriptionstringnullable

    Possible values: <= 1000 characters

    namestring

    Possible values: non-empty and <= 250 characters

    typestring

    Possible values: [metric, column, folder]

    uuidstring<uuid>required
  • ]
  • is_managed_externallybooleannullable
    is_sqllab_viewbooleannullable
    main_dttm_colstringnullable
    metrics object[]
  • Array [
  • currencystringnullable

    Possible values: non-empty and <= 128 characters

    d3formatstringnullable

    Possible values: non-empty and <= 128 characters

    descriptionstringnullable
    expressionstringrequired
    extrastringnullable
    idinteger
    metric_namestringrequired

    Possible values: non-empty and <= 255 characters

    metric_typestringnullable

    Possible values: non-empty and <= 32 characters

    uuidstring<uuid>nullable
    verbose_namestringnullable
    warning_textstringnullable
  • ]
  • normalize_columnsbooleannullable
    offsetintegernullable
    ownersinteger[]
    schemastringnullable

    Possible values: <= 255 characters

    sqlstringnullable
    table_namestringnullable

    Possible values: non-empty and <= 250 characters

    template_paramsstringnullable
    DatasetRestApi.put
    {
    "always_filter_main_dttm": false,
    "cache_timeout": 0,
    "catalog": "string",
    "columns": [
    {
    "advanced_data_type": "string",
    "column_name": "string",
    "description": "string",
    "expression": "string",
    "extra": "string",
    "filterable": true,
    "groupby": true,
    "id": 0,
    "is_active": true,
    "is_dttm": true,
    "python_date_format": "string",
    "type": "string",
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "verbose_name": "string"
    }
    ],
    "database_id": 0,
    "default_endpoint": "string",
    "description": "string",
    "external_url": "string",
    "extra": "string",
    "fetch_values_predicate": "string",
    "filter_select_enabled": true,
    "folders": [
    {
    "children": [
    null
    ],
    "description": "string",
    "name": "string",
    "type": "metric",
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    ],
    "is_managed_externally": true,
    "is_sqllab_view": true,
    "main_dttm_col": "string",
    "metrics": [
    {
    "currency": "string",
    "d3format": "string",
    "description": "string",
    "expression": "string",
    "extra": "string",
    "id": 0,
    "metric_name": "string",
    "metric_type": "string",
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "verbose_name": "string",
    "warning_text": "string"
    }
    ],
    "normalize_columns": true,
    "offset": 0,
    "owners": [
    0
    ],
    "schema": "string",
    "sql": "string",
    "table_name": "string",
    "template_params": "string"
    }