Award Emoji API · Gitlab 中文文档

# Award Emoji API > 原文：[https://docs.gitlab.com/ee/api/award_emoji.html](https://docs.gitlab.com/ee/api/award_emoji.html) * [Issues, merge requests, and snippets](#issues-merge-requests-and-snippets) * [List an awardable’s award emoji](#list-an-awardables-award-emoji) * [Get single award emoji](#get-single-award-emoji) * [Award a new emoji](#award-a-new-emoji) * [Delete an award emoji](#delete-an-award-emoji) * [Award Emoji on Comments](#award-emoji-on-comments) * [List a comment’s award emoji](#list-a-comments-award-emoji) * [Get an award emoji for a comment](#get-an-award-emoji-for-a-comment) * [Award a new emoji on a comment](#award-a-new-emoji-on-a-comment) * [Delete an award emoji from a comment](#delete-an-award-emoji-from-a-comment) # Award Emoji API[](#award-emoji-api "Permalink") 在 GitLab 8.9 中[引入](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/4575) . 在 8.12 中添加了代码段支持. [获奖的表情符号](../user/award_emojis.html)讲出一千个单词. 可以通过以下方式授予表情符号（称为"奖项"）： * [Issues](../user/project/issues/index.html) ([API](issues.html)). * [Merge requests](../user/project/merge_requests/index.html) ([API](merge_requests.html)). * [Snippets](../user/snippets.html) ([API](snippets.html)). Emoji can also [be awarded](../user/award_emojis.html#award-emoji-for-comments) on comments (also known as notes). See also [Notes API](notes.html). ## Issues, merge requests, and snippets[](#issues-merge-requests-and-snippets "Permalink") 有关将这些端点与注释一起使用的信息，请参见[在注释](#award-emoji-on-comments)上[授予 Emoji 表情](#award-emoji-on-comments) . ### List an awardable’s award emoji[](#list-an-awardables-award-emoji "Permalink") 获取指定奖励的所有奖励表情符号的列表. ``` GET /projects/:id/issues/:issue_iid/award_emoji GET /projects/:id/merge_requests/:merge_request_iid/award_emoji GET /projects/:id/snippets/:snippet_id/award_emoji ``` Parameters: | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 项目的 ID 或[URL 编码路径](README.html#namespaced-path-encoding) . | | `issue_iid`/`merge_request_iid`/`snippet_id` | integer | yes | `iid` ID（合并请求/问题的`id` ，摘要的`id` ）. | 请求示例： ``` curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji" ``` 响应示例： ``` [ { "id": 4, "name": "1234", "user": { "name": "Administrator", "username": "root", "id": 1, "state": "active", "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon", "web_url": "http://gitlab.example.com/root" }, "created_at": "2016-06-15T10:09:34.206Z", "updated_at": "2016-06-15T10:09:34.206Z", "awardable_id": 80, "awardable_type": "Issue" }, { "id": 1, "name": "microphone", "user": { "name": "User 4", "username": "user4", "id": 26, "state": "active", "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon", "web_url": "http://gitlab.example.com/user4" }, "created_at": "2016-06-15T10:09:34.177Z", "updated_at": "2016-06-15T10:09:34.177Z", "awardable_id": 80, "awardable_type": "Issue" } ] ``` ### Get single award emoji[](#get-single-award-emoji "Permalink") 从问题，摘要或合并请求中获取单个奖励表情符号. ``` GET /projects/:id/issues/:issue_iid/award_emoji/:award_id GET /projects/:id/merge_requests/:merge_request_iid/award_emoji/:award_id GET /projects/:id/snippets/:snippet_id/award_emoji/:award_id ``` Parameters: | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 项目的 ID 或[URL 编码路径](README.html#namespaced-path-encoding) . | | `issue_iid`/`merge_request_iid`/`snippet_id` | integer | yes | `iid` ID（合并请求/问题的`id` ，摘要的`id` ）. | | `award_id` | integer | yes | 奖励表情符号的 ID. | 请求示例： ``` curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/1" ``` 响应示例： ``` { "id": 1, "name": "microphone", "user": { "name": "User 4", "username": "user4", "id": 26, "state": "active", "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon", "web_url": "http://gitlab.example.com/user4" }, "created_at": "2016-06-15T10:09:34.177Z", "updated_at": "2016-06-15T10:09:34.177Z", "awardable_id": 80, "awardable_type": "Issue" } ``` ### Award a new emoji[](#award-a-new-emoji "Permalink") 在指定的奖励对象上创建奖励表情符号. ``` POST /projects/:id/issues/:issue_iid/award_emoji POST /projects/:id/merge_requests/:merge_request_iid/award_emoji POST /projects/:id/snippets/:snippet_id/award_emoji ``` Parameters: | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 项目的 ID 或[URL 编码路径](README.html#namespaced-path-encoding) . | | `issue_iid`/`merge_request_iid`/`snippet_id` | integer | yes | `iid` ID（合并请求/问题的`id` ，摘要的`id` ）. | | `name` | string | yes | 不含冒号的表情符号名称. | ``` curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji?name=blowfish" ``` 示例响应： ``` { "id": 344, "name": "blowfish", "user": { "name": "Administrator", "username": "root", "id": 1, "state": "active", "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon", "web_url": "http://gitlab.example.com/root" }, "created_at": "2016-06-17T17:47:29.266Z", "updated_at": "2016-06-17T17:47:29.266Z", "awardable_id": 80, "awardable_type": "Issue" } ``` ### Delete an award emoji[](#delete-an-award-emoji "Permalink") 有时候，这并不是必须的，您必须取消该奖项. **注意：**仅适用于管理员或奖项的作者. ``` DELETE /projects/:id/issues/:issue_iid/award_emoji/:award_id DELETE /projects/:id/merge_requests/:merge_request_iid/award_emoji/:award_id DELETE /projects/:id/snippets/:snippet_id/award_emoji/:award_id ``` Parameters: | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 项目的 ID 或[URL 编码路径](README.html#namespaced-path-encoding) . | | `issue_iid`/`merge_request_iid`/`snippet_id` | integer | yes | `iid` ID（合并请求/问题的`id` ，摘要的`id` ）. | | `award_id` | integer | yes | 奖励表情符号的 ID. | ``` curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/344" ``` ## Award Emoji on Comments[](#award-emoji-on-comments "Permalink") 注释（也称为注释）是问题，合并请求和摘要的子资源. **注意：**以下示例描述了如何使用奖励表情符号处理问题的注释，但可以轻松地将其用于合并请求或摘要中的注释. 因此，您必须用`merge_request_iid`或`snippet_id`替换`issue_iid` . ### List a comment’s award emoji[](#list-a-comments-award-emoji "Permalink") 获取所有奖励表情符号的评论（注释）. ``` GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji ``` Parameters: | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 项目的 ID 或[URL 编码路径](README.html#namespaced-path-encoding) . | | `issue_iid` | integer | yes | 问题的内部 ID. | | `note_id` | integer | yes | 注释（注释）的 ID. | 请求示例： ``` curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/notes/1/award_emoji" ``` 响应示例： ``` [ { "id": 2, "name": "mood_bubble_lightning", "user": { "name": "User 4", "username": "user4", "id": 26, "state": "active", "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon", "web_url": "http://gitlab.example.com/user4" }, "created_at": "2016-06-15T10:09:34.197Z", "updated_at": "2016-06-15T10:09:34.197Z", "awardable_id": 1, "awardable_type": "Note" } ] ``` ### Get an award emoji for a comment[](#get-an-award-emoji-for-a-comment "Permalink") 获得单个奖励表情符号作为注释（注释）. ``` GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id ``` Parameters: | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 项目的 ID 或[URL 编码路径](README.html#namespaced-path-encoding) . | | `issue_iid` | integer | yes | 问题的内部 ID. | | `note_id` | integer | yes | 注释（注释）的 ID. | | `award_id` | integer | yes | 奖励表情符号的 ID. | 请求示例： ``` curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/notes/1/award_emoji/2" ``` 响应示例： ``` { "id": 2, "name": "mood_bubble_lightning", "user": { "name": "User 4", "username": "user4", "id": 26, "state": "active", "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon", "web_url": "http://gitlab.example.com/user4" }, "created_at": "2016-06-15T10:09:34.197Z", "updated_at": "2016-06-15T10:09:34.197Z", "awardable_id": 1, "awardable_type": "Note" } ``` ### Award a new emoji on a comment[](#award-a-new-emoji-on-a-comment "Permalink") 在指定的注释（注释）上创建一个奖励表情符号. ``` POST /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji ``` Parameters: | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 项目的 ID 或[URL 编码路径](README.html#namespaced-path-encoding) . | | `issue_iid` | integer | yes | 问题的内部 ID. | | `note_id` | integer | yes | 注释（注释）的 ID. | | `name` | string | yes | 不含冒号的表情符号名称. | 请求示例： ``` curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/notes/1/award_emoji?name=rocket" ``` 响应示例： ``` { "id": 345, "name": "rocket", "user": { "name": "Administrator", "username": "root", "id": 1, "state": "active", "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon", "web_url": "http://gitlab.example.com/root" }, "created_at": "2016-06-17T19:59:55.888Z", "updated_at": "2016-06-17T19:59:55.888Z", "awardable_id": 1, "awardable_type": "Note" } ``` ### Delete an award emoji from a comment[](#delete-an-award-emoji-from-a-comment "Permalink") 有时候，这并不是必须的，您必须取消该奖项. **注意：**仅适用于管理员或奖项的作者. ``` DELETE /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id ``` Parameters: | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 项目的 ID 或[URL 编码路径](README.html#namespaced-path-encoding) . | | `issue_iid` | integer | yes | 问题的内部 ID. | | `note_id` | integer | yes | 注释（注释）的 ID. | | `award_id` | integer | yes | award_emoji 的 ID. | 请求示例： ``` curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/345" ```