Index

• 更新记录（1条）

• 记录的批量更新

• 注意事项

• 限制事项

更新记录（1条）

• 有记录编辑权限的用户可更新一条记录。

• 更新方法有指定记录编号、和指定【值为唯一】的字段代码及其值两种。

HTTP 方法

PUT

URI

https://(子域名).cybozu.cn/k/v1/record.json

来宾空间内的应用

https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/record.json 

必要的访问权限

• 应用的记录编辑权限

• 要更新值的记录的编辑权限

• 要更新值的字段的编辑权限

请求参数

请求正文的构成（指定记录ID）

{
    "app": (应用的ID),
    "id": (要更新的记录的ID),
    "record": {
        "(字段代码)": {
            "value": (字段值)
        },
        // 表格中的字段的第一行
        "(表格的字段代码)": {
            "value": [
                {
                    "id": (行的ID),
                    "value": {
                        "(字段代码)": {
                            "value": (字段值)
                        }
                    }               
                }
            ]
        }
    },
    "revision": (要更新的记录的修订号) // 不需要时可不用写
}

请求正文的构成（指定【值为唯一】的字段代码及其值）

{
    "app": (应用的ID),
    "updateKey": {
        "field": "(值为唯一的字段代码)",
        "value": "(值)"
    },
    "record": {
        "(字段代码)": {
            "value": (字段值)
        },
        // 表格中的字段的第一行
        "(表格的字段代码)": {
            "value": [
                {
                    "id": (行的ID),
                    "value": {
                        "(字段代码)": {
                            "value": (字段值)
                        }
                    }               
                }
            ]
        }
    },
    "revision": (要更新的记录的修订号) // 不需要时可不写
}

请求范例

请求头部

PUT /k/v1/record.json HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

• 在Content-Type中指定application/json。如不指定无法识别JSON，执行时将报错。

正文（指定记录ID）

对应用ID为【1972】的应用更新如下记录时

正文（指定【值为唯一】的字段代码及其值）

对应用ID为【1972】的应用更新如下记录时

应答

返回更新成功的记录的修订号。

{
    "revision": "5"
}

JavaScript范例

使用API请求发送 kintone REST API 请求

var body = {
    "app": 1,
    "id": 1001,
    "record": {
        "单行文本框": {
            "value": "ABC"
        }
    }
};

kintone.api(kintone.api.url('/k/v1/record', true), 'PUT', body, function(resp) {
        // success
        console.log(resp);
    }, function(error) {
        // error
        console.log(error);
    });

使用 XMLHttpRequest 请求

var url = 'https://{subdomain}.cybozu.cn/k/v1/record.json';
var body = {
    "app": 1,
    "id": 1001,
    "record": {
        "单行文本框": {
            "value": "ABC"
        }
    },
    // CSRF TOKEN: 在kintone上执行API(POST, PUT, DELETE)时需要设置
    "__REQUEST_TOKEN__": kintone.getRequestToken()
};

