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

プロジェクトイシューボード

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

すべてのAPIコールは、イシューボードで認証される必要があります。

ユーザーが非公開プロジェクトのメンバーでない場合、そのプロジェクトに対するGETリクエストの結果はステータスコード404になります。

プロジェクトのイシューボードをリスト表示する

指定されたプロジェクトのプロジェクトイシューボードを一覧表示します。

GET /projects/:id/boards
属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/boards"

レスポンス例:

[
  {
    "id" : 1,
    "name": "board1",
    "hide_backlog_list": false,
    "hide_closed_list": false,
    "project": {
      "id": 5,
      "name": "Diaspora Project Site",
      "name_with_namespace": "Diaspora / Diaspora Project Site",
      "path": "diaspora-project-site",
      "path_with_namespace": "diaspora/diaspora-project-site",
      "http_url_to_repo": "http://example.com/diaspora/diaspora-project-site.git",
      "web_url": "http://example.com/diaspora/diaspora-project-site"
    },
    "milestone":   {
      "id": 12,
      "title": "10.0"
    },
    "lists" : [
      {
        "id" : 1,
        "label" : {
          "name" : "Testing",
          "color" : "#F0AD4E",
          "description" : null
        },
        "position" : 1,
        "max_issue_count": 0,
        "max_issue_weight": 0,
        "limit_metric": null
      },
      {
        "id" : 2,
        "label" : {
          "name" : "Ready",
          "color" : "#FF0000",
          "description" : null
        },
        "position" : 2,
        "max_issue_count": 0,
        "max_issue_weight": 0,
        "limit_metric":  null
      },
      {
        "id" : 3,
        "label" : {
          "name" : "Production",
          "color" : "#FF5F00",
          "description" : null
        },
        "position" : 3,
        "max_issue_count": 0,
        "max_issue_weight": 0,
        "limit_metric":  null
      }
    ]
  }
]

ボードがアクティブ化されていないか、プロジェクトに存在しない場合の別の応答例:

[]

単一のイシューボードを表示

単一プロジェクトのイシューボードを取得します。

GET /projects/: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/projects/5/boards/1"

レスポンス例:

  {
    "id": 1,
    "name": "project issue board",
    "hide_backlog_list": false,
    "hide_closed_list": false,
    "project": {
      "id": 5,
      "name": "Diaspora Project Site",
      "name_with_namespace": "Diaspora / Diaspora Project Site",
      "path": "diaspora-project-site",
      "path_with_namespace": "diaspora/diaspora-project-site",
      "http_url_to_repo": "http://example.com/diaspora/diaspora-project-site.git",
      "web_url": "http://example.com/diaspora/diaspora-project-site"
    },
    "milestone":   {
      "id": 12,
      "title": "10.0"
    },
    "lists" : [
      {
        "id" : 1,
        "label" : {
          "name" : "Testing",
          "color" : "#F0AD4E",
          "description" : null
        },
        "position" : 1,
        "max_issue_count": 0,
        "max_issue_weight": 0,
        "limit_metric":  null
      },
      {
        "id" : 2,
        "label" : {
          "name" : "Ready",
          "color" : "#FF0000",
          "description" : null
        },
        "position" : 2,
        "max_issue_count": 0,
        "max_issue_weight": 0,
        "limit_metric":  null
      },
      {
        "id" : 3,
        "label" : {
          "name" : "Production",
          "color" : "#FF5F00",
          "description" : null
        },
        "position" : 3,
        "max_issue_count": 0,
        "max_issue_weight": 0,
        "limit_metric":  null
      }
    ]
  }

イシューボードを作成する

プロジェクトイシューボードを作成します。

POST /projects/:id/boards
属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
name文字列はい新しいボードの名前。
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/boards?name=newboard"

レスポンス例:

  {
    "id": 1,
    "name": "newboard",
    "hide_backlog_list": false,
    "hide_closed_list": false,
    "project": {
      "id": 5,
      "name": "Diaspora Project Site",
      "name_with_namespace": "Diaspora / Diaspora Project Site",
      "path": "diaspora-project-site",
      "path_with_namespace": "diaspora/diaspora-project-site",
      "http_url_to_repo": "http://example.com/diaspora/diaspora-project-site.git",
      "web_url": "http://example.com/diaspora/diaspora-project-site"
    },
    "lists" : [],
    "group": null,
    "milestone": null,
    "assignee" : null,
    "labels" : [],
    "weight" : null
  }

イシューボードを更新する

プロジェクトイシューボードを更新します。

