状態の追加機能リリースに伴うAPIの仕様変更について

いつもBacklogをご利用いただき、ありがとうございます。この記事はBacklogのAPIを利用している開発者向けの解説記事です。先日告知した「状態の追加機能」リリースに伴うAPIの変更点などをご紹介します。

なお今回紹介するAPIの変更点は「状態の追加機能」のご提供に先立ち、既にリリースされています。そのため、状態の追加機能のリリースを待たずに、APIを利用したシステムを先んじて改修できます。

APIの変更点

  • 課題関連の各APIに含まれる状態のレスポンスに、ProjectId、Color、Display Orderなどの情報を追加しました
  • プロジェクトの状態一覧の取得APIを追加しました

既存の状態のidは変わりません

すべての状態はidを持っており、APIを利用することで状態のidを取得できますが、「状態の追加機能」リリース後も、既存の状態(未対応、処理中、処理済み、完了)のidは変わりません。

したがって、状態を追加せず、既存の状態のみを利用する場合、機能リリース後も同じようにAPIを利用できます。

追加された状態の情報について

既存の状態は、状態のidとして1,2,3,4を持っていましたが、追加された状態は、1,2,3,4以外のintの値を持ちます

また、状態の追加機能提供にあたり、課題情報を扱うAPIの各statusにprojectId、color、displayOrderの情報が追加されています。

参照: 課題一覧の取得API

プロジェクトが使える状態一覧の取得について

追加した状態はプロジェクトに紐付きます。特定のプロジェクトで使用できる状態の一覧は、新たに追加されたプロジェクトの状態一覧の取得APIで取得できます。

形式は課題を扱うAPIで取得できる形式とほぼ同じです。

また既にあった状態一覧の取得APIのレスポンスは変わらず、これまでの状態のみを返します。状態一覧の取得APIは近くDeprecatedとなる予定ですので、利用できる状態の一覧を取得したい場合、今後はプロジェクトの状態一覧の取得APIを利用することを推奨します。

Backlog4Jの対応

弊社が公開しているJava言語向けライブラリ、Backlog4Jも既に先述の仕様変更に対応済みです。追加した状態を利用するときは、最新のバージョンをご利用ください。

APIによる状態の追加・編集・削除について

状態の追加・編集・削除をするAPIについては、状態の追加機能リリース時点では提供いたしませんが、実装を予定しています。続報をもうしばらくお待ちください。

タスク管理、ファイル共有もできるプロジェクト管理ツールBacklog

30日間無料でお使いいただけます。

100万人以上に愛用されているBacklogを今すぐ試してみませんか?クレジットカードは不要です。

無料トライアル