2018年8月12日の定期メンテナンスの、kintone API、Garoon API、User APIの更新に関する情報をお知らせします。
お知らせの内容に追加、変更等ありましたら、こちらのコメントにて変更箇所を追記します。
また、APIドキュメントには仕様を順次公開していきます。
kintone REST API
修正されるメッセージ
- レコードの一括取得(クエリで条件を指定)APIのlike演算子に指定したキーワードが長すぎる場合のエラーメッセージ
- 対象API: レコードの一括取得(クエリで条件を指定) GET /k/v1/records
- 修正内容:
リクエスト時にクエリのlike演算子に指定したキーワードが長すぎる場合のエラーメッセージ
- 修正前:「現在、kintoneの障害のため、正しく検索を行うことが出来ません。時間を置いて再度試してください。」
- 修正後:「絞り込み条件で指定したキーワードが長すぎます。」
Garoon JavaScriptカスタマイズ全般
※6/29の先行情報で告知済の内容です。
仕様変更
JSON.stringify()の挙動の変更
- 修正内容:
JSON.stringify()がGaroon内部のライブラリに上書きされていましたが、
元々のブラウザネイティブ関数の挙動になるように変更します。
この変更により、JSON.stringify()の原因によるAPIリクエスト時の不正なJSON文字列のエラーは発生しなくなります。
例
var myObj = {x: 5, y: ["a", "b", "c"]}; console.log(window.JSON.stringify(myObj)); //変更前:{"x":5,"y":"[\"a\", \"b\", \"c\"]"} //変更後:{"x":5,"y":["a","b","c"]}
Garoon REST API
追加される機能
- 予定の更新(1件)PATCH schedule/events 対応プロパティの追加
-
次の対応プロパティを追加
-
start
-
end
-
isAllDay
-
isStartOnly
-
attendees
-
facilities
-
facilityUsingPurpose
-
-
- 予定の登録(1件)POST schedule/events 対応プロパティの追加
- 次の対応プロパティを追加
- eventType : ALL_DAY(期間予定)
- facilities ※施設のカスタム項目は非対応です。
- facilityUsingPurpose
- companyInfo
- attachments
- useAttendanceCheck
- visibilityTypeの利用可能なvalueに以下を追加
- PRIVATE
- SET_PRIVATE_WATCHERS
- watchers
- 次の対応プロパティを追加
仕様変更
- 予定の登録/更新リクエスト時にendを指定せず、isAllDay=true を指定した場合にエラーにする
- 変更内容:
予定の登録/更新(POST/PATCH)リクエスト時に以下のように指定した場合- start : 指定する
- end:指定しない
- isStartOnly:指定しない
- isAllDay:true
- 変更前:OK(startで指定した日付の期間予定として登録する)
- 変更後:不正な値のエラー
- 変更内容:
- 予定の登録リクエスト時のadditionalItemsにオブジェクト以外を指定した場合にエラーにする
- 変更内容:
予定の登録(POST)リクエスト時にadditionalItemsにオブジェクト以外を指定した場合
例)"additionalItems": "hoge" - 変更前:OK(additionalItemsが無視されて登録される)
- 変更後:エラー
- 変更内容:
- 予定の更新リクエスト時にnull を指定すると指定したプロパティが空になる
- 変更内容:
予定の更新(PATCH)リクエスト時にnull を指定した場合
例)"subject":"hoge" に対して "subject": null で更新
- 変更前:値は"hoge"のまま
- 変更後:値は""になる(空になる)
- 変更内容:
Garoon JavaScript API
追加される機能
- garoon.base.request.getRequestToken() の追加
-
GaroonのJavaScriptカスタマイズからGaroonのREST API(GET以外)を使うためのトークン取得APIを追加します。使い方はkintone.getRequestToken()と同様です。
参考:kintone.getRequestToken()
-
User API
仕様変更
- ユーザーの一括登録(JSON)/ユーザーの一括更新で、日付を指定するパラメータのチェックのルールを変更
- 変更内容:
登録/更新リクエスト時に日付を指定するパラメータ(入社日と誕生日)で年のみ入力した場合
例)"birthDate" : "1996"
- 変更前:エラー
- 変更後:OK("1996-01-01"として保存される)
- 変更内容:
2018年9月4日にkintone APIに関連する以下の更新が実施されるためお知らせします。APIへの影響はありません。
修正される不具合
APIの処理が完了するまで、通知を送信する他の操作を実行できなくなる。
同情報は、kintoneのアップデート情報 にも記載されています。