PUT /projects/:id/boards/:board_id
属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
board_id整数はいボードのID。
name文字列いいえボードの新しい名前。
hide_backlog_listブール値いいえ[Open]（オープン）リストを非表示にします。
hide_closed_listブール値いいえ[Closed]（クローズ済）リストを非表示にします。
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>" \
  --url "https://gitlab.example.com/api/v4/projects/5/boards/1?name=new_name&milestone_id=43&assignee_id=1&labels=Doing&weight=4"

レスポンス例:

  {
    "id": 1,
    "name": "new_name",
    "hide_backlog_list": false,
    "hide_closed_list": false,
    "project": {
      "id": 5,
      "name": "Diaspora Project Site",
      "name_with_namespace": "Diaspora / Diaspora Project Site",
      "path": "diaspora-project-site",
      "path_with_namespace": "diaspora/diaspora-project-site",
      "created_at": "2018-07-03T05:48:49.982Z",
      "default_branch": null,
      "tag_list": [], //deprecated, use `topics` instead
      "topics": [],
      "ssh_url_to_repo": "ssh://user@example.com/diaspora/diaspora-project-site.git",
      "http_url_to_repo": "http://example.com/diaspora/diaspora-project-site.git",
      "web_url": "http://example.com/diaspora/diaspora-project-site",
      "readme_url": null,
      "avatar_url": null,
      "star_count": 0,
      "forks_count": 0,
      "last_activity_at": "2018-07-03T05:48:49.982Z"
    },
    "lists": [],
    "group": null,
    "milestone": {
      "id": 43,
      "iid": 1,
      "project_id": 15,
      "title": "Milestone 1",
      "description": "Milestone 1 desc",
      "state": "active",
      "created_at": "2018-07-03T06:36:42.618Z",
      "updated_at": "2018-07-03T06:36:42.618Z",
      "due_date": null,
      "start_date": null,
      "web_url": "http://example.com/root/board1/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": 10,
      "name": "Doing",
      "color": "#5CB85C",
      "description": null
    }],
    "weight": 4
  }

イシューボードを削除する

プロジェクトイシューボードを削除します。

DELETE /projects/: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/projects/5/boards/1"

プロジェクトイシューボードのボードリストをリスト表示

ボードのリストのリストを取得します。openおよびclosedリストは含まれません。

GET /projects/: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/projects/5/boards/1/lists"

レスポンス例:

[
  {
    "id" : 1,
    "label" : {
      "name" : "Testing",
      "color" : "#F0AD4E",
      "description" : null
    },
    "position" : 1,
    "max_issue_count": 0,
    "max_issue_weight": 0,
    "limit_metric":  null
  },
  {
    "id" : 2,
    "label" : {
      "name" : "Ready",
      "color" : "#FF0000",
      "description" : null
    },
    "position" : 2,
    "max_issue_count": 0,
    "max_issue_weight": 0,
    "limit_metric":  null
  },
  {
    "id" : 3,
    "label" : {
      "name" : "Production",
      "color" : "#FF5F00",
      "description" : null
    },
    "position" : 3,
    "max_issue_count": 0,
    "max_issue_weight": 0,
    "limit_metric":  null
  }
]

単一のボードリストを表示

単一のボードリストを取得します。

GET /projects/: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/projects/5/boards/1/lists/1"

レスポンス例:

{
  "id" : 1,
  "label" : {
    "name" : "Testing",
    "color" : "#F0AD4E",
    "description" : null
  },
  "position" : 1,
  "max_issue_count": 0,
  "max_issue_weight": 0,
  "limit_metric":  null
}

ボードリストを作成

新しいイシューボードイシューボードリストを作成します。

POST /projects/: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のみです。

ラベル、担当者、およびマイルストーンの引数は相互に排他的です。つまり、リクエストで許可されるのはいずれか1つのみです。各リストタイプに必要なライセンスに関する詳細は、イシューボードドキュメントを確認してください。

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/boards/1/lists?label_id=5"

レスポンス例:

{
  "id" : 1,
  "label" : {
    "name" : "Testing",
    "color" : "#F0AD4E",
    "description" : null
  },
  "position" : 1,
  "max_issue_count": 0,
  "max_issue_weight": 0,
  "limit_metric":  null
}

ボード内のリストを並べ替え

既存のイシューボードイシューボードリストを更新します。このAPIコールは、リストの位置を変更するために使用されます。

PUT /projects/: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/projects/5/boards/1/lists/1?position=2"

レスポンス例:

{
  "id" : 1,
  "label" : {
    "name" : "Testing",
    "color" : "#F0AD4E",
    "description" : null
  },
  "position" : 1,
  "max_issue_count": 0,
  "max_issue_weight": 0,
  "limit_metric":  null
}

ボードからボードリストを削除

管理者とプロジェクトオーナーのみを対象としています。ボードリストを削除します。

DELETE /projects/: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/projects/5/boards/1/lists/1"