表格
/api/table 端点。
GET /api/table/
获取所有 表格
。
GET /api/table/:id
获取ID为的 表格
。
参数
-
id
的值必须是一个大于零的整数。 -
include_editable_data_model
可选布尔值。
GET /api/table/:id/fks
获取所有目标为属于此 表格
的 字段
的外键。
参数
id
的值必须是一个大于零的整数。
GET /api/table/:id/query_metadata
获取用于运行查询的 表格
元数据。返回数据库、字段、字段外键和字段值。
传递 include_hidden_fields=true
将包含响应中的任何隐藏的 字段
。默认为 false
。传递 include_sensitive_fields=true
将包含响应中的任何敏感 字段
。默认为 false
。
传递 include_editable_data_model=true
将检查当前用户是否有对表格数据模型的写入权限,而 false
检查他们是否有对表格的数据访问权限。默认为 false
。
这些选项提供用于在管理员编辑元数据页面中使用。
参数
-
id
的值必须是一个大于零的整数。 -
include_sensitive_fields
可选值必须是一个有效的布尔字符串(“true”或“false”)。 -
include_hidden_fields
可选值必须是一个有效的布尔字符串(“true”或“false”)。 -
include_editable_data_model
可选值必须是一个有效的布尔字符串(“true”或“false”)。
GET /api/table/:id/related
返回相关实体。
参数
id
的值必须是一个大于零的整数。
GET /api/table/card__:id/fks
返回Card的“虚拟”表格的外键信息。这总是空的,因此此端点主要用作占位符,以避免在前端进行任何更改。
参数
id
的值必须是一个大于零的整数。
GET /api/table/card__:id/query_metadata
返回Card的“虚拟”表格的元数据。
参数
id
的值必须是一个大于零的整数。
POST /api/table/:id/append-csv
将上传的CSV文件的行插入由 :id
标识的表中。该表必须是通过上传CSV文件创建的。
参数
-
id
的值必须是一个大于零的整数。 -
raw-params
POST /api/table/:id/discard_values
丢弃属于此表中的 字段
的 字段值
。仅适用于具有 字段值
的字段。如果此表的数据库设置为自动同步 字段值
,则它们将在下一个周期中重新创建。
参数
id
的值必须是一个大于零的整数。
POST /api/table/:id/replace-csv
用上传的CSV文件的行替换由 :id
标识的表的内容。该表必须是通过上传CSV文件创建的。
参数
-
id
的值必须是一个大于零的整数。 -
raw-params
POST /api/table/:id/rescan_values
手动触发此表所属的 字段
的 字段值
的更新。仅适用于有资格进行 字段值
的字段。
参数
id
的值必须是一个大于零的整数。
PUT /api/table/
更新所有 表格
。
参数
-
ids
的值必须是一个大于零的整数序列。 -
display_name
可选值必须是一个非空字符串。 -
entity_type
可选值必须是一个有效的实体类型(关键字或字符串)。 -
visibility_type
可选枚举值为技术、隐藏、垃圾。 -
description
可选字符串。 -
caveats
可选字符串。 -
points_of_interest
可选字符串。 -
show_in_getting_started
可选布尔值。
PUT /api/table/:id
更新 表格
的 ID。
参数
-
visibility_type
可选枚举值为技术、隐藏、垃圾。 -
field_order
可空的枚举类型为:按字母顺序、自定义、数据库、智能。 -
display_name
可选值必须是一个非空字符串。 -
points_of_interest
可选字符串。 -
entity_type
可选值必须是一个有效的实体类型(关键字或字符串)。 -
description
可选字符串。 -
show_in_getting_started
可选布尔值。 -
caveats
可选字符串。 -
id
的值必须是一个大于零的整数。
PUT /api/table/:id/fields/order
重新排序字段。
参数
-
id
的值必须是一个大于零的整数。 -
field_order
的值序列必须是一个大于零的整数。
阅读其他 Metabase 版本的文档。