{{< details >}}

  • Tier: 基础版，专业版，旗舰版
  • Offering: JihuLab.com，私有化部署

{{< /details >}}

{{< history >}}

  • 在极狐GitLab 16.0 中，从 “award emoji” 重命名为 “emoji reactions”。

{{< /history >}}

一个表情符号反应能表达千言万语。

我们称接受表情符号反应的极狐GitLab对象为可授予对象。您可以对以下内容进行表情符号反应：

议题、合并请求和代码片段

有关使用这些端点和评论的信息，请参阅添加反应到评论。

列出可授予对象的表情符号反应

{{< history >}}

  • 在极狐GitLab 15.1 中，变更为允许对公开可授予项进行未认证访问。

{{< /history >}}

获取指定可授予对象的所有表情符号反应列表。如果可授予对象是公开访问的，可以无需身份验证访问此端点。

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

参数：

属性 类型 必需 描述
id integer/string 是 项目的 ID 或URL 编码路径。
issue_iid/merge_request_iid/snippet_id integer 是 可授予对象的 ID（合并请求/议题的 iid，代码片段的 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"
  }
]

获取单个表情符号反应

{{< history >}}

  • 在极狐GitLab 15.1 中，变更为允许对公开可授予项进行未认证访问。

{{< /history >}}

从议题、代码片段或合并请求中获取单个表情符号反应。如果可授予对象是公开访问的，可以无需身份验证访问此端点。

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

参数：

属性 类型 必需 描述
id integer/string 是 项目的 ID 或URL 编码路径。
issue_iid/merge_request_iid/snippet_id integer 是 可授予对象的 ID（合并请求/议题的 iid，代码片段的 id）。
award_id integer 是 表情符号反应的 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"
}

添加新的表情符号反应

在指定的可授予对象上添加表情符号反应。

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

参数：

属性 类型 必需 描述
id integer/string 是 项目的 ID 或URL 编码路径。
issue_iid/merge_request_iid/snippet_id integer 是 可授予对象的 ID（合并请求/议题的 iid，代码片段的 id）。
name string 是 表情符号名称，不含冒号。 
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 /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

参数：

属性 类型 必需 描述
id integer/string 是 项目的 ID 或URL 编码路径。
issue_iid/merge_request_iid/snippet_id integer 是 可授予对象的 ID（合并请求/议题的 iid，代码片段的 id）。
award_id integer 是 表情符号反应的 ID。 
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/344"

添加反应到评论

评论（也称为注释）是议题、合并请求和代码片段的子资源。

{{< alert type=”note” >}}

下面的示例描述了如何处理议题评论上的表情符号反应，但可以适用于合并请求和代码片段的评论。因此，您需要将 issue_iid 替换为 merge_request_iid 或 snippet_id。

{{< /alert >}}

列出评论的表情符号反应

{{< history >}}

  • 在极狐GitLab 15.1 中，变更为允许对公开可授予项进行未认证访问。

{{< /history >}}

获取评论（注释）的所有表情符号反应。如果评论是公开访问的，可以无需身份验证访问此端点。

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

参数：

属性 类型 必需 描述
id integer/string 是 项目的 ID 或URL 编码路径。
issue_iid integer 是 议题的内部 ID。
note_id integer 是 评论（注释）的 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"
  }
]

获取评论的表情符号反应

{{< history >}}

  • 在极狐GitLab 15.1 中，变更为允许对公开评论进行未认证访问。

{{< /history >}}

获取评论（注释）的单个表情符号反应。如果评论是公开访问的，可以无需身份验证访问此端点。

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

参数：

属性 类型 必需 描述
id integer/string 是 项目的 ID 或URL 编码路径。
issue_iid integer 是 议题的内部 ID。
note_id integer 是 评论（注释）的 ID。
award_id integer 是 表情符号反应的 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"
}

向评论添加新的表情符号反应

在指定的评论（注释）上创建表情符号反应。

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

参数：

属性 类型 必需 描述
id integer/string 是 项目的 ID 或URL 编码路径。
issue_iid integer 是 议题的内部 ID。
note_id integer 是 评论（注释）的 ID。
name string 是 表情符号名称，不含冒号。

示例请求：

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 /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id

参数：

属性 类型 必需 描述
id integer/string 是 项目的 ID 或URL 编码路径。
issue_iid integer 是 议题的内部 ID。
note_id integer 是 评论（注释）的 ID。
award_id integer 是 表情符号反应的 ID。

示例请求：

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