2016/01/10 の定期メンテナンスにおけるkintone REST APIの注意点

フォローする

配列書式の注意点

2016年1月10日の定期メンテナンス以降、kintone API の仕様上、配列型のJSON文字列をオブジェクト型で取得、登録、更新、削除する際には厳密に配列型で指定する必要があります。従来は、仕様上配列で渡す必要があるAPIに対して、オブジェクトで渡していても処理が行われる状況でした。
2016年1月10日の定期メンテナンス以降、仕様と異なる形式で値を渡すとエラーとなります。
こちらの事象は、2016/01/10 の定期メンテナンスにおけるkintone API更新情報 Part1 でお知らせしておりました「一部のライブラリをグローバルスタンダードなものへ変更」の影響によるものです。

対象

配列で渡す必要のある主なAPIは、次の配列型のフィールドタイプ のvalue、一括取得のfields配列、一括登録や更新のrecord配列、一括削除のids配列が対象になります。
詳細は、APIの仕様をご確認ください。
  • テーブル
  • ユーザー選択
  • チェックボックス
  • 複数選択
  • 添付ファイル

1.事象の例

  • 定期メンテナンスによりエラーになるJSONのサンプル例
    {
      "app":466,
      "record":{
        // 配列型でない箇所
        "checkbox":{
          "value":"sample1"
        }
      }
    }
    
  • 上記JSONサンプルを正しく記述すると下記のようになります
    {
      "app":466,
      "record":{
        "checkbox":{
          "value":["sample1"]
        }
      }f
    }
    

2.事象の例

  • 定期メンテナンスによりエラーになるJSONのサンプル例
    {
      "app":466,
      "record":{
        "checkbox":{
          "value":{
            "0":"sample1",
            "1":"sample2"
          }
        }
      }
    }
    
  • 上記JSONサンプルを正しく記述すると下記のようになります
    {
      "app":466,
      "record":{
        "checkbox":{
          "value":[
            "sample1",
            "sample2"
          ]
        }
      }
    }
    

その他の注意点

key名の取り扱い

今回のアップデートにより、API利用時のkey名の取り扱いを変更しました。

  • 今回のアップデート以前では、キー名が仕様と異なる場合でもリクエストが通る場合がありました。今回のアップデート後はキー名仕様通りとする場合以外はエラーになりますのでご注意ください。

事象の例

  • 定期メンテナンスによりエラーになるJSONのサンプル例(ファイルキー)
{
    "file_key": "c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6"
}
  • 上記JSONサンプルを正しく記述すると下記のようになります
{
    "fileKey": "c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6"
}

クエリ指定

今回のアップデート以前では、配列ではないパラメータを複数指定されても値を受け取る場合がありました。
今回のアップデート後は配列ではないパラメータを複数指定されると、値を受け取れなくなりますのでご注意ください。

事象の例

  •  定期メンテナンスによりエラーになる例
app=56&query=<String>&app=56
  • 上記サンプルを正しく記述すると下記のようになります
app=56&query=<String>

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

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

Avatar
cybozu Development team
2016/01/15 その他の注意点に「クエリ指定」をついきしました。
ログインしてコメントを残してください。
Powered by Zendesk