# Notes API > 原文：[https://docs.gitlab.com/ee/api/notes.html](https://docs.gitlab.com/ee/api/notes.html) * [Notes pagination](#notes-pagination) * [Issues](#issues) * [List project issue notes](#list-project-issue-notes) * [Get single issue note](#get-single-issue-note) * [Create new issue note](#create-new-issue-note) * [Modify existing issue note](#modify-existing-issue-note) * [Delete an issue note](#delete-an-issue-note) * [Snippets](#snippets) * [List all snippet notes](#list-all-snippet-notes) * [Get single snippet note](#get-single-snippet-note) * [Create new snippet note](#create-new-snippet-note) * [Modify existing snippet note](#modify-existing-snippet-note) * [Delete a snippet note](#delete-a-snippet-note) * [Merge Requests](#merge-requests) * [List all merge request notes](#list-all-merge-request-notes) * [Get single merge request note](#get-single-merge-request-note) * [Create new merge request note](#create-new-merge-request-note) * [Modify existing merge request note](#modify-existing-merge-request-note) * [Delete a merge request note](#delete-a-merge-request-note) * [Epics](#epics-ultimate) * [List all epic notes](#list-all-epic-notes) * [Get single epic note](#get-single-epic-note) * [Create new epic note](#create-new-epic-note) * [Modify existing epic note](#modify-existing-epic-note) * [Delete an epic note](#delete-an-epic-note) # Notes API[](#notes-api "Permalink") 注釋是對以下內容的評論： * Snippets * Issues * 合并要求 * Epics 這包括系統注釋，這些注釋是有關對象更改的注釋（例如，當里程碑更改時，將有相應的系統注釋）. 標簽注釋不是此 API 的一部分，而是在[資源標簽事件中](resource_label_events.html)記錄為單獨的[事件](resource_label_events.html) . ## Notes pagination[](#notes-pagination "Permalink") 默認情況下，因為 API 結果是分頁的，所以`GET`請求一次返回 20 個結果. 閱讀有關[分頁的](README.html#pagination)更多信息. ## Issues[](#issues "Permalink") ### List project issue notes[](#list-project-issue-notes "Permalink") 獲取單個問題的所有注釋的列表. ``` GET /projects/:id/issues/:issue_iid/notes GET /projects/:id/issues/:issue_iid/notes?sort=asc&order_by=updated_at ``` | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 項目的 ID 或[URL 編碼的路徑](README.html#namespaced-path-encoding) | | `issue_iid` | integer | yes | 問題的 IID | | `sort` | string | no | 返回按`asc`或`desc`排列的發行說明. 默認為`desc` | | `order_by` | string | no | 返回按`created_at`或`updated_at`字段排序的發行說明. 默認為`created_at` | ``` [ { "id": 302, "body": "closed", "attachment": null, "author": { "id": 1, "username": "pipin", "email": "admin@example.com", "name": "Pip", "state": "active", "created_at": "2013-09-30T13:46:01Z" }, "created_at": "2013-10-02T09:22:45Z", "updated_at": "2013-10-02T10:22:45Z", "system": true, "noteable_id": 377, "noteable_type": "Issue", "noteable_iid": 377, "resolvable": false, "confidential": false }, { "id": 305, "body": "Text of the comment\r\n", "attachment": null, "author": { "id": 1, "username": "pipin", "email": "admin@example.com", "name": "Pip", "state": "active", "created_at": "2013-09-30T13:46:01Z" }, "created_at": "2013-10-02T09:56:03Z", "updated_at": "2013-10-02T09:56:03Z", "system": true, "noteable_id": 121, "noteable_type": "Issue", "noteable_iid": 121, "resolvable": false, "confidential": true } ] ``` ``` curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/11/notes" ``` ### Get single issue note[](#get-single-issue-note "Permalink") 返回有關特定項目問題的單個注釋 ``` GET /projects/:id/issues/:issue_iid/notes/:note_id ``` Parameters: * `id` （必填）-項目的 ID 或[URL 編碼的路徑](README.html#namespaced-path-encoding) * `issue_iid` （必填）-項目問題的 IID * `note_id` （必填）-問題注釋的 ID ``` curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/11/notes/1" ``` ### Create new issue note[](#create-new-issue-note "Permalink") 為單個項目問題創建新的注釋. ``` POST /projects/:id/issues/:issue_iid/notes ``` Parameters: * `id` （必填）-項目的 ID 或[URL 編碼的路徑](README.html#namespaced-path-encoding) * `issue_iid` （必填）-問題的 IID * `body` （必填）-注釋的內容. 限制為 1,000,000 個字符. * `confidential` （可選）-便箋的機密標志. 默認為 false. * `created_at` （可選）-日期時間字符串，ISO 8601 格式，例如 2016-03-11T03：45：40Z（需要管理員或項目/組所有者權限） ``` curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/11/notes?body=note" ``` ### Modify existing issue note[](#modify-existing-issue-note "Permalink") 修改問題的現有注釋. ``` PUT /projects/:id/issues/:issue_iid/notes/:note_id ``` Parameters: * `id` （必填）-項目的 ID 或[URL 編碼的路徑](README.html#namespaced-path-encoding) * `issue_iid` （必填）-問題的 IID * `note_id` （必填）-注釋的 ID * `body` （必填）-注釋的內容. 限制為 1,000,000 個字符. ``` curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/11/notes?body=note" ``` ### Delete an issue note[](#delete-an-issue-note "Permalink") 刪除問題的現有注釋. ``` DELETE /projects/:id/issues/:issue_iid/notes/:note_id ``` Parameters: | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 項目的 ID 或[URL 編碼的路徑](README.html#namespaced-path-encoding) | | `issue_iid` | integer | yes | 問題的 IID | | `note_id` | integer | yes | 筆記的 ID | ``` curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/11/notes/636" ``` ## Snippets[](#snippets "Permalink") ### List all snippet notes[](#list-all-snippet-notes "Permalink") 獲取單個代碼段的所有注釋的列表. 片段注釋是用戶可以發布到片段的注釋. ``` GET /projects/:id/snippets/:snippet_id/notes GET /projects/:id/snippets/:snippet_id/notes?sort=asc&order_by=updated_at ``` | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 項目的 ID 或[URL 編碼的路徑](README.html#namespaced-path-encoding) | | `snippet_id` | integer | yes | 項目代碼段的 ID | | `sort` | string | no | 返回按`asc`或`desc`順序排序的`asc`注釋. 默認為`desc` | | `order_by` | string | no | 返回按`created_at`或`updated_at`字段排序的`created_at`注釋. 默認為`created_at` | ``` curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/snippets/11/notes" ``` ### Get single snippet note[](#get-single-snippet-note "Permalink") 返回給定片段的單個音符. ``` GET /projects/:id/snippets/:snippet_id/notes/:note_id ``` Parameters: * `id` （必填）-項目的 ID 或[URL 編碼的路徑](README.html#namespaced-path-encoding) * `snippet_id` （必填）-項目代碼段的 ID * `note_id` （必填）- `note_id`的 ID ``` { "id": 52, "title": "Snippet", "file_name": "snippet.rb", "author": { "id": 1, "username": "pipin", "email": "admin@example.com", "name": "Pip", "state": "active", "created_at": "2013-09-30T13:46:01Z" }, "expires_at": null, "updated_at": "2013-10-02T07:34:20Z", "created_at": "2013-10-02T07:34:20Z" } ``` ``` curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/snippets/11/notes/11" ``` ### Create new snippet note[](#create-new-snippet-note "Permalink") 為單個代碼段創建新的音符. 片段注釋是用戶可以發布到片段的注釋. 如果您在主體僅包含獎勵表情符號的位置創建注釋，則會收到該對象的回信. ``` POST /projects/:id/snippets/:snippet_id/notes ``` Parameters: * `id` （必填）-項目的 ID 或[URL 編碼的路徑](README.html#namespaced-path-encoding) * `snippet_id` （必填）-代碼段的 ID * `body` （必填）-注釋的內容. 限制為 1,000,000 個字符. * `created_at` （可選）-日期時間字符串，ISO 8601 格式，例如 2016-03-11T03：45：40Z ``` curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/snippet/11/notes?body=note" ``` ### Modify existing snippet note[](#modify-existing-snippet-note "Permalink") 修改代碼段的現有注釋. ``` PUT /projects/:id/snippets/:snippet_id/notes/:note_id ``` Parameters: * `id` (required) - The ID or [URL-encoded path of the project](README.html#namespaced-path-encoding) * `snippet_id` （必填）-代碼段的 ID * `note_id` （必填）-注釋的 ID * `body` （必填）-注釋的內容. 限制為 1,000,000 個字符. ``` curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/snippets/11/notes?body=note" ``` ### Delete a snippet note[](#delete-a-snippet-note "Permalink") 刪除片段的現有注釋. ``` DELETE /projects/:id/snippets/:snippet_id/notes/:note_id ``` Parameters: | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 項目的 ID 或[URL 編碼的路徑](README.html#namespaced-path-encoding) | | `snippet_id` | integer | yes | 片段的 ID | | `note_id` | integer | yes | 筆記的 ID | ``` curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/snippets/52/notes/1659" ``` ## Merge Requests[](#merge-requests "Permalink") ### List all merge request notes[](#list-all-merge-request-notes "Permalink") 獲取單個合并請求的所有注釋的列表. ``` GET /projects/:id/merge_requests/:merge_request_iid/notes GET /projects/:id/merge_requests/:merge_request_iid/notes?sort=asc&order_by=updated_at ``` | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 項目的 ID 或[URL 編碼的路徑](README.html#namespaced-path-encoding) | | `merge_request_iid` | integer | yes | 項目合并請求的 IID | | `sort` | string | no | 返回以`asc`或`desc`順序排序的合并請求注釋. 默認為`desc` | | `order_by` | string | no | 返回由`created_at`或`updated_at`字段排序的合并請求注釋. 默認為`created_at` | ``` curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes" ``` ### Get single merge request note[](#get-single-merge-request-note "Permalink") 返回給定合并請求的單個注釋. ``` GET /projects/:id/merge_requests/:merge_request_iid/notes/:note_id ``` Parameters: * `id` （必填）-項目的 ID 或[URL 編碼的路徑](README.html#namespaced-path-encoding) * `merge_request_iid` （必填）-項目合并請求的 IID * `note_id` （必需）-合并請求注釋的 ID ``` { "id": 301, "body": "Comment for MR", "attachment": null, "author": { "id": 1, "username": "pipin", "email": "admin@example.com", "name": "Pip", "state": "active", "created_at": "2013-09-30T13:46:01Z" }, "created_at": "2013-10-02T08:57:14Z", "updated_at": "2013-10-02T08:57:14Z", "system": false, "noteable_id": 2, "noteable_type": "MergeRequest", "noteable_iid": 2, "resolvable": false, "confidential": false } ``` ``` curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes/1" ``` ### Create new merge request note[](#create-new-merge-request-note "Permalink") 為單個合并請求創建一個新注釋. 如果您在主體僅包含獎勵表情符號的位置創建注釋，則會收到該對象的回信. ``` POST /projects/:id/merge_requests/:merge_request_iid/notes ``` Parameters: * `id` （必填）-項目的 ID 或[URL 編碼的路徑](README.html#namespaced-path-encoding) * `merge_request_iid` （必填）-合并請求的 IID * `body` （必填）-注釋的內容. 限制為 1,000,000 個字符. * `created_at` （可選）-日期時間字符串，ISO 8601 格式，例如 2016-03-11T03：45：40Z ### Modify existing merge request note[](#modify-existing-merge-request-note "Permalink") 修改合并請求的現有注釋. ``` PUT /projects/:id/merge_requests/:merge_request_iid/notes/:note_id ``` Parameters: * `id` （必填）-項目的 ID 或[URL 編碼的路徑](README.html#namespaced-path-encoding) * `merge_request_iid` （必填）-合并請求的 IID * `note_id` （必填）-注釋的 ID * `body` （必填）-注釋的內容. 限制為 1,000,000 個字符. ``` curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes?body=note" ``` ### Delete a merge request note[](#delete-a-merge-request-note "Permalink") 刪除合并請求的現有注釋. ``` DELETE /projects/:id/merge_requests/:merge_request_iid/notes/:note_id ``` Parameters: | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 項目的 ID 或[URL 編碼的路徑](README.html#namespaced-path-encoding) | | `merge_request_iid` | integer | yes | 合并請求的 IID | | `note_id` | integer | yes | 筆記的 ID | ``` curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/7/notes/1602" ``` ## Epics[](#epics-ultimate "Permalink") ### List all epic notes[](#list-all-epic-notes "Permalink") 獲取單個史詩的所有注釋的列表. 史詩筆記是用戶可以發布到史詩中的評論. ``` GET /groups/:id/epics/:epic_id/notes GET /groups/:id/epics/:epic_id/notes?sort=asc&order_by=updated_at ``` | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 組的 ID 或[URL 編碼的路徑](README.html#namespaced-path-encoding) | | `epic_id` | integer | yes | 小組史詩的 ID | | `sort` | string | no | 返回按`asc`或`desc`排列的史詩筆記. 默認為`desc` | | `order_by` | string | no | 返回按`created_at`或`updated_at`字段排序的史詩筆記. 默認為`created_at` | ``` curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epics/11/notes" ``` ### Get single epic note[](#get-single-epic-note "Permalink") 返回給定史詩的單個音符. ``` GET /groups/:id/epics/:epic_id/notes/:note_id ``` Parameters: | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 組的 ID 或[URL 編碼的路徑](README.html#namespaced-path-encoding) | | `epic_id` | integer | yes | 史詩的 ID | | `note_id` | integer | yes | 筆記的 ID | ``` { "id": 52, "title": "Epic", "file_name": "epic.rb", "author": { "id": 1, "username": "pipin", "email": "admin@example.com", "name": "Pip", "state": "active", "created_at": "2013-09-30T13:46:01Z" }, "expires_at": null, "updated_at": "2013-10-02T07:34:20Z", "created_at": "2013-10-02T07:34:20Z", "confidential": false } ``` ``` curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epics/11/notes/1" ``` ### Create new epic note[](#create-new-epic-note "Permalink") 為單個史詩創建新的音符. 史詩筆記是用戶可以發布到史詩中的評論. 如果您在主體僅包含獎勵表情符號的位置創建注釋，則會收到該對象的回信. ``` POST /groups/:id/epics/:epic_id/notes ``` Parameters: | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 組的 ID 或[URL 編碼的路徑](README.html#namespaced-path-encoding) | | `epic_id` | integer | yes | 史詩的 ID | | `body` | string | yes | 注釋的內容. 限制為 1,000,000 個字符. | ``` curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/snippet/11/notes?body=note" ``` ### Modify existing epic note[](#modify-existing-epic-note "Permalink") 修改史詩的現有注釋. ``` PUT /groups/:id/epics/:epic_id/notes/:note_id ``` Parameters: | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 組的 ID 或[URL 編碼的路徑](README.html#namespaced-path-encoding) | | `epic_id` | integer | yes | 史詩的 ID | | `note_id` | integer | yes | 筆記的 ID | | `body` | string | yes | 注釋的內容. 限制為 1,000,000 個字符. | ``` curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/snippet/11/notes?body=note" ``` ### Delete an epic note[](#delete-an-epic-note "Permalink") 刪除史詩的現有音符. ``` DELETE /groups/:id/epics/:epic_id/notes/:note_id ``` Parameters: | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 組的 ID 或[URL 編碼的路徑](README.html#namespaced-path-encoding) | | `epic_id` | integer | yes | 史詩的 ID | | `note_id` | integer | yes | 筆記的 ID | ``` curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epics/52/notes/1659" ```