时间轴

/api/timeline 端点。

DELETE /api/timeline/:id

删除一个 [[时间线]]。将级联删除其事件。

参数

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

GET /api/timeline/

获取 [[时间线]] 列表。可以通过添加 archived=true 来返回已存档的时间线。

参数

  • include 可空枚举的事件。

  • archived 可空值必须是一个有效的布尔字符串('true' 或 'false')。

GET /api/timeline/:id

获取具有 id 的 [[时间线]]。添加 include=events 来包括时间线上的已存档事件。添加 archived=true 来返回时间线上的所有事件,包括已存档和未存档的事件。

参数

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

  • include 可空枚举的事件。

  • archived 可空值必须是一个有效的布尔字符串('true' 或 'false')。

  • start 可空值必须是一个有效的日期字符串。

  • end 可空值必须是一个有效的日期字符串。

POST /api/timeline/

创建一个新的 [[时间线]]。

参数

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

  • default 可空布尔值。

  • description 可空字符串。

  • icon 可空枚举(星星、蛋糕、信件、警告、铃铛、云)。

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

  • archived 可空布尔值。

PUT /api/timeline/:id

更新具有 id 的 [[时间线]]。返回不包含事件的时线。存档时间线将存档该时间线中的所有事件。

参数

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

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

  • default 可空布尔值。

  • description 可空字符串。

  • icon 可空枚举(星星、蛋糕、信件、警告、铃铛、云)。

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

  • archived 可空布尔值。

  • timeline-updates


« 返回到 API 索引

阅读其他 Metabase 版本的文档

想改进这些文档? 提出更改。