Skip to main content

REST API：status

🌐 REST API: status

Page summary:

REST API 的 status 参数通过文档的发布状态进行过滤，通过传递 status=draft 来返回已发布的版本（默认）或草稿。

🌐 The REST API's status parameter filters documents by their publication state, returning either published versions (default) or drafts by passing status=draft.

REST API 提供根据状态（草稿或已发布）过滤结果的功能。

🌐 The REST API offers the ability to filter results based on their status, draft or published.

Prerequisites

应该启用 Draft & Publish 功能。

🌐 The Draft & Publish feature should be enabled.

查询可以接受一个 status 参数以根据其状态获取文档：

🌐 Queries can accept a status parameter to fetch documents based on their status:

  • published：仅返回文档的已发布版本（默认）
  • draft：仅返回文档的草稿版本
Tip

在响应数据中，publishedAt 字段对于草稿来说是 null。

🌐 In the response data, the publishedAt field is null for drafts.

Note

由于默认返回已发布版本，因此不传递状态参数等同于传递 status=published。

🌐 Since published versions are returned by default, passing no status parameter is equivalent to passing status=published.

要按文档草稿与已发布版本的关系（从未发布、已修改及其他）选择文档，请参见 REST API：publicationFilter。

🌐 To select documents by how their draft and published versions relate (never-published, modified, and others), see REST API: publicationFilter.



GET/api/articles?status=draft

获取餐厅草稿版本

通过传递 status=draft 查询参数返回文档的草稿版本。

terminal
curl 'http://localhost:1337/api/articles?status=draft' \
  -H 'Authorization: Bearer <token>'
200 OK
{
  "data": [
    {
      "id": 5,
      "documentId": "znrlzntu9ei5onjvwfaalu2v",
      "Name": "Biscotte Restaurant",
      "Description": [
        {
          "type": "paragraph",
          "children": [
            {
              "type": "text",
              "text": "This is the draft version."
            }
          ]
        }
      ],
      "createdAt": "2024-03-06T13:43:30.172Z",
      "updatedAt": "2024-03-06T21:38:46.353Z",
      "publishedAt": null,
      "locale": "en"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pageSize": 25,
      "pageCount": 1,
      "total": 4
    }
  }
}