2018年5月13日の定期メンテナンスの、kintone API、Garoon APIの更新に関する情報をお知らせします。
お知らせの内容に追加、変更等ありましたら、こちらのコメントにて変更箇所を追記します。
また、APIドキュメントには仕様を順次公開していきます。
kintone REST API
仕様変更
- スペース情報の取得APIの応答 coverUrl に記載されたURLのパラメータに関する変更
- 対象API: スペース情報の取得 /k/v1/space.json
- 修正内容:
スペース情報を取得したとき
- 修正前:APIの応答 coverUrl に記載されたURLに「width」「height」のパラメータを持つ場合があります。
- 修正後:APIの応答 coverUrl に記載されたURLのパラメータが次のように変わります。
- 「width」 を「w」に、「height」 を「 h」に名前変更
- パラメータ「r」の追加
- JPEGのEXIF情報にあわせて、画像を回転させるかどうかのフラグで、回転させるときは true が値に入ります。
Garoon REST API
追加される機能
- スケジュールで次のREST APIを追加
Garoon JavaScript API
仕様変更
- 予定情報取得時にユーザー/組織/ロール/施設で内部IDを返す
- 対象:
- 予定の値を取得する garoon.schedule.event.get() で取得されたオブジェクト
- 各イベントのイベントハンドラ内でreturnされたオブジェクト
- 機能内容: 予定情報取得時のレスポンスにユーザー/組織/ロール/施設で内部IDが追加されます。
REST APIの予定の取得(1件)の挙動と同様です。
- 対象:
- 予定のAPI連携用項目の追加
- 機能内容:
スケジュールで他サービスとAPI連携で取得した値を保存するための拡張項目が追加されます。
この項目はJavaScript APIまたはREST APIのみで取扱うことができ、画面上は表示されません。
- 機能内容:
- facilityUsageRequests の戻り値の条件の変更
- 対象: 施設に関するプロパティ「facilityUsageRequests」
- 変更内容:
施設が削除されているか施設の利用申請が無効化されている場合- 変更前: 戻り値に施設の利用申請のステータスが含まれます。
- 変更後: 戻り値に施設の利用申請のステータスが含まれません。
- 通常/期間/繰り返しのどの予定種類においてもisAllDay, isStartOnly が出力される
- 対象API: 予定の値を取得する garoon.schedule.event.get()
- 変更内容:
対象APIで期間予定や繰り返し予定の値を取得したとき- 変更前:「isAllDay」「isStartOnly」が出力されません。
- 変更後: 「isAllDay」「isStartOnly」が出力されます。
REST APIの予定の取得(1件)および予定の一括取得の挙動と同様です。
- ログインユーザーの取得 の戻り値の変更
- 対象API: ログインユーザーの取得 garoon.base.user.getLoginUser
- 変更前: 戻り値に「優先する組織」の情報が含まれません。
- 変更後: 戻り値はローカライズされ、「優先する組織」の「ユーザー名の後に表示する情報」の設定が適用されます。
Garoon SOAP API
仕様変更
- API バージョンが 1.11.0 から 1.12.0 に変更
- 過去の予定をAPIで操作した場合の通知がない不具合の改修にともなう仕様変更
- 対象API:
- 予定を登録する ScheduleAddEvents
- 予定を変更する ScheduleModifyEvents
- 繰り返し予定を変更する ScheduleModifyRepeatEvents
- 予定を削除する ScheduleRemoveEvents
- 繰り返し予定を削除する ScheduleRemoveEventsFromRepeatEvent
- 予定に参加する ScheduleParticipateEvents
- 繰り返し予定に参加する ScheduleParticipateEventsToRepeatEvent
- 予定から抜ける ScheduleLeaveEvents
- 繰り返し予定から抜ける ScheduleLeaveEnvetsFromRepeatEvent
- 仮予定を確定する ScheduleDetermineTemporaryEvents
- 仮予定を削除する ScheduleRemoveTemporaryEventCandidates
- 予定のコメントを追加する ScheduleAddFollows
- 繰り返し予定にコメントを追加する ScheduleAddFollowsToRepeatEvent
- 予定のコメントを削除する ScheduleRemoveFollows
- 変更前: 対象APIで過去の予定を操作した場合、通知がありません。
- 変更後: 対象APIで過去の予定を操作した場合、通知があります。
- 対象API:
修正される不具合
- 繰り返しイベントで ScheduleSearchEvents の when.datetime.start の値が正しくない
- 対象API: 予定を検索する ScheduleSearchEvents
- 修正前:「when.datetime.start」の値が「when.datetime.end」の値と同じです。
- 修正後:「when.datetime.start」の値が繰り返しイベントのインスタンスの開始日時になります。
2018年4月16日 更新
Garoon REST API「予定の一括取得」の名称について、「予定の一覧取得」に修正いたします。