2022年2月13日の定期メンテナンスの、API に関する情報をお知らせします。
お知らせの内容に追加、変更等ありましたら、こちらのコメント欄で変更箇所を追記します。
また、API ドキュメントは仕様を順次公開していきます。
kintone
今月の kintone API 更新情報
2月のアップデートでは、「アプリの条件通知」設定で、作業者へ通知を送信するかどうかを設定できるようになります。
アプリの条件通知の取得 API や変更 API でも、これに対応しました。
kintone REST API
機能追加
- アプリの条件通知の取得 API で、作業者に関する通知の設定を取得できる
- 対象 API
- アプリの条件通知の取得 /k/v1/app/notifications/general.json, /k/v1/preview/app/notifications/general.json [GET]
- 備考
- 定期メンテナンス後に対象 API で設定値を取得すると、作業者に関する通知の設定も含まれるようになります。
- 対象 API
- アプリの条件通知の変更 API で、通知の宛先に作業者を設定できる
- 対象 API
- アプリの条件通知の変更 /k/v1/preview/app/notifications/general.json [POST]
- 備考
- 作業者を設定できる通知の条件は、「レコード編集」「コメント書き込み」です。
- 定期メンテナンス後、対象 API を使って、作業者に関する通知設定のない状態で設定を更新すると、作業者に通知されなくなります。
アプリの条件通知の取得 API で取得した設定値を書き換えて更新するような場合には、今回の機能追加による影響は受けません。
ただし、次のような場合には、作業者に関する通知設定のない状態で更新されるため、作業者への通知が届かなくなる可能性があります。
例:- 定期メンテナンス前にバックアップした設定を利用している
- プラグインなどで独自に設定値を生成している
- 対象 API
Garoon
Garoon JavaScript API
機能追加
- 一度下書きとして保存したワークフローや再利用して作成したワークフローを提出したときでも、ワークフロー申請が提出されたときのイベントを利用できる
- 対象イベント
- ワークフロー申請が提出されたときのイベント workflow.request.create.submit.success
- 対象イベント
不具合修正
- 対象イベントまたは API で取得したスケジュールオブジェクトの attendees の値が、画面に表示される「参加者」と異なることがある現象を解消
- 対象イベント/API
- 予定の登録を実行したときのイベント schedule.event.create.submit
- 予定の変更を実行したときのイベント schedule.event.edit.submit
- 予定の値を取得する garoon.schedule.event.get()
- 発生条件
次のすべての条件を満たすとき- 特定のユーザーに対し、予定の他の参加者へ「閲覧」だけを付与する
- アクセス権を設定したユーザー、および「閲覧」だけを付与したユーザーが参加する予定を作成する
- 「閲覧」だけを付与したユーザーで対象 API を実行する
- 修正内容
対象 API で取得したスケジュールオブジェクトにおける attendees(参加者)の値- 修正前:アクセス権を設定したユーザーが含まれていない(「閲覧」だけを付与したユーザーのみになる)
- 修正後:画面で表示されている「参加者」がすべて含まれている
- 対象イベント/API
- 対象イベントで return event したり、予定の値をセットする API を実行したりすると、画面に表示される「参加者」からアクセス権を設定したユーザーが外れることがある現象を解消
- 対象イベント/API
- 予定の変更画面が表示されたときのイベント schedule.event.edit.show
- 予定の変更を実行したときのイベント schedule.event.edit.submit
- 予定の値をセットする garoon.schedule.event.set()
- 発生条件
次のすべての条件を満たすとき- 特定のユーザーに対し、予定の他の参加者へ「閲覧」だけを付与する
- アクセス権を設定したユーザー、および「閲覧」だけを付与したユーザーが参加する予定を作成する
- 「閲覧」だけを付与したユーザーで、作成した予定に対し対象イベントで return event する、または予定の値をセットする API を実行する
- 修正内容
画面上の「参加者」- 修正前:アクセス権を設定したユーザーが含まれていない(「閲覧」だけを付与したユーザーのみになる)
- 修正後:アクセス権を設定したユーザーも含まれている
- 対象イベント/API
Garoon REST API
機能追加
- ワークフローの申請フォーム情報を取得する API を追加
- 対象 API
- /g/api/v1/workflow/admin/forms/{formId}
- 対象 API
不具合修正
- 実行権限のないユーザーが API を実行したときのエラーメッセージを GRN_CMMN_00005 から GRN_CMMN_00022 に修正
- 対象 API
- 申請データの全件取得(クエリで条件を指定) /g/api/v1/workflow/admin/requests
- 申請データに添付されたファイルの取得 /g/api/v1/workflow/admin/files/{id}
- 管理者による施設の取得 /g/api/v1/schedule/admin/facilities
- 管理者による施設の登録 /g/api/v1/schedule/admin/facilities
- 管理者による施設の更新 /g/api/v1/schedule/admin/facilities/{id}
- 管理者による施設の削除 /g/api/v1/schedule/admin/facilities/{id}
- 管理者による施設グループの取得 /g/api/v1/schedule/admin/facilityGroups
- 管理者による施設グループの登録 /g/api/v1/schedule/admin/facilityGroups
- 管理者による施設グループの更新 /g/api/v1/schedule/admin/facilityGroups/{id}
- 管理者による施設グループの削除 /g/api/v1/schedule/admin/facilityGroups/{id}
- プロキシ API 設定の取得 /g/api/v1/system/api/admin/proxies/code/{proxyCode}
- プロキシ API 設定の登録 /g/api/v1/system/api/admin/proxies
- プロキシ API 設定の更新 /g/api/v1/system/api/admin/proxies/code/{proxyCode}
- プロキシ API 設定の削除 /g/api/v1/system/api/admin/proxies/code/{proxyCode}
- プラグインの基本設定の取得 /g/api/v1/system/plugin/admin/settings/{pluginId}
- 修正内容
- 修正前:GRN_CMMN_00005
- 修正後:GRN_CMMN_00022
- 対象 API
Garoon プラグイン
機能追加
- Garoon プラグインで、開発元の情報や、同じプラグインかどうかを判別し異なるプラグインの場合に更新できなくする識別子を設定できる
- 備考
- 開発元の情報(provider)や、同じプラグインかどうかを判別し異なるプラグインの場合に更新できなくする識別子(plugin_code)は、manifest.json のプロパティとして追加されます。
これらのプロパティは必須項目ではありません。
- 開発元の情報(provider)や、同じプラグインかどうかを判別し異なるプラグインの場合に更新できなくする識別子(plugin_code)は、manifest.json のプロパティとして追加されます。
- 関連ドキュメント
- 備考
※ ページ上部の「API 更新情報のお知らせをメールで受け取る」ボタンから、毎月の API 更新情報をメールで受け取ることができます。
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。