收集

/api/collection 端点。默认情况下，这些端点在名为“默认”的命名空间中操作集合，这个命名空间包含仪表板和卡片等东西。还存在其他命名空间的集合，例如 :snippet 命名空间（在UI中为“片段文件夹”）。这些命名空间是独立的层级。要为其他命名空间的集合使用这些端点，您可以传递 ?namespace= 参数（例如，?namespace=snippet）。

GET /api/collection/

获取当前用户有读取权限的所有集合的列表（每个集合返回的 :can_write 作为附加属性，以便您可以确定哪些集合您有写入权限。）

默认情况下，此操作返回非存档集合，但您也可以通过传递 ?archived=true 来显示存档集合。

默认情况下，管理员用户将看到所有集合。要隐藏其他用户的集合，请传递 ?exclude-other-user-collections=true。

如果个人专属是 true，则仅返回个人集合，其中 personal_owner_id 不是 nil。

参数

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

• exclude-other-user-collections 可空值必须是一个有效的布尔字符串（“true”或“false”）。

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

• personal-only 可空值必须是一个有效的布尔字符串（“true”或“false”）。

GET /api/collection/:id

获取具有标准详细信息的特定集合。

参数

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

GET /api/collection/:id/items

获取特定集合的条目，以下选项如下

• models - 仅包含特定集合的 models 对象。如果未指定，则返回所有模型的对象。
• archived - 当 true 时，返回存档对象而不是未存档对象。默认为 false。
• pinned_state - 当 is_pinned 时，仅返回固定对象。当 is_not_pinned 时，仅返回非固定对象。当 all 时，返回所有内容。默认返回所有内容。

参数

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

• models 可空枚举值为 dashboard, dataset, no_models, timeline, snippet, collection, pulse, metric, card。

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

• pinned_state 可空枚举值为 is_not_pinned, is_pinned, all。

• sort_column 可空枚举值为 model, name, last_edited_by, last_edited_at。

• sort_direction 可空枚举值为 desc, asc。

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

GET /api/collection/:id/timelines

获取特定集合的时间线。

参数

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

• include 可空的必须等于事件。

• archived 可空的布尔值。

GET /api/collection/graph

获取所有集合权限的图。

你必须是一位超级用户才能执行此操作。

参数

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

GET /api/collection/root

返回带有标准详细信息的“根”集合对象。

参数

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

GET /api/collection/root/items

获取当前用户应在根级别看到的对象。如前所述，“根”集合实际上在应用程序数据库中不存在行：它只是一个没有 collection_id 的虚拟集合。然而，它确实有一套自己的权限。

此端点实际上会显示没有 collection_id 的对象，这些对象具有根集合权限的用户，但对于没有根集合权限的人来说，我们只显示具有有效位置 / 的对象。

此端点旨在为当前用户提供“根文件夹视图”，因此无论怎样，您都会看到所有允许访问的顶级对象。

默认情况下，这将显示“正常”的集合命名空间；要查看不同的集合命名空间，例如 snippets，可以传递 ?namespace= 参数。

参数

• models 可空枚举值为 dashboard, dataset, no_models, timeline, snippet, collection, pulse, metric, card。

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

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

• pinned_state 可空枚举值为 is_not_pinned, is_pinned, all。

• sort_column 可空枚举值为 model, name, last_edited_by, last_edited_at。

• sort_direction 可空枚举值为 desc, asc。

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

GET /api/collection/root/timelines

获取根集合的时间线。

参数

• include 可空的必须等于事件。

• archived 可空的布尔值。

GET /api/collection/trash

获取废纸篓集合，如 /api/collection/:trash-id。

GET /api/collection/tree

类似于 GET /，但以树结构返回集合，例如。

  [{:name     "A"
  :below    #{:card :dataset}
  :children [{:name "B"}
             {:name     "C"
              :here     #{:dataset :card}
              :below    #{:dataset :card}
              :children [{:name     "D"
                          :here     #{:dataset}
                          :children [{:name "E"}]}
                         {:name     "F"
                          :here     #{:card}
                          :children [{:name "G"}]}]}]}
  {:name "H"}]

这里和下面的键表示树此特定级别的项目类型（这里）及其子树（下面）。

TODO：出于历史原因，此操作返回“已保存问题”为“卡片”以及模型为“数据集”；我们应在未来的某个时间修复此问题。

参数

• exclude-archived 可空的布尔值。

• exclude-other-user-collections 可空的布尔值。

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

• shallow 可空的布尔值。

• collection-id 可空的值必须是大于零的整数。

POST /api/collection/

创建一个新的集合。

参数

• name 值必须是非空字符串。

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

• parent_id 可空的值必须是大于零的整数。

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

• authority_level 可空的枚举值为 official。

PUT /api/collection/:id

修改现有的集合，包括存档或取消存档它，或移动它。

参数

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

• name 可空的值必须是非空字符串。

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

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

• parent_id 可空的值必须是大于零的整数。

• authority_level 可空的枚举值为 official。

• collection-updates

PUT /api/collection/graph

通过传入修改后的图来批量更新集合权限。将覆盖请求中存在的图的部分，并保留其余部分不变。

如果 skip_graph 查询参数为 true，则它将只返回当前修订版。

你必须是一位超级用户才能执行此操作。

参数

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

• revision 值必须是一个整数。

• groups 映射。

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

« 回到API索引