Award Emoji API

原文：https://docs.gitlab.com/ee/api/award_emoji.html

Award Emoji API

在 GitLab 8.9 中引入 . 在 8.12 中添加了代码段支持.

获奖的表情符号讲出一千个单词.

可以通过以下方式授予表情符号（称为”奖项”）：

Emoji can also be awarded on comments (also known as notes). See also Notes API.

Issues, merge requests, and snippets

有关将这些端点与注释一起使用的信息，请参见在注释上授予 Emoji 表情 .

List an awardable’s award emoji

获取指定奖励的所有奖励表情符号的列表.

  1. GET /projects/:id/issues/:issue_iid/award_emoji
  2. GET /projects/:id/merge_requests/:merge_request_iid/award_emoji
  3. GET /projects/:id/snippets/:snippet_id/award_emoji

Parameters:

Attribute Type Required Description
id integer/string yes 项目的 ID 或URL 编码路径 .
issue_iid/merge_request_iid/snippet_id integer yes iid ID（合并请求/问题的id ，摘要的id ）.

请求示例：

  1. curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji"

响应示例：

  1. [  {  "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

从问题，摘要或合并请求中获取单个奖励表情符号.

  1. GET /projects/:id/issues/:issue_iid/award_emoji/:award_id
  2. GET /projects/:id/merge_requests/:merge_request_iid/award_emoji/:award_id
  3. GET /projects/:id/snippets/:snippet_id/award_emoji/:award_id

Parameters:

Attribute Type Required Description
id integer/string yes 项目的 ID 或URL 编码路径 .
issue_iid/merge_request_iid/snippet_id integer yes iid ID（合并请求/问题的id ，摘要的id ）.
award_id integer yes 奖励表情符号的 ID.

请求示例：

  1. curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/1"

响应示例：

  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

在指定的奖励对象上创建奖励表情符号.

  1. POST /projects/:id/issues/:issue_iid/award_emoji
  2. POST /projects/:id/merge_requests/:merge_request_iid/award_emoji
  3. POST /projects/:id/snippets/:snippet_id/award_emoji

Parameters:

Attribute Type Required Description
id integer/string yes 项目的 ID 或URL 编码路径 .
issue_iid/merge_request_iid/snippet_id integer yes iid ID（合并请求/问题的id ，摘要的id ）.
name string yes 不含冒号的表情符号名称. 
  1. curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji?name=blowfish"

示例响应：

  1. {  "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

有时候，这并不是必须的，您必须取消该奖项.

注意：仅适用于管理员或奖项的作者.

  1. DELETE /projects/:id/issues/:issue_iid/award_emoji/:award_id
  2. DELETE /projects/:id/merge_requests/:merge_request_iid/award_emoji/:award_id
  3. DELETE /projects/:id/snippets/:snippet_id/award_emoji/:award_id

Parameters:

Attribute Type Required Description
id integer/string yes 项目的 ID 或URL 编码路径 .
issue_iid/merge_request_iid/snippet_id integer yes iid ID（合并请求/问题的id ，摘要的id ）.
award_id integer yes 奖励表情符号的 ID. 
  1. 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

注释（也称为注释）是问题，合并请求和摘要的子资源.

注意：以下示例描述了如何使用奖励表情符号处理问题的注释，但可以轻松地将其用于合并请求或摘要中的注释. 因此，您必须用merge_request_iid或snippet_id替换issue_iid .

List a comment’s award emoji

获取所有奖励表情符号的评论（注释）.

  1. GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji

Parameters:

Attribute Type Required Description
id integer/string yes 项目的 ID 或URL 编码路径 .
issue_iid integer yes 问题的内部 ID.
note_id integer yes 注释（注释）的 ID.

请求示例：

  1. curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/notes/1/award_emoji"

响应示例：

  1. [  {  "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

获得单个奖励表情符号作为注释（注释）.

  1. GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id

Parameters:

Attribute Type Required Description
id integer/string yes 项目的 ID 或URL 编码路径 .
issue_iid integer yes 问题的内部 ID.
note_id integer yes 注释（注释）的 ID.
award_id integer yes 奖励表情符号的 ID.

请求示例：

  1. curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/notes/1/award_emoji/2"

响应示例：

  1. {  "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

在指定的注释（注释）上创建一个奖励表情符号.

  1. POST /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji

Parameters:

Attribute Type Required Description
id integer/string yes 项目的 ID 或URL 编码路径 .
issue_iid integer yes 问题的内部 ID.
note_id integer yes 注释（注释）的 ID.
name string yes 不含冒号的表情符号名称.

请求示例：

  1. 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"

响应示例：

  1. {  "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

有时候，这并不是必须的，您必须取消该奖项.

注意：仅适用于管理员或奖项的作者.

  1. DELETE /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id

Parameters:

Attribute Type Required Description
id integer/string yes 项目的 ID 或URL 编码路径 .
issue_iid integer yes 问题的内部 ID.
note_id integer yes 注释（注释）的 ID.
award_id integer yes award_emoji 的 ID.

请求示例：

  1. curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/345"