アワード絵文字API
GitLab 8.9で導入され、8.12でスニペットサポートが追加されました。
受賞した絵文字は千の言葉を伝えます。
絵文字は次のような場合に獲得できます(「アワード対象」と呼ばれます):
絵文字はコメント(ノートとも呼ばれます)にも付与できます。Notes APIも参照してください。
イシュー、マージリクエスト、スニペット
コメントでこれらのエンドポイントを使用する方法については、「コメントで絵文字を受賞」を参照してください。
表彰対象者の表彰絵文字をリストアップ
指定したアワードの絵文字のリストを取得します。
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
| 整数/文字列 | はい | プロジェクトのIDまたはURLエンコードされたパス。 |
issue_iid /merge_request_iid /snippet_id
| 整数 | はい | 受賞対象の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"
}
]
シングル賞の絵文字をゲット
イシュー、スニペット、マージリクエストからアワード絵文字を1つ取得します。
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
| 整数/文字列 | はい | プロジェクトのIDまたはURLエンコードされたパス。 |
issue_iid /merge_request_iid /snippet_id
| 整数 | はい | 受賞対象のID ( マージリクエスト/イシューの場合はiid , スニペットの場合はid ) 。
|
award_id
| 整数 | はい | 賞の絵文字の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
| 整数/文字列 | はい | プロジェクトのIDまたはURLエンコードされたパス。 |
issue_iid /merge_request_iid /snippet_id
| 整数 | はい | 受賞対象のID ( マージリクエスト/イシューの場合はiid , スニペットの場合はid ) 。
|
name
| 列 | はい | コロンを除いた絵文字の名前。 |
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
| 整数/文字列 | はい | プロジェクトのIDまたはURLエンコードされたパス。 |
issue_iid /merge_request_iid /snippet_id
| 整数 | はい | 受賞対象のID ( マージリクエスト/イシューの場合はiid , スニペットの場合はid ) 。
|
award_id
| 整数 | はい | 賞の絵文字のID。 |
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/344"
コメントに絵文字を授与
コメント(ノートとも呼ばれます)は、イシュー、マージリクエスト、スニペットのサブリソースです。
issue_iid
をmerge_request_iid
に置き換えるか、snippet_id
。コメントの受賞絵文字をリストアップ
コメント(メモ)にすべての賞の絵文字を取得します。
GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji
パラメーター
属性 | タイプ | 必須 | 説明 |
---|---|---|---|
id
| 整数/文字列 | はい | プロジェクトのIDまたはURLエンコードされたパス。 |
issue_iid
| 整数 | はい | イシューの内部ID。 |
note_id
| 整数 | はい | コメント(ノート)の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"
}
]
コメントで賞の絵文字をゲット
コメント(メモ)に対して1つの賞の絵文字を取得します。
GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id
パラメーター
属性 | タイプ | 必須 | 説明 |
---|---|---|---|
id
| 整数/文字列 | はい | プロジェクトのIDまたはURLエンコードされたパス。 |
issue_iid
| 整数 | はい | イシューの内部ID。 |
note_id
| 整数 | はい | コメント(ノート)のID。 |
award_id
| 整数 | はい | 賞の絵文字の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
| 整数/文字列 | はい | プロジェクトのIDまたはURLエンコードされたパス。 |
issue_iid
| 整数 | はい | イシューの内部ID。 |
note_id
| 整数 | はい | コメント(ノート)のID。 |
name
| 列 | はい | コロンを除いた絵文字の名前。 |
リクエスト例
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
| 整数/文字列 | はい | プロジェクトのIDまたはURLエンコードされたパス。 |
issue_iid
| 整数 | はい | イシューの内部ID。 |
note_id
| 整数 | はい | コメント(ノート)のID。 |
award_id
| 整数 | はい | emojiのID。 |
リクエスト例
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/345"