段落

/api/segment 端点。

DELETE /api/segment/:id

存档段。 (已弃用 – 直接将 :archived 的更新值传递给 PUT 端点即可)。

参数

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

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

GET /api/segment/

获取所有 段。

GET /api/segment/:id

获取具有 ID 的 段。

参数

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

GET /api/segment/:id/related

返回相关实体。

参数

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

GET /api/segment/:id/revisions

获取具有 ID 的 段 的 修订版本。

参数

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

POST /api/segment/

创建一个新的 段。

参数

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

• description 可为空字符串。

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

• definition 的值必须是一个映射。

POST /api/segment/:id/revert

将 Segement 回滚到之前的 修订版本。

参数

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

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

PUT /api/segment/:id

更新具有 ID 的 段。

参数

• points_of_interest 可为空字符串。

• description 可为空字符串。

• archived 可为空布尔值。

• definition 可为空映射。

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

• show_in_getting_started 可为空布尔值。

• name 可为空值，但必须是非空字符串。

• caveats 可为空字符串。

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

---

« 返回 API 索引