{ "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "id": { "type": "number" }, "result": { "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`.", "type": "integer" }, "datasource_name": { "description": "The datasource name.", "nullable": true, "type": "string" }, "datasource_type": { "description": "The type of dataset/datasource identified on `datasource_id`.", "enum": [ "table", "dataset", "query", "saved_query", "view" ], "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": 1, "type": "string" }, "uuid": { "format": "uuid", "nullable": true, "type": "string" }, "viz_type": { "description": "The type of chart visualization used.", "example": ["bar", "area", "table"], "maxLength": 250, "minLength": 0, "type": "string" } }, "required": ["datasource_id", "datasource_type", "slice_name"], "type": "object", "title": "ChartRestApi.post" } }, "type": "object" }, "example": { "id": 1, "result": { "cache_timeout": 1, "certification_details": "string", "certified_by": "string", "dashboards": [], "datasource_id": 1, "datasource_name": "string", "datasource_type": "table", "description": "string", "external_url": "string", "is_managed_externally": true, "owners": [], "params": "string", "query_context": "string", "query_context_generation": true, "slice_name": "string", "uuid": "550e8400-e29b-41d4-a716-446655440000", "viz_type": ["bar", "area", "table"] } } } }, "description": "Chart added" }, "400": { "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" }, "example": { "message": "Bad request: Invalid parameters provided" } } }, "description": "Bad request" }, "401": { "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" }, "example": { "message": "Unauthorized: Authentication required" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" }, "example": { "message": "Forbidden: You don't have permission to access this resource" } } }, "description": "Forbidden" }, "422": { "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" }, "example": { "message": "Unprocessable entity: Validation error" } } }, "description": "Could not process entity" }, "500": { "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" }, "example": { "message": "Internal server error: An unexpected error occurred" } } }, "description": "Fatal error" } } }