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

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

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

このAPIを使用して、グループイシューボードを管理します。このAPIへのすべての呼び出しには認証が必要です。

ユーザーがグループのメンバーではなく、そのグループがプライベートである場合、GETリクエストは404ステータスコードになります。

グループ内のすべてのグループイシューボードをリストします

指定されたグループのすべてのグループイシューボードをリストします。

GET /groups/:id/boards
属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス。
curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "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 --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "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>" \
  --url "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ブール値いいえOpenリストを非表示にします。
hide_closed_listブール値いいえClosedリストを非表示にします。
assignee_id整数いいえボードのスコープとするassignee。PremiumおよびUltimateのみです。
milestone_id整数いいえボードのスコープとするマイルストーン。PremiumおよびUltimateのみです。
labels文字列いいえボードのスコープとするラベル名のカンマ区切りリスト。PremiumおよびUltimateのみです。
weight整数いいえボードのスコープとする0から9までのウェイト範囲。PremiumおよびUltimateのみです。
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "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>" \
  --url "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 --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "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 --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "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整数いいえユーザーのID。PremiumおよびUltimateのみです。
milestone_id整数いいえマイルストーンのID。PremiumおよびUltimateのみです。
iteration_id整数いいえイテレーションのID。PremiumおよびUltimateのみです。
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "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>" \
  --url "https://gitlab.example.com/api/v4/groups/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>" \
  --url "https://gitlab.example.com/api/v4/groups/5/boards/1/lists/1"