Files
superset2/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetrestapi-get.Schema.json

180 lines
6.5 KiB
JSON

{
"schema": {
"properties": {
"always_filter_main_dttm": { "nullable": true, "type": "boolean" },
"cache_timeout": { "readOnly": true },
"catalog": { "maxLength": 256, "nullable": true, "type": "string" },
"changed_by": {
"properties": {
"first_name": { "maxLength": 64, "type": "string" },
"last_name": { "maxLength": 64, "type": "string" }
},
"required": ["first_name", "last_name"],
"type": "object",
"title": "DatasetRestApi.get.User2"
},
"changed_on": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"changed_on_humanized": { "readOnly": true },
"column_formats": { "readOnly": true },
"columns": {
"properties": {
"advanced_data_type": {
"maxLength": 255,
"nullable": true,
"type": "string"
},
"changed_on": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"column_name": { "maxLength": 255, "type": "string" },
"created_on": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"description": { "nullable": true, "type": "string" },
"expression": { "nullable": true, "type": "string" },
"extra": { "nullable": true, "type": "string" },
"filterable": { "nullable": true, "type": "boolean" },
"groupby": { "nullable": true, "type": "boolean" },
"id": { "type": "integer" },
"is_active": { "nullable": true, "type": "boolean" },
"is_dttm": { "nullable": true, "type": "boolean" },
"python_date_format": {
"maxLength": 255,
"nullable": true,
"type": "string"
},
"type": { "nullable": true, "type": "string" },
"type_generic": { "readOnly": true },
"uuid": { "format": "uuid", "nullable": true, "type": "string" },
"verbose_name": {
"maxLength": 1024,
"nullable": true,
"type": "string"
}
},
"required": ["column_name"],
"type": "object",
"title": "DatasetRestApi.get.TableColumn"
},
"created_by": {
"properties": {
"first_name": { "maxLength": 64, "type": "string" },
"last_name": { "maxLength": 64, "type": "string" }
},
"required": ["first_name", "last_name"],
"type": "object",
"title": "DatasetRestApi.get.User1"
},
"created_on": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"created_on_humanized": { "readOnly": true },
"currency_code_column": {
"maxLength": 250,
"nullable": true,
"type": "string"
},
"database": {
"properties": {
"allow_multi_catalog": { "readOnly": true },
"backend": { "readOnly": true },
"database_name": { "maxLength": 250, "type": "string" },
"id": { "type": "integer" },
"uuid": { "format": "uuid", "nullable": true, "type": "string" }
},
"required": ["database_name"],
"type": "object",
"title": "DatasetRestApi.get.Database"
},
"datasource_name": { "readOnly": true },
"datasource_type": { "readOnly": true },
"default_endpoint": { "nullable": true, "type": "string" },
"description": { "nullable": true, "type": "string" },
"extra": { "nullable": true, "type": "string" },
"fetch_values_predicate": { "nullable": true, "type": "string" },
"filter_select_enabled": { "nullable": true, "type": "boolean" },
"folders": { "nullable": true },
"granularity_sqla": { "readOnly": true },
"id": { "type": "integer" },
"is_managed_externally": { "type": "boolean" },
"is_sqllab_view": { "nullable": true, "type": "boolean" },
"kind": { "readOnly": true },
"main_dttm_col": { "maxLength": 250, "nullable": true, "type": "string" },
"metrics": {
"properties": {
"changed_on": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"created_on": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"currency": { "nullable": true },
"d3format": { "maxLength": 128, "nullable": true, "type": "string" },
"description": { "nullable": true, "type": "string" },
"expression": { "type": "string" },
"extra": { "nullable": true, "type": "string" },
"id": { "type": "integer" },
"metric_name": { "maxLength": 255, "type": "string" },
"metric_type": {
"maxLength": 32,
"nullable": true,
"type": "string"
},
"uuid": { "format": "uuid", "nullable": true, "type": "string" },
"verbose_name": {
"maxLength": 1024,
"nullable": true,
"type": "string"
},
"warning_text": { "nullable": true, "type": "string" }
},
"required": ["expression", "metric_name"],
"type": "object",
"title": "DatasetRestApi.get.SqlMetric"
},
"name": { "readOnly": true },
"normalize_columns": { "nullable": true, "type": "boolean" },
"offset": { "nullable": true, "type": "integer" },
"order_by_choices": { "readOnly": true },
"owners": {
"properties": {
"first_name": { "maxLength": 64, "type": "string" },
"id": { "type": "integer" },
"last_name": { "maxLength": 64, "type": "string" }
},
"required": ["first_name", "last_name"],
"type": "object",
"title": "DatasetRestApi.get.User"
},
"schema": { "maxLength": 255, "nullable": true, "type": "string" },
"select_star": { "readOnly": true },
"sql": { "nullable": true, "type": "string" },
"table_name": { "maxLength": 250, "type": "string" },
"template_params": { "nullable": true, "type": "string" },
"time_grain_sqla": { "readOnly": true },
"uid": { "readOnly": true },
"url": { "readOnly": true },
"uuid": { "format": "uuid", "nullable": true, "type": "string" },
"verbose_map": { "readOnly": true }
},
"required": ["columns", "database", "metrics", "table_name"],
"type": "object",
"title": "DatasetRestApi.get"
},
"schemaType": "response"
}