Files
superset2/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarestapi-put.Schema.json

95 lines
3.3 KiB
JSON

{
"schema": {
"properties": {
"cache_timeout": {
"description": "Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.",
"nullable": true,
"type": "integer"
},
"certification_details": {
"description": "Details of the certification",
"nullable": true,
"type": "string"
},
"certified_by": {
"description": "Person or group that has certified this chart",
"nullable": true,
"type": "string"
},
"dashboards": {
"items": {
"description": "A list of dashboards to include this new chart to.",
"type": "integer"
},
"type": "array"
},
"datasource_id": {
"description": "The id of the dataset/datasource this new chart will use. A complete datasource identification needs `datasource_id` and `datasource_type`.",
"nullable": true,
"type": "integer"
},
"datasource_type": {
"description": "The type of dataset/datasource identified on `datasource_id`.",
"enum": ["table", "dataset", "query", "saved_query", "view", null],
"nullable": true,
"type": "string"
},
"description": {
"description": "A description of the chart propose.",
"nullable": true,
"type": "string"
},
"external_url": { "nullable": true, "type": "string" },
"is_managed_externally": { "nullable": true, "type": "boolean" },
"owners": {
"items": {
"description": "Owner are users ids allowed to delete or change this chart. If left empty you will be one of the owners of the chart.",
"type": "integer"
},
"type": "array"
},
"params": {
"description": "Parameters are generated dynamically when clicking the save or overwrite button in the explore view. This JSON object for power users who may want to alter specific parameters.",
"nullable": true,
"type": "string"
},
"query_context": {
"description": "The query context represents the queries that need to run in order to generate the data the visualization, and in what format the data should be returned.",
"nullable": true,
"type": "string"
},
"query_context_generation": {
"description": "The query context generation represents whether the query_contextis user generated or not so that it does not update user modifiedstate.",
"nullable": true,
"type": "boolean"
},
"slice_name": {
"description": "The name of the chart.",
"maxLength": 250,
"minLength": 0,
"nullable": true,
"type": "string"
},
"tags": {
"items": {
"description": "Tags to be associated with the chart",
"type": "integer"
},
"type": "array"
},
"uuid": { "format": "uuid", "nullable": true, "type": "string" },
"viz_type": {
"description": "The type of chart visualization used.",
"example": ["bar", "area", "table"],
"maxLength": 250,
"minLength": 0,
"nullable": true,
"type": "string"
}
},
"type": "object",
"title": "ChartDataRestApi.put"
},
"schemaType": "response"
}