Files
superset2/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-new-dataset.StatusCodes.json

128 lines
3.8 KiB
JSON

{
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": { "type": "number" },
"result": {
"properties": {
"always_filter_main_dttm": {
"default": false,
"type": "boolean"
},
"catalog": {
"maxLength": 250,
"minLength": 0,
"nullable": true,
"type": "string"
},
"database": { "type": "integer" },
"external_url": { "nullable": true, "type": "string" },
"is_managed_externally": {
"nullable": true,
"type": "boolean"
},
"normalize_columns": { "default": false, "type": "boolean" },
"owners": { "items": { "type": "integer" }, "type": "array" },
"schema": {
"maxLength": 250,
"minLength": 0,
"nullable": true,
"type": "string"
},
"sql": { "nullable": true, "type": "string" },
"table_name": {
"maxLength": 250,
"minLength": 1,
"type": "string"
},
"template_params": { "nullable": true, "type": "string" },
"uuid": {
"format": "uuid",
"nullable": true,
"type": "string"
}
},
"required": ["database", "table_name"],
"type": "object",
"title": "DatasetRestApi.post"
}
},
"type": "object"
},
"example": {
"id": 1,
"result": {
"always_filter_main_dttm": true,
"catalog": "string",
"database": 1,
"external_url": "string",
"is_managed_externally": true,
"normalize_columns": true,
"owners": [],
"schema": "string",
"sql": "string",
"table_name": "string",
"template_params": "string",
"uuid": "550e8400-e29b-41d4-a716-446655440000"
}
}
}
},
"description": "Dataset 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"
},
"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"
}
}
}