mirror of
https://github.com/apache/superset.git
synced 2026-08-04 13:02:41 +00:00
266 lines
9.4 KiB
JSON
266 lines
9.4 KiB
JSON
{
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"description_columns": {
|
|
"properties": {
|
|
"column_name": {
|
|
"description": "The description for the column name. Will be translated by babel",
|
|
"example": "A Nice description for the column",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"id": { "description": "The item id", "type": "string" },
|
|
"label_columns": {
|
|
"properties": {
|
|
"column_name": {
|
|
"description": "The label for the column name. Will be translated by babel",
|
|
"example": "A Nice label for the column",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"result": {
|
|
"properties": {
|
|
"active": { "nullable": true, "type": "boolean" },
|
|
"chart": {
|
|
"properties": {
|
|
"id": { "type": "integer" },
|
|
"slice_name": {
|
|
"maxLength": 250,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"viz_type": {
|
|
"maxLength": 250,
|
|
"nullable": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "ReportScheduleRestApi.get.Slice"
|
|
},
|
|
"context_markdown": { "nullable": true, "type": "string" },
|
|
"creation_method": {
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"crontab": { "maxLength": 1000, "type": "string" },
|
|
"custom_width": { "nullable": true, "type": "integer" },
|
|
"dashboard": {
|
|
"properties": {
|
|
"dashboard_title": {
|
|
"maxLength": 500,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"id": { "type": "integer" }
|
|
},
|
|
"type": "object",
|
|
"title": "ReportScheduleRestApi.get.Dashboard"
|
|
},
|
|
"database": {
|
|
"properties": {
|
|
"database_name": { "maxLength": 250, "type": "string" },
|
|
"id": { "type": "integer" }
|
|
},
|
|
"required": ["database_name"],
|
|
"type": "object",
|
|
"title": "ReportScheduleRestApi.get.Database"
|
|
},
|
|
"description": { "nullable": true, "type": "string" },
|
|
"email_subject": {
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"extra": { "readOnly": true },
|
|
"force_screenshot": { "nullable": true, "type": "boolean" },
|
|
"grace_period": { "nullable": true, "type": "integer" },
|
|
"id": { "type": "integer" },
|
|
"last_eval_dttm": {
|
|
"format": "date-time",
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"last_state": {
|
|
"maxLength": 50,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"last_value": { "nullable": true, "type": "number" },
|
|
"last_value_row_json": { "nullable": true, "type": "string" },
|
|
"log_retention": { "nullable": true, "type": "integer" },
|
|
"name": { "maxLength": 150, "type": "string" },
|
|
"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": "ReportScheduleRestApi.get.User"
|
|
},
|
|
"recipients": {
|
|
"properties": {
|
|
"id": { "type": "integer" },
|
|
"recipient_config_json": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"type": { "maxLength": 50, "type": "string" }
|
|
},
|
|
"required": ["type"],
|
|
"type": "object",
|
|
"title": "ReportScheduleRestApi.get.ReportRecipients"
|
|
},
|
|
"report_format": {
|
|
"maxLength": 50,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"sql": { "nullable": true, "type": "string" },
|
|
"timezone": { "maxLength": 100, "type": "string" },
|
|
"type": { "maxLength": 50, "type": "string" },
|
|
"validator_config_json": {
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"validator_type": {
|
|
"maxLength": 100,
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"working_timeout": { "nullable": true, "type": "integer" }
|
|
},
|
|
"required": ["crontab", "name", "recipients", "type"],
|
|
"type": "object",
|
|
"title": "ReportScheduleRestApi.get"
|
|
},
|
|
"show_columns": {
|
|
"description": "A list of columns",
|
|
"items": { "type": "string" },
|
|
"type": "array"
|
|
},
|
|
"show_title": {
|
|
"description": "A title to render. Will be translated by babel",
|
|
"example": "Show Item Details",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"example": {
|
|
"description_columns": {
|
|
"column_name": "A Nice description for the column"
|
|
},
|
|
"id": "string",
|
|
"label_columns": { "column_name": "A Nice label for the column" },
|
|
"result": {
|
|
"active": true,
|
|
"context_markdown": "string",
|
|
"creation_method": "string",
|
|
"crontab": "string",
|
|
"custom_width": 1,
|
|
"description": "string",
|
|
"email_subject": "string",
|
|
"extra": {},
|
|
"force_screenshot": true,
|
|
"grace_period": 1,
|
|
"id": 1,
|
|
"last_eval_dttm": "2024-01-15T10:30:00Z",
|
|
"last_state": "string",
|
|
"last_value": 1,
|
|
"last_value_row_json": "string",
|
|
"log_retention": 1,
|
|
"name": "string",
|
|
"report_format": "string",
|
|
"sql": "string",
|
|
"timezone": "string",
|
|
"type": "string",
|
|
"validator_config_json": "string",
|
|
"validator_type": "string",
|
|
"working_timeout": 1
|
|
},
|
|
"show_columns": ["string"],
|
|
"show_title": "Show Item Details"
|
|
}
|
|
}
|
|
},
|
|
"description": "Item from Model"
|
|
},
|
|
"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"
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": { "message": { "type": "string" } },
|
|
"type": "object"
|
|
},
|
|
"example": {
|
|
"message": "Not found: The requested resource does not exist"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found"
|
|
},
|
|
"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"
|
|
}
|
|
}
|
|
}
|