API Updates for October 2018

API Updates

The next Kintone update is 12th October 2018. The release also includes the following spec change.

Kintone REST API

Spec changes

  • When using the query parameter for the Get Records Endpoint, additional escape characters need to be included when specifying a sequence of a backslash (\) followed by a double quote ("). This combination is commonly used when escaping a double quote inside of a string.
    • This applies to the following fields:

      • Check box
      • Radio Button
      • Drop-down
      • Multi-choice
      • Status
    • This will specifically affect users who keep values inside these fields in an escaped format, such as:

      1
      
      sample\"1\"
      
    • Before the update, each of the special characters used in the escape sequence would need to be escaped, so for the example above, you would pass this in the request:

      1
      
      sample\\\"1\\\"
      
    • After the update, the escape characters must also be escaped, so for the example above, you would pass this in the request:

      1
      
      sample\\\\\\\"1\\\\\\\"\
      
    • Example
      An example request body for retrieving record data from an App with ID 1, with a checkbox including the value of sample\"1\" is as follows:

      • Before the Update

        1
        2
        3
        4
        
        {
          "app": 1,
          "query": "checkbox in (\"sample\\\"1\\\"\")"
        }
        
      • After the Update

        1
        2
        3
        4
        
        {
          "app": 1,
          "query": "checkbox in (\"sample\\\\\\\"1\\\\\\\"\")"
        }