- グループ内のすべてのグループ・イシュー・ボード一覧
- 単一グループのイシューボード
- グループ・イシュー・ボードの作成
- グループ・イシュー・ボードの更新
- グループissueボードの削除
- リストグループのイシューボードリスト
- 単一グループのイシューボードリスト
- 新しいグループのイシューボードリスト
- グループ・イシュー・ボード・リストの編集
- グループ・イシュー・ボード・リストの削除
グループイシューボードAPI
グループボードへのAPIコールはすべて認証が必要です。
ユーザーがグループのメンバーではなく、グループが非公開である場合、GET
リクエストは404
ステータスコードになります。
グループ内のすべてのグループ・イシュー・ボード一覧
指定されたグループのイシュー・ボードを一覧表示します。
GET /groups/:id/boards
属性 | タイプ | 必須 | 説明 |
---|---|---|---|
id
| 整数/文字列 | はい | 認証されたユーザーが所有するグループのIDまたはURLエンコードされたパス。 |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards"
回答例
[
{
"id": 1,
"name:": "group issue board",
"group": {
"id": 5,
"name": "Documentcloud",
"web_url": "http://example.com/groups/documentcloud"
},
"milestone": {
"id": 12
"title": "10.0"
},
"lists" : [
{
"id" : 1,
"label" : {
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
"position" : 1
},
{
"id" : 2,
"label" : {
"name" : "Ready",
"color" : "#FF0000",
"description" : null
},
"position" : 2
},
{
"id" : 3,
"label" : {
"name" : "Production",
"color" : "#FF5F00",
"description" : null
},
"position" : 3
}
]
}
]
GitLabPremium、Silver以上のユーザーは、複数のグループボードを持つことができるため、異なるパラメータが表示されます。
回答例
[
{
"id": 1,
"name:": "group issue board",
"group": {
"id": 5,
"name": "Documentcloud",
"web_url": "http://example.com/groups/documentcloud"
},
"milestone": {
"id": 12
"title": "10.0"
},
"lists" : [
{
"id" : 1,
"label" : {
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
"position" : 1
},
{
"id" : 2,
"label" : {
"name" : "Ready",
"color" : "#FF0000",
"description" : null
},
"position" : 2
},
{
"id" : 3,
"label" : {
"name" : "Production",
"color" : "#FF5F00",
"description" : null
},
"position" : 3
}
]
}
]
単一グループのイシューボード
単一のグループ・イシュー・ボードを取得します。
GET /groups/:id/boards/:board_id
属性 | タイプ | 必須 | 説明 |
---|---|---|---|
id
| 整数/文字列 | はい | 認証されたユーザーが所有するグループのIDまたはURLエンコードされたパス。 |
board_id
| 整数 | はい | ボードのID |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards/1"
回答例
{
"id": 1,
"name:": "group issue board",
"group": {
"id": 5,
"name": "Documentcloud",
"web_url": "http://example.com/groups/documentcloud"
},
"milestone": {
"id": 12
"title": "10.0"
},
"lists" : [
{
"id" : 1,
"label" : {
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
"position" : 1
},
{
"id" : 2,
"label" : {
"name" : "Ready",
"color" : "#FF0000",
"description" : null
},
"position" : 2
},
{
"id" : 3,
"label" : {
"name" : "Production",
"color" : "#FF5F00",
"description" : null
},
"position" : 3
}
]
}
GitLabPremium、Silver以上のユーザーは、複数のグループイシューボードを持つことができるため、異なるパラメータが表示されます。
回答例
{
"id": 1,
"name:": "group issue board",
"group": {
"id": 5,
"name": "Documentcloud",
"web_url": "http://example.com/groups/documentcloud"
},
"milestone": {
"id": 12
"title": "10.0"
},
"lists" : [
{
"id" : 1,
"label" : {
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
"position" : 1
},
{
"id" : 2,
"label" : {
"name" : "Ready",
"color" : "#FF0000",
"description" : null
},
"position" : 2
},
{
"id" : 3,
"label" : {
"name" : "Production",
"color" : "#FF5F00",
"description" : null
},
"position" : 3
}
]
}
グループ・イシュー・ボードの作成
グループ・イシュー・ボードを作成します。
POST /groups/:id/boards
属性 | タイプ | 必須 | 説明 |
---|---|---|---|
id
| 整数/文字列 | はい | 認証されたユーザーが所有するグループのIDまたはURLエンコードされたパス。 |
name
| 列 | はい | 新理事会の名称 |
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards?name=newboard"
回答例
{
"id": 1,
"name": "newboard",
"group": {
"id": 5,
"name": "Documentcloud",
"web_url": "http://example.com/groups/documentcloud"
},
"milestone": {
"id": 12
"title": "10.0"
},
"lists" : [
{
"id" : 1,
"label" : {
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
"position" : 1
},
{
"id" : 2,
"label" : {
"name" : "Ready",
"color" : "#FF0000",
"description" : null
},
"position" : 2
},
{
"id" : 3,
"label" : {
"name" : "Production",
"color" : "#FF5F00",
"description" : null
},
"position" : 3
}
]
}
グループ・イシュー・ボードの更新
GitLab 11.1で導入されました。
グループイシューボードを更新します。
PUT /groups/:id/boards/:board_id
属性 | タイプ | 必須 | 説明 |
---|---|---|---|
id
| 整数/文字列 | はい | 認証されたユーザーが所有するグループのIDまたはURLエンコードされたパス。 |
board_id
| 整数 | はい | ボードのID |
name
| 列 | いいえ | 取締役会の新しい名称 |
assignee_id
| 整数 | いいえ | 理事会が対象とすべき担当者 |
milestone_id
| 整数 | いいえ | 取締役会のスコープとすべきマイルストーン |
labels
| 列 | いいえ | ボードがスコープされるべきラベル名のカンマ区切りリスト |
weight
| 整数 | いいえ | 重さの範囲は0から9までで、どのボードにスコープを当てるべきかは |
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards/1?name=new_name&milestone_id=44&assignee_id=1&labels=GroupLabel&weight=4"
回答例
{
"id": 1,
"project": null,
"lists": [],
"name": "new_name",
"group": {
"id": 5,
"name": "Documentcloud",
"web_url": "http://example.com/groups/documentcloud"
},
"milestone": {
"id": 44,
"iid": 1,
"group_id": 5,
"title": "Group Milestone",
"description": "Group Milestone Desc",
"state": "active",
"created_at": "2018-07-03T07:15:19.271Z",
"updated_at": "2018-07-03T07:15:19.271Z",
"due_date": null,
"start_date": null,
"web_url": "http://example.com/groups/documentcloud/-/milestones/1"
},
"assignee": {
"id": 1,
"name": "Administrator",
"username": "root",
"state": "active",
"avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
"web_url": "http://example.com/root"
},
"labels": [{
"id": 11,
"name": "GroupLabel",
"color": "#428BCA",
"description": ""
}],
"weight": 4
}
グループissueボードの削除
グループ・イシュー・ボードを削除します。
DELETE /groups/:id/boards/:board_id
属性 | タイプ | 必須 | 説明 |
---|---|---|---|
id
| 整数/文字列 | はい | 認証されたユーザーが所有するグループのIDまたはURLエンコードされたパス。 |
board_id
| 整数 | はい | ボードのID |
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards/1"
リストグループのイシューボードリスト
理事会のリスト取得open
とclosed
のリストは含まれません。
GET /groups/:id/boards/:board_id/lists
属性 | タイプ | 必須 | 説明 |
---|---|---|---|
id
| 整数/文字列 | はい | 認証されたユーザーが所有するグループのIDまたはURLエンコードされたパス。 |
board_id
| 整数 | はい | ボードのID |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards/1/lists"
回答例
[
{
"id" : 1,
"label" : {
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
"position" : 1
},
{
"id" : 2,
"label" : {
"name" : "Ready",
"color" : "#FF0000",
"description" : null
},
"position" : 2
},
{
"id" : 3,
"label" : {
"name" : "Production",
"color" : "#FF5F00",
"description" : null
},
"position" : 3
}
]
単一グループのイシューボードリスト
シングルボードリストを取得します。
GET /groups/:id/boards/:board_id/lists/:list_id
属性 | タイプ | 必須 | 説明 |
---|---|---|---|
id
| 整数/文字列 | はい | 認証されたユーザーが所有するグループのIDまたはURLエンコードされたパス。 |
board_id
| 整数 | はい | ボードのID |
list_id
| 整数 | はい | ボードのリストのID |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards/1/lists/1"
回答例
{
"id" : 1,
"label" : {
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
"position" : 1
}
新しいグループのイシューボードリスト
新しいイシューボードリストを作成します。
POST /groups/:id/boards/:board_id/lists
属性 | タイプ | 必須 | 説明 |
---|---|---|---|
id
| 整数/文字列 | はい | 認証されたユーザーが所有するグループのIDまたはURLエンコードされたパス。 |
board_id
| 整数 | はい | ボードのID |
label_id
| 整数 | はい | ラベルのID |
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/4/boards/12/lists?milestone_id=7"
回答例
{
"id": 9,
"label": null,
"position": 0,
"milestone": {
"id": 7,
"iid": 3,
"group_id": 12,
"title": "Milestone with due date",
"description": "",
"state": "active",
"created_at": "2017-09-03T07:16:28.596Z",
"updated_at": "2017-09-03T07:16:49.521Z",
"due_date": null,
"start_date": null,
"web_url": "https://gitlab.example.com/groups/issue-reproduce/-/milestones/3"
}
}
グループ・イシュー・ボード・リストの編集
既存のイシュー・ボード・リストを更新します。 この呼び出しは、リストの位置を変更するために使用されます。
PUT /groups/:id/boards/:board_id/lists/:list_id
属性 | タイプ | 必須 | 説明 |
---|---|---|---|
id
| 整数/文字列 | はい | 認証されたユーザーが所有するグループのIDまたはURLエンコードされたパス。 |
board_id
| 整数 | はい | ボードのID |
list_id
| 整数 | はい | ボードのリストのID |
position
| 整数 | はい | リストの位置 |
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/group/5/boards/1/lists/1?position=2"
回答例
{
"id" : 1,
"label" : {
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
"position" : 1
}
グループ・イシュー・ボード・リストの削除
管理者とグループオーナーのみ。 問題のボードリストを削除します。
DELETE /groups/:id/boards/:board_id/lists/:list_id
属性 | タイプ | 必須 | 説明 |
---|---|---|---|
id
| 整数/文字列 | はい | 認証されたユーザーが所有するグループのIDまたはURLエンコードされたパス。 |
board_id
| 整数 | はい | ボードのID |
list_id
| 整数 | はい | ボードのリストのID |
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards/1/lists/1"