正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

グループイシューボードAPI

  • プラン: Free、Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

グループイシューボードへのすべての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",
    "hide_backlog_list": false,
    "hide_closed_list": false,
    "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 PremiumまたはUltimateのユーザーには、複数のグループボードを持つ機能があるため、異なるパラメータが表示されます。

レスポンス例:

[
  {
    "id": 1,
    "name": "group issue board",
    "hide_backlog_list": false,
    "hide_closed_list": false,
    "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",
    "hide_backlog_list": false,
    "hide_closed_list": false,
    "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 PremiumまたはUltimateのユーザーには、複数のグループイシューボードを持つ機能があるため、異なるパラメータが表示されます。

レスポンス例:

  {
    "id": 1,
    "name": "group issue board",
    "hide_backlog_list": false,
    "hide_closed_list": false,
    "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
      }
    ]
  }

グループイシューボードの作成

  • プラン: Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

グループイシューボードを作成します。

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",
    "hide_backlog_list": false,
    "hide_closed_list": false,
    "project": null,
    "lists" : [],
    "group": {
      "id": 5,
      "name": "Documentcloud",
      "web_url": "http://example.com/groups/documentcloud"
    },
    "milestone": null,
    "assignee" : null,
    "labels" : [],
    "weight" : null
  }

グループイシューボードの更新

グループイシューボードを更新します。

PUT /groups/:id/boards/:board_id
属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス。
board_id整数はいボードのID。
name文字列いいえボードの新しい名前。
hide_backlog_listブール値いいえ[開く]リストを非表示にします。
hide_closed_listブール値いいえ[閉じる]リストを非表示にします。
assignee_id整数いいえボードのスコープを設定する担当者。PremiumおよびUltimateのみです。
milestone_id整数いいえボードのスコープを設定するマイルストーン。PremiumおよびUltimateのみです。
labels文字列いいえボードのスコープを設定するラベル名のカンマ区切りリスト。PremiumおよびUltimateのみです。
weight整数いいえボードのスコープを設定する0〜9のウェイト範囲。PremiumおよびUltimateのみです。
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,
    "name": "new_name",
    "hide_backlog_list": false,
    "hide_closed_list": false,
    "project": null,
    "lists": [],
    "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
  }

グループイシューボードの削除

  • プラン: Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

グループイシューボードを削除します。

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。
assignee_id整数いいえユーザーのIDPremiumおよびUltimateのみです。
milestone_id整数いいえマイルストーンのID。PremiumおよびUltimateのみです。
iteration_id整数いいえイテレーションのID。PremiumおよびUltimateのみです。
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/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"