中文
更改应用的常规设置。
此API仅将应用的设置反映到测试环境中，如需反映到正式环境，需要执行将应用的设置反映到正式环境中API。
URI
https://(子域名).cybozu.cn/k/v1/preview/app/settings.json
来宾空间内的应用：https://(子域名).cybozu.cn/k/guest/(空间ID)/v1/preview/app/settings.json
HTTP 方法
PUT
必要的访问权限
应用的管理权限
※从2020年4月版起可使用API令牌来执行此API。
请求参数
以下是请求参数一览表。留空的参数设置项不会被更新。
| 参数 | 要指定的值 | 必须 | 说明 |
|---|---|---|---|
| app | 数值或字符串 | 必须 | 指定应用的ID。 |
| name | 字符串 | 指定64个字符以内的应用名称。 | |
| description | 字符串 | 指定10,000个字符以内的应用说明。可使用HTML标签。 | |
| icon | 对象 | 存放应用图标信息的对象。 | |
| icon.type | 字符串 | 必须 | 指定以下任意一个应用图标的类型。
|
| icon.key | 字符串 | 必须 | “icon.type”参数中指定了“PRESET”时，需指定要使用的图标的标识符。 图标标识符在使用kintone内置图标的应用中运行应用常规设置获取的API，并使用响应的icon.key值。 |
| icon.file | 对象 | 存放图标文件信息的对象。当“icon.type”指定为“FILE”时，需要指定此参数。 | |
| icon.file.fileKey | 字符串 | 必须 | 指定用以下API上传的文件的key。 上传文件 最大可上传800KB的文件。当“icon.type”参数指定为“FILE”时，需要指定此参数。 |
| theme | 字符串 | 指定应用的设计主题。
| |
| revision | 数值或字符串 | 指定应用的设置更改之前的修订号。如指定的修订号不是最新的，请求将报错。 如果省略或指定“-1”，将不对修订号进行验证。 |
请求的范例
头部
PUT /k/v1/preview/app/settings.json HTTP/1.1 Host: example.cybozu.cn:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU= Content-Type: application/json
正文
{
"app": 21,
"name": "案件管理",
"description": "用于案件管理的应用。",
"icon": {
"type": "PRESET",
"key": "APP72"
},
"theme": "WHITE",
"revision": 1
}应答参数
| 参数名称 | 值的类型 | 说明 |
|---|---|---|
| revision | 字符串 | 应用的设置更改之后的版本修订号。 |
应答的范例
{
"revision": "2"
}JavaScript 范例
使用API请求发送 kintone REST API 请求
var body = {
"app": 1,
"name": "案件管理",
"description": "用于案件管理的应用。",
"icon": {
"type": "PRESET",
"key": "APP72"
},
"theme": "WHITE"
}
kintone.api(kintone.api.url('/k/v1/preview/app/settings', true), 'PUT', body, function(resp) {
// success
console.log(resp);
}, function(error) {
// error
console.log(error);
});使用 XMLHttpRequest 请求
var body = {
"app": 1,
"name": "案件管理",
"description": "用于案件管理的应用。",
"icon": {
"type": "PRESET",
"key": "APP72"
},
"theme": "WHITE",
// CSRF TOKEN: 在kintone中执行API(POST, PUT, DELETE)时需要设置
"__REQUEST_TOKEN__": kintone.getRequestToken()
};
var url = 'https://{subdomain}.cybozu.cn/k/v1/preview/app/settings.json';
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));