2021/11/14 の定期メンテナンスにおける API 更新情報 (2021/10/15)

2021年11月14日の定期メンテナンスの、API に関する情報をお知らせします。
お知らせの内容に追加、変更等ありましたら、こちらのコメント欄で変更箇所を追記します。
また、API ドキュメントは仕様を順次公開していきます。

kintone

API 関連のアップデートはありません。
kintone 製品の主なアップデート情報は、アップデート情報のページを参照してください。11月定期メンテナンス分は後日公開されます。

Garoon

Garoon REST API

機能追加

• スケジュールで、管理者が予定の施設を取得、登録、変更および削除できる API を追加
  • 対象 API
    • 管理者による施設の取得 /g/api/v1/schedule/admin/facilities [GET]
    • 管理者による施設の登録 /g/api/v1/schedule/admin/facilities [POST]
    • 管理者による施設の更新 /g/api/v1/schedule/admin/facilities/{id} [PATCH]
    • 管理者による施設の削除 /g/api/v1/schedule/admin/facilities/{id} [DELETE]
• スケジュールで、管理者が予定の施設グループを取得、登録、変更および削除できる API を追加
  • 対象 API
    • 管理者による施設グループの取得 /g/api/v1/schedule/admin/facilityGroups [GET]
    • 管理者による施設グループの登録 /g/api/v1/schedule/admin/facilityGroups [POST]
    • 管理者による施設グループの更新 /g/api/v1/schedule/admin/facilityGroups/{id} [PATCH]
    • 管理者による施設グループの削除 /g/api/v1/schedule/admin/facilityGroups/{id} [DELETE]
• プラグインを利用しているかどうかや、利用する対象を取得できる API を追加
  • 対象 API
    • プラグインの基本設定の取得 /g/api/v1/system/plugin/admin/settings/{pluginId} [GET]

不具合修正

• スケジュールで、cybozu.com から削除されたユーザーのみが参加する予定を取得できる現象を解消
  2021年11月26日追記：この修正の対応は、延期されました。
  参考：2021年11月定期メンテナンスにおける Garoon REST API および SOAP API 不具合修正の一部切り戻し
• • 対象 API
    • 予定の取得（1件） /g/api/v1/schedule/events/{id}
  • 修正内容
    取得できる予定のデータは、次のとおり
    
    • 修正前：指定した ID の予定データ
    • 修正後：GRN_SCHD_13001 エラーが発生する
• ワークフローで、項目コードの値が 0 からの連番になっている場合に、項目コードが配列で返されることがある現象を解消
  • 対象 API
    • 申請データの全件取得（クエリで条件を指定）
  • 発生条件
    • 項目コード（items）の値が、「0」「1」「2」のように、0からの連番になっている
  •  修正内容
    取得できる申請データの項目コード（items）は、次のとおり
    
    • 修正前：配列で返される
    • 修正後：オブジェクトで返される

Garoon JavaScript API

機能追加

• ワークフローで、申請の提出が成功したときのイベントを追加
  • 対象イベント
    • ワークフロー申請が提出されたときのイベント workflow.request.create.submit.success
  • 備考
    • 「申請の作成（内容の確認）」画面で、[申請する]をクリックして成功したときに発生するイベントです。
    • 再利用から申請、または下書きから申請したときには、このイベントは発生しません。
•  ワークフローで、申請の確認が成功したときのイベントを追加
  • 対象イベント
    • ワークフロー申請が確認されたときのイベント workflow.request.acknowledge.submit.success
  • 備考
    • 「未処理申請の処理」画面で、[確認する]をクリックし成功したときに発生するイベントです。
• ワークフローで、申請フォームの ID を取得できるようになる
  
  • 対象イベント
    • すべてのワークフローのイベント
• スケジュールで、予定への参加が成功したときのイベントを追加
  • 対象イベント
    • 予定に参加したときのイベント schedule.event.attend.submit.success
  • 備考
    • 「予定への参加」画面で、[はい]をクリックして、成功したときに発生するイベントです。
• スケジュールで、予定の参加者から抜けることに成功したときのイベントを追加
  • 対象イベント
    • 予定から抜けるときのイベント schedule.event.leave.submit.success
  • 備考
    • 「予定から抜ける」画面で、[はい]をクリックして、成功したときに発生するイベントです。

不具合修正

• ワークフロー申請が承認されたときのイベントで、決裁番号を取得できない現象を解消
  • 対象イベント
    • ワークフロー申請が承認されたときのイベント workflow.request.approve.submit.success
  • 発生条件
    • 申請データのフォームに決裁番号を設定している
  • 修正内容
    申請データの申請番号（number）の値は、次のとおり
    
    • 修正前：申請番号
    • 修正後：決裁番号

Garoon SOAP API

不具合修正

• スケジュールで、cybozu.com から削除されたユーザーのみが参加する予定を取得できる現象を解消
  2021年11月26日追記：この修正の対応は、延期されました。
  参考：2021年11月定期メンテナンスにおける Garoon REST API および SOAP API 不具合修正の一部切り戻し
  • 対象 API
    • 指定した ID の予定を取得する ScheduleGetEventsById
  • 修正内容
    取得できる予定のデータは、次のとおり
    
    • 修正前：指定した ID の予定データ
    • 修正後：GRN_SCHD_13001 エラーが発生する

.com 共通

User API

機能追加

• JSON 形式でグループを削除できる API を追加
  • 対象 API
    • グループの削除 /v1/groups.json [DELETE]
  • 備考
    • グループインポートAPI の JSON 版（削除処理のみ）です。

その他

機能追加

• .com 共通管理で Referrer-Policy の設定を変更できるようになります。
  外部連携でリファラーを使ったカスタマイズをする場合は、設定を確認してください。

※ ページ上部の「API 更新情報のお知らせをメールで受け取る」ボタンから、毎月の API 更新情報をメールで受け取ることができます。