获取应用的常规设置。
URI
URI根据正式环境还是确认应用各动作的测试环境的不同而不同。
获取正式环境的设置时
常规应用
https://(子域名).cybozu.cn/k/v1/app/settings.json
来宾空间内的应用
https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/app /settings.json
获取测试环境的设置时
常规应用
https://(子域名).cybozu.cn/k/v1/preview/app/settings.json
来宾空间内的应用
https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/preview /app/settings.json
HTTP 方法
GET
必要的访问权限
获取正式环境的设置时，需要以下至少其中一个访问权限。
应用的记录查看权限
应用的记录添加权限
获取确认应用各动作的测试环境的设置时
应用的管理权限
※从2020年4月版起可使用API令牌来执行此API。
请求参数
| 参数名称 | 要指定的值 | 必须 | 说明 |
|---|---|---|---|
| app | 数值或字符串 | 必须 | 指定应用的ID。 |
| lang | 字符串 | 如果对应用的名称及应用的说明设置了多语言，需要指定要获取的名称的语言。
|
请求的范例
要发送的请求根据参数发送方式的不同而不同。以下是指定参数“app”和“lang”的请求的例子。
URL中包含参数时
GET /k/v1/app/settings.json?app=8&lang=zh HTTP/1.1 Host: example.cybozu.cn:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
请求正文中包含参数时
头部
GET /k/v1/app/settings.json HTTP/1.1 Host: example.cybozu.cn:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU= Content-Type: application/json
正文
{
"app": 8,
"lang": "zh"
}应答参数
numberPrecision.digits
| 参数名称 | 值的类型 | 说明 |
|---|---|---|
| name | 字符串 | 应用名称。 |
| description | 字符串 | 以HTML格式输出应用的说明。 |
| icon | 对象 | 存放应用图标信息的对象。 |
| icon.type | 字符串 | 图标的种类。
|
| icon.key | 字符串 | 图标的key(标识符)。应用的图标使用kintone自带的图标时输出。 |
| icon.file | 对象 | 存放图标文件信息的对象。在应用的图标中选择已上传的应用图标时输出。 |
| icon.file.contentType | 字符串 | MIME类型。 |
| icon.file.fileKey | 字符串 | key。 |
| icon.file.name | 字符串 | 名字。 |
| icon.file.size | 字符串 | 大小（byte单位）。 |
| theme | 字符串 | 设计主题。 WHITE：初始设置 GREEN：绿色 BLUE：蓝色 ※对于2017年2月维护之前创建的应用，可以获得以下的值。 CLIPBOARD：文件夹 CLIPS：纸夹 |
| titleField | 对象 | 记录标题的信息。 |
| titleField.selectionMode | 字符串 | 要作为记录标题的字段的选择方式 ・AUTO：使用自动设置 ・MANUAL：选择字段 |
| titleField.code | 字符串 | 要作为字段标题的字段的字段代码 根据
|
| enableThumbnails | 布尔值 | 是否显示缩略图。 |
| enableBulkDeletion | 布尔值 | 是否启用批量删除记录。 |
| enableComments | 布尔值 | 是否启用记录的回复功能。 |
| enableDuplicateRecord | 布尔值 | 是否启用重复利用记录的功能。 |
| enableInlineRecordEditing | 布尔值 | 是否启用记录列表的内联编辑功能。 |
| numberPrecision | 对象 | 数值和计算的精度 四舍五入、向下舍入、向上舍入的设置途径 |
| numberPrecision.digits | 字符串 | 整个数值的位数 返回1到30的整数。 |
| numberPrecision.decimalPlaces | 字符串 | 小数部分的位数 返回0～10范围内的整数 |
| numberPrecision.roundingMode | 字符串 | 数值的四舍五入方式
|
| firstMonthOfFiscalYear | 字符串 | 第一季度的开始月 返回1～12范围内的整数。 |
| enableInlineRecordEditing | 布尔值 | 是否启用记录列表内联编辑功能。 |
| revision | 字符串 | 应用设置的修订号。 |
应答的范例
{
"name": "案件管理",
"description": "用于销售项目管理。",
"icon": {
"type": "PRESET",
"key": "APP60"
},
"theme": "WHITE",
"titleField": {
"selectionMode": "MANUAL",
"code": "单行文本框"
},
"enableThumbnails": true,
"enableBulkDeletion": false,
"enableComments": true,
"enableDuplicateRecord": true,
"enableInlineRecordEditing": true,
"numberPrecision": {
"digits": "16",
"decimalPlaces": "4",
"roundingMode": "HALF_EVEN"
},
"firstMonthOfFiscalYear": "4",
"revision": "24"
}JavaScript 范例
使用API请求发送 kintone REST API 请求
var body = {
"app": 1,
"lang": "zh"
};
kintone.api(kintone.api.url('/k/v1/app/settings', true), 'GET', body, function(resp) {
// success
console.log(resp);
}, function(error) {
// error
console.log(error);
});使用 XMLHttpRequest 请求
var params = '?app=1&lang=zh';
var url = 'https://{subdomain}.cybozu.cn/k/v1/app/settings.json' + params;
console.log(url);
var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.onload = function() {
if (xhr.status === 200) {
// success
console.log(JSON.parse(xhr.responseText));
} else {
// error
console.log(JSON.parse(xhr.responseText));
}
};
xhr.send();