var xhr = new XMLHttpRequest();
xhr.open('PUT', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.onload = function() {
    if (xhr.status === 200) {
        // success
        console.log(JSON.parse(xhr.responseText));
    } else {
        // error
        console.log(JSON.parse(xhr.responseText));
    }
};
xhr.send(JSON.stringify(body));

记录的批量更新

有记录的编辑权限的用户可批量更新多条记录。

• 一次最多可更新100条记录。

• 更新方法有指定记录ID和指定【值为唯一】的字段代码及其值两种。

• 批量更新失败时，请求中包含的记录的处理将全部被取消。

HTTP 方法

PUT

URI

https://(子域名).cybozu.cn/k/v1/records.json

来宾空间内的应用

https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/records.json 

必要的访问权限

• 应用的记录编辑权限

• 要更新值的记录的编辑权限

• 要更新值的字段的编辑权限

请求参数

※必须指定参数名称为id或updateKey其中一项。但同时指定这两项会报错。

请求正文的构成(※更新n条记录时)

{
    "app": (应用的ID),
    "records": [
        {   // 第1条记录
            "id": (要更新的记录的ID),
            "revision": (要更新的记录的修订号),// 不需要时可不写
            "record": {
                "(字段代码)": {
                    "value": (字段值)
                },
                "(字段代码)": {
                    "value": (字段值)
                }
            }
        },
        {   // 第2条数据
            "id": (要更新的记录的ID),
            "revision": (要更新的记录的修订号),// 不需要时可不写
            "record": {
                "(字段代码)": {
                    "value": (字段值)
                },
                "(字段代码)": {
                    "value": (字段值)
                }
            }
        },
       {   // 第n条数据
            "id": (要更新的记录的ID),
            "revision": (要更新的记录的修订号）,// 不需要时可以不写
            "record": {
                "(字段代码)": {
                    "value": (字段值)
                },
                "(字段代码)": {
                    "value": (数组值)
                }
            }
        }
    ]
}

请求的范例

正文

对应用ID为【1972】的应用，更新如下两条记录时

第1条

第2条

以记录ID为Key时的请求范例

// 以记录ID为Key时的请求范例
{
    "app": 1972,
    "records": [
        {
            "id": 1,
            "revision": 4,
            "record": {
                "string_1": {
                    "value": "abcdef"
                }
            }
        },
        {
            "id": 2,
            "revision": 1,
            "record": {
                "string_multi": {
                    "value": "opqrstu"
                }
            }
        }
    ]
}

以值为唯一的记录为Key时的请求范例

// 以值为唯一的记录为Key时的请求范例
{
    "app": 1972,
    "records": [
        {
            "updateKey": {
                "field": "string_code",
                "value": "CODE123"
            },
            "revision": 4,
            "record": {
                "string_1": {
                    "value": "abcdef"
                }
            }
        },
        {
            "updateKey": {
                "field": "string_code",
                "value": "CODE456"
            },
            "revision": 1,
            "record": {
                "string_multi": {
                    "value": "opqrstu"
                }
            }
        }
    ]
}

应答

返回更新成功的各记录的id和修订号。

{
    "records": [
        {   // 第1条数据
            "id": "1",
            "revision": "5"
        },
        {   // 第2条数据
            "id": "2",
            "revision": "2"
        }
    ]
}

JavaScript范例

使用API请求发送 kintone REST API 请求

var body = {
    "app": kintone.app.getId(),
    "records": [
        {
            "id": 1001,
            "record": {
                "单行文本框": {
                    "value": "ABC"
                }
            }
        },
        {
            "id": 1002,
            "record": {
                "单行文本框": {
                    "value": "ABC"
                }
            }
        }
    ]
};

kintone.api(kintone.api.url('/k/v1/records', true), 'PUT', body, function(resp) {
        // success
        console.log(resp);
    }, function(error) {
        // error
        console.log(error);
    });

使用 XMLHttpRequest 请求

var url = 'https://{subdomain}.cybozu.cn/k/v1/records.json';
var body = {
    "app": 1,
    "records": [
        {
            "id": 1001,
            "record": {
                "单行文本框": {
                    "value": "ABC"
                }
            }
        },
        {
            "id": 1002,
            "record": {
                "单行文本框": {
                    "value": "ABC"
                }
            }
        }
    ],
    // CSRF TOKEN: 在kintone上执行API(POST, PUT, DELETE)时需要设置
    "__REQUEST_TOKEN__": kintone.getRequestToken()
};

var xhr = new XMLHttpRequest();
xhr.open('PUT', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.onload = function() {
    if (xhr.status === 200) {
        // success
        console.log(JSON.parse(xhr.responseText));
    } else {
        // error
        console.log(JSON.parse(xhr.responseText));
    }
};
xhr.send(JSON.stringify(body));

注意事项

附件字段的更新和删除

• 已添加多个附件的情况下，要再添加新的附件时，需要在请求中指定已添加的fileKey。无法更新已添加的附件。

• 删除文件时，如不将该文件的fileKey传给请求，将删除该文件。

表格的数据更新

未包含在请求的JSON数据中的记录不被更新。但，在表单中设置的【表格】内的数据有以下注意事项。

限制事项

• 无法更新以下字段的值。

  • 值是通过Lookup复制来输入的字段

  • 状态
    

  • 类别

  • 计算

  • 执行者

  • 创建人

  • 创建日期

  • 更新人

  • 更新日期

  • 设置为自动计算的单行文本框字段
    

其他请参考共通规格的限制事项。