2021年3月14日の定期メンテナンスの、API に関する情報をお知らせします。
お知らせの内容に追加、変更等ありましたら、こちらのコメント欄で変更箇所を追記します。
また、API ドキュメントは仕様を順次公開していきます。
kintone API
今月の kintone アップデート情報
今月は、アプリのアクションの設定を取得、更新できる API を追加しました。
1月や2月に追加された API と同じく、これまで画面操作で行っていたアクションの設定を API を使って設定できるようになります。
そのほか、「テーブル」フィールドに対して null を指定して REST API でレコードを登録、更新したときに、エラーにならずに登録、更新できるようになる対応などを行いました。
kintone REST API
機能追加
- アプリのアクションの設定を取得、更新できる API を追加
仕様変更
- フィールドの一覧を取得する API で取得できる「日時」フィールドの defaultValue の書式を「yyyy-MM-ddTHH:mm:ss.SSSZ」から「yyyy-MM-ddTHH:mm」に変更
- 対象 API
- フィールドの一覧を取得する /k/v1/app/form/fields.json
- 対象 API
不具合修正
- 「テーブル」フィールドに対して null を指定して対象 API を実行すると、不正なリクエストエラーが発生することがある現象を解消
- 対象 API
- レコードの登録(1件) /k/v1/record.json
- レコードの一括登録 /k/v1/records.json
- レコードの更新 /k/v1/record.json
- レコードの一括更新 /k/v1/records.json
- 発生条件
次のすべての条件があてはまる場合- リクエストパラメータの「テーブル」フィールドに次のいずれかを指定する
- 「テーブル」フィールドの value に null を指定する
"テーブル": {
"value": null
} - 「テーブル」フィールドの行の value に null を指定する
"テーブル": {
"value": [
{ "value": null }
]
}
- 「テーブル」フィールドの value に null を指定する
- 対象 API を使ってレコードを登録または更新する
- リクエストパラメータの「テーブル」フィールドに次のいずれかを指定する
- 修正内容
- 修正前:不正なリクエストエラーが発生する
- 修正後:リクエストパラメータに応じて、保存されるテーブルの内容は次のようになります。
- 「テーブル」フィールドの value に null を指定したとき:空の行を持つテーブルが保存される
- 「テーブル」フィールドの行の value に null を指定したとき:0行のテーブルが保存される
- 備考
リクエストパラメータの「テーブル」フィールドの行に null を指定した場合は、「入力内容が正しくありません」エラーが発生します。
"テーブル": {
"value": [null]
}
- 対象 API
Garoon API
Garoon のメンテナンスは 2021年3月11日に行われます。Garoon API のアップデート情報は 2021/03/11 メンテナンスにおける Garoon API 更新情報 をご参照ください。
.com 共通
User API
機能追加
- JSON 形式でユーザーの所属組織を更新する API を追加
- 対象 API
- /v1/userOrganizations.json [PUT]
- 備考
CSV でユーザーの所属組織をインポートできる API の JSON 版です。
- 対象 API
仕様変更
- 対象 API における「別言語での表示名」の設定で、中国語(繁体字)を設定できる
- 対象 API
- ユーザーインポート API(CSV) /v1/csv/user.json [POST]
- 組織のインポート API(CSV) /v1/csv/organization.json [POST]
- ユーザーの登録(JSON) /v1/users.json [POST]
- 組織の登録(JSON) /v1/organizations.json [POST]
- 組織の更新(JSON) /v1/organizations.json [PUT]
- 対象 API
- code を指定せずに対象 API を実行した場合のステータスコードおよびエラーメッセージを変更
- 対象 API
- ユーザーの登録(JSON) /v1/users.json [POST]
- 発生条件
次のすべての条件があてはまる場合- code が未指定である
- 対象 API を使ってユーザーの登録を行う
- 修正内容
- 修正前
ステータスコード 520 で、「不正なリクエストです。」メッセージが返却される - 修正後
ステータスコード 400 で、「入力内容が正しくありません。」メッセージが返却される
- 修正前
- 対象 API
※ ページ上部の「API 更新情報のお知らせをメールで受け取る」ボタンから、毎月の API 更新情報をメールで受け取ることができます。
cybozu developer network 運営局です。
お知らせ済みの User API の仕様変更の内容について、記載内容に誤りがあったため更新情報を修正いたしました。
修正した情報(1件)
■ User API
□ 仕様変更
- code を指定せずに対象 API を実行した場合のステータスコードおよびエラーメッセージを変更
- 修正内容
【誤】
- 修正前:ステータスコード 420 で、「不正なリクエストです。」メッセージが返却される
- 修正後:ステータスコード 500 で、「入力内容が正しくありません。」メッセージが返却される
【正】
- 修正前:ステータスコード 520 で、「不正なリクエストです。」メッセージが返却される
- 修正後:ステータスコード 400 で、「入力内容が正しくありません。」メッセージが返却される
申し訳ございませんでした。