字段

Field的API端点。

DELETE /api/field/:id/dimension

移除与ID关联的字段维度。

参数

• id的值必须是一个大于零的整数。

GET /api/field/:id

获取ID为Field的Field。

参数

• id的值必须是一个大于零的整数。

• include_editable_data_model的值必须是一个有效的布尔字符串（“true”或“false”）。

GET /api/field/:id/related

返回相关实体。

参数

• id的值必须是一个大于零的整数。

GET /api/field/:id/remapping/:remapped-id

检索重新映射的字段值。

参数

• id的值必须是一个大于零的整数。

• remapped-id的值必须是一个大于零的整数。

• value的值必须是一个非空字符串。

GET /api/field/:id/search/:search-id

搜索具有search-id的Field值，以value开头。有关更详细的说明，请参阅metabase.api.field/search-values的文档字符串。

参数

• id的值必须是一个大于零的整数。

• search-id的值必须是一个大于零的整数。

• value的值必须是一个非空字符串。

GET /api/field/:id/summary

获取ID为Field的计数和唯一计数。

参数

• id的值必须是一个大于零的整数。

GET /api/field/:id/values

如果字段的has_field_values值为:list，则返回字段（或重新映射的字段）的所有不同值的列表（如果由用户定义，则还包括可读性映射的值映射）。如果has_field_values不是:list，则检查是否应该为该字段创建FieldValues；如果是这样，则创建并返回它们。

参数

• id的值必须是一个大于零的整数。

POST /api/field/:id/dimension

设置ID给定的字段的维度。

参数

• id的值必须是一个大于零的整数。

• dimension-type枚举为internal，external。

• dimension-name的值必须是一个非空字符串。

• human_readable_field_id可空值必须是一个大于零的整数。

POST /api/field/:id/discard_values

丢弃属于此字段的FieldValues。仅适用于有FieldValues的字段。如果此字段的数据库设置为自动同步FieldValues，它们将在下一个周期中重新创建。

参数

• id的值必须是一个大于零的整数。

POST /api/field/:id/rescan_values

手动触发此字段的FieldValues的更新。仅适用于有资格使用FieldValues的字段。

参数

• id的值必须是一个大于零的整数。

POST /api/field/:id/values

更新具有语义类型为category/city/state/country或基类型为type/Boolean的Field的字段值和可读值。可读值是可选的。

参数

• id的值必须是一个大于零的整数。

• value-pairs向量序列，恰好有1项类型：任何内容，或向量，恰好有2项类型：任何内容，值必须是一个非空字符串。

PUT /api/field/:id

更新ID为Field的Field。

参数

• visibility_type 可空枚举，包含已退休、敏感、正常、隐藏、仅详情。

• display_name 可空，值必须是非空字符串。

• points_of_interest 可空，值必须是非空字符串。

• description 可空，值必须是非空字符串。

• semantic_type 可空，值必须是有效的字段语义或关系类型（关键词或字符串）。

• coercion_strategy 可空，值必须是有效的强制转换策略（关键词或字符串）。

• has_field_values 可空枚举，包含：auto-list、:list、:none、:search。

• settings 可空，值必须是一个映射。

• caveats 可空，值必须是非空字符串。

• fk_target_field_id 可空，值必须是一个大于零的整数。

• nfc_path 可空，值必须是非空字符串序列。

• id的值必须是一个大于零的整数。

• json_unfolding 可空布尔值。

---

返回 API 索引