絵文字リアクションAPI

GitLab 16.0で “award emoji “から “emoji reactions “に改名されました。

絵文字リアクションは千の言葉を伝えます。

絵文字で反応できるGitLabオブジェクトを “awardables “と呼んでいます。絵文字でリアクションできるものは以下の通りです：

イシュー、マージリクエスト、スニペット

これらのエンドポイントをコメントで使う方法については、コメントにリアクションを追加するをご覧ください。

受賞者の絵文字リアクションをリストアップ

GitLab 15.1で公開awardableに認証なしでアクセスできるように変更されました。

指定したawardableのすべての絵文字リアクションのリストを取得します。このエンドポイントは、awordableが公開されていれば認証なしでアクセスできます。

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整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
issue_iid/merge_request_iid/snippet_id 整数。yes受賞対象の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"
  }
]

単一の絵文字の反応を取得

GitLab 15.1で公開awardableに認証なしでアクセスできるように変更されました。

イシュー、スニペット、マージリクエストから単一の絵文字リアクションを取得します。awardableが公開されている場合、このエンドポイントは認証なしでアクセスできます。

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整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
issue_iid/merge_request_iid/snippet_id 整数。yes受賞対象のID ( マージリクエスト/イシューの場合はiid, スニペットの場合はid ) 。
award_id整数。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"
}

新しい絵文字リアクションの追加

指定したアワードの絵文字リアクションを追加します。

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整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
issue_iid/merge_request_iid/snippet_id 整数。yes受賞対象のID ( マージリクエスト/イシューの場合はiid, スニペットの場合はid ) 。
name文字列です。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 /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整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
issue_iid/merge_request_iid/snippet_id 整数。yes受賞対象のID ( マージリクエスト/イシューの場合はiid, スニペットの場合はid ) 。
award_id整数。yes絵文字リアクションのID。
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/344"

コメントにリアクションを追加

コメント（ノートとも呼ばれます）は、イシュー、マージリクエスト、スニペットのサブリソースです。

note
以下の例では、イシューのコメントで絵文字のリアクションを使用する方法を説明しますが、マージリクエストやスニペットのコメントにも適用できます。そのため、issue_iid をmerge_request_iid に置き換えるか、snippet_idに置き換える必要があります。

コメントの絵文字リアクションの一覧

GitLab 15.1で公開コメントへの認証なしアクセスを許可するように変更されました。

コメント(note)のすべての絵文字リアクションを取得します。コメントが公開されている場合、このエンドポイントは認証なしでアクセスできます。

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

パラメータを指定します：

属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
issue_iid整数。yesイシューの内部ID。
note_id整数。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"
  }
]

コメントに対する絵文字のリアクション

GitLab 15.1で公開コメントへの認証なしアクセスを許可するように変更されました。

コメント(note)に対する単一の絵文字リアクションを取得します。コメントが公開されている場合、このエンドポイントは認証なしでアクセスできます。

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

パラメータを指定します：

属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
issue_iid整数。yesイシューの内部ID。
note_id整数。yesコメント（ノート）のID。
award_id整数。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"
}

コメントに新しい絵文字を付与

指定したコメント（ノート）に絵文字のリアクションを作成します。

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

パラメータを指定します：

属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
issue_iid整数。yesイシューの内部ID。
note_id整数。yesコメント（ノート）のID。
name文字列です。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 /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id

パラメータを指定します：

属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
issue_iid整数。yesイシューの内部ID。
note_id整数。yesコメント（ノート）のID。
award_id整数。yes絵文字リアクションのID。

リクエストの例

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