[STG] APIのアップデート版がリリースされました。

本日午後開発環境(az-api.hexabase.com)に対して、API関連の更新版が無停止リリースにより適用されました。

主なアップデート

  1. 検索条件指定の充実
  2. アイテム履歴APIの追加
  3. 未読履歴をもつアイテムの絞り込み
  4. DataReportの結果のうち、フィールド一覧の返却を省略可能に

1.検索条件指定の充実

  • NOT検索、OR検索の対応
  • 複合検索条件の指定が可能に [ 例えば、 ( X and Y ) or Z のような検索] →こちら

(対象API)

2.アイテム履歴APIの追加(検索条件の充実、変更、削除)

  • アイテムに紐づくコメントや更新履歴について、登録・コメントの修正・削除(アーカイブ)できるAPIが追加されました。
  • 履歴検索APIでは、登録日付による絞り込み、コメントの種類(アクション、コメント)による絞り込みが利用可能となりました。
  • (旧APIからの変更)GetItemHistoriesについては、旧APIから結果JSONフォーマットに変更されています。(旧:GetItemHistoriesは、URLに/application/が含まれない形で利用可能ですが、旧APIについては今後Deprecateされる予定です)

(対象API)

3.未読アイテムの絞り込み

  • Item一覧APIにて、未読コメントを含むItemを絞り込むことが可能となりました。
  • unread_only : true を指定すると「未読履歴をもつItem」のみの絞込条件がconditionsへ含まれて実行されます。

(対象API)

4. DataReportの結果取得時、フィールド一覧の返却を省略

  • 現状、データレポートの取得結果にreport_fields というフィールド一覧が含まれますが、状況によっては冗長なデータとなるケースがありました。
  • omit_fields_data: trueとすることでフィールド一覧を含まないデータ取得が可能です。

(対象API)