カテゴリー内の他の記事

2021/05/09 定期のメンテナンスにおける API 更新情報 (2021/04/09)

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

kintone API

今月の kintone アップデート情報

5月版のスペーストップ画面のウィジェットを非表示に設定できる機能により、不要なウィジェットを非表示にしてオリジナルのコンテンツを表示させるカスタマイズが行えるようになります。
また、これに伴い、一部の API やイベントにもウィジェットの非表示への対応が行われます。

kintone JavaScript API

機能追加

5月版でスペースの各ウィジェットを非表示に設定できるようになります。それに伴い、以下の対応が行われます。

  • 次のイベントの発火タイミングが、「すべてのウィジェットの描画完了後」から「すべての非表示ではないウィジェットの描画完了後」に変更されます。
    • 対象 API
    • 備考
      • 5月の定期メンテナンスで、スペースのトップ画面の各ウィジェットの表示設定(モバイルの場合はタブ)を変更できるようになります。

機能改善

  • 省略した形式の API のパスから URL を生成する JavaScript API で、指定したパスに関わらず、必ず「.json」が付与されていた挙動を改善しました
    • 対象 API
    • 修正内容
      kintone.api.url('/k/v1/records.json') とした場合
      • 変更前:https://example.cybozu.com/k/v1/record.json.json が生成される
      • 変更後:https://example.cybozu.com/k/v1/record.json が生成される
    • 今回の改善に関する影響
      kintone.api.url('/k/v1/records') のように「.json」を省略してパスを指定している場合、今回の改善に対する影響はありません。

      これらの API では、本来「.json」をつけたパスは指定できない仕様でした。
      「.json」をつけた URI を指定すると、末尾にさらに「.json」が付与した URL を返していました。
      今後は「.json」をつけた URI を指定した場合、新たに「.json」を付与することはなくなります。

      これらの API を使って、「.json.json」といった末尾の URL を取得して REST API を実行していないか、改めてご確認ください。

    • 備考
      この改善にともなって、kintone REST API リクエストを送信する API でも、「.json」をつけた kintone REST API のパスを指定して実行できるようになります。
      例:kintone.api('/k/v1/record.json', 'GET', ... )

kintone REST API

機能追加

5月版でスペースの各ウィジェットを非表示に設定できるようになります。それに伴い、以下の対応が行われます。

  • スペース情報の取得 API にウィジェットの表示状態に関するパラメータが追加されます
    これらの表示状態は、「スペースのポータルと複数のスレッドを使用する」が有効のスペースでのみ取得できます。
    • 対象 API
    • 備考
      • レスポンスパラメータに以下のパラメータが追加されます。
        • showAnnouncement:「お知らせ」の表示状態
        • showAppList:「アプリ一覧」の表示状態
        • showMemberList:「メンバー一覧」の表示状態
        • showThreadList:「スレッド一覧」の表示状態
        • showRelatedLinkList:「関連リンク一覧」の表示状態

Garoon API

5月版のメンテナンスで、スケジュールでカスタム項目(Schedule datastore) を保存できる機能がリリースされます。
この機能は、予定にカスタマイズごとの追加情報を保存できる機能です。

これまでもカスタム項目(additionalItems)という項目で予定の追加情報を保存できました。
しかし複数のカスタマイズを適用する場合、カスタマイズ項目(additionalItems)は同時に利用できませんでした。

カスタム項目(Schedule datastore)を利用すると、複数のカスタマイズを適用した場合でも、競合を気にせずに予定へ追加情報を保存できるようになります。

なお、カスタム項目(additonalItems)は、今後、1年程度を目処に廃止する予定です。詳細は「Garoon スケジュールのカスタム項目(additionalItems)の廃止予定について」をご参照ください。

Garoon JavaScript API

機能追加

  • カスタム項目(Schedule datastore)に値を登録、取得できる API を追加
    • 対象 API
      • カスタム項目(Schedule datastore)に値を登録する garoon.schedule.event.datastore.set()
      • カスタム項目(Schedule datastore)の値を取得する garoon.schedule.event.datastore.get()
  • スケジュールで、予定の削除前イベントを追加
    • 対象 API
      • 予定の削除前イベント schedule.event.delete.submit
    • 備考
      • 予定の削除画面で「はい」をクリックしたときに発火するイベントです。
  • スケジュールで、予定の削除後イベントを追加
    • 対象 API
      • 予定の削除後イベント schedule.event.delete.submit.success
    • 備考
      • 予定の削除が成功したときに発火するイベントです。
  • 外部 API の実行 API  のHTTP リクエストメソッドで、PATCH を利用できる

Garoon REST API

機能追加

  • スケジュールで、カスタム項目(Schedule datastore)の値を取得、登録、更新、削除できる API を追加
    • 対象 API
      • /g/api/v1/schedule/events/{eventId}/datastore/{customizeName} [GET]
      • /g/api/v1/schedule/events/{eventId}/datastore/{customizeName} [POST]
      • /g/api/v1/schedule/events/{eventId}/datastore/{customizeName} [PUT]
      • /g/api/v1/schedule/events/{eventId}/datastore/{customizeName} [DELETE]

不具合修正

  • ワークフローで、申請データを対象 API で取得したとき、項目データの「項目コード」を正しく取得できない場合がある現象を解消
    • 対象 API
    • 発生条件
      次のすべての条件を満たすとき
      • 「項目コード」に数値を設定した申請フォームを作成する
      • 上記の申請フォームで申請データを作成する
      • 対象 API で申請データを取得する
    • 修正内容
      • 修正前:「項目コード」が項目データの通し番号で返却される
      • 修正後:「項目コード」が申請フォームで設定された値で返却される
    • 今回の修正に対する影響
      次の場合のいずれにもあてはまるワークフローの場合、取得できる項目の値が変わる可能性があります。
      申請フォームの設定および適用しているカスタマイズの内容をご確認ください。
      • 申請フォームの設定で、「項目コード」に数字を設定している
      • カスタマイズ内で、「項目コード」をキーに項目の値を取得している

Garoon 製品

不具合修正

  • アプリケーションに適用したカスタマイズが、カスタマイズグループの一覧の並び順に読み込まれない不具合を修正
    • 修正内容
      アプリケーションに複数のカスタマイズを適用している場合
      • 修正前:カスタマイズグループの更新が古い順に読み込まれる
      • 修正後:カスタマイズグループの一覧の並び順に読み込まれる
    • 今回の修正に対する影響
      複数のカスタマイズを適用している場合、カスタマイズで表示している内容や動きが変わる可能性があります。
      Garoon のシステム管理者は、カスタマイズグループの一覧の並び順(カスタマイズが実行される順番)を改めてご確認ください。


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

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

サインインしてコメントを残してください。