获取应用的JavaScript / CSS自定义的设置。
URI
获取正式环境的设置时和获取测试环境的设置时所使用的URI不一样。
获取正式环境的设置时
https://(子域名).cybozu.cn/k/v1/app/customize.json
来宾空间的应用：https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/app/customize.json
获取测试环境的设置时
https://(子域名).cybozu.cn/k/v1/preview/app/customize.json
来宾空间的应用：https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/preview/app/customize.json
HTTP方法
GET
必要的访问权限
应用的管理权限
※不可使用API令牌来执行此API。
请求参数
| 参数名称 | 要指定的值 | 必须 | 说明 |
|---|---|---|---|
| app | 数值或字符串 | 必须 | 应用的ID。 |
请求的范例
要发送的请求因参数的发送方式不同而异。指定参数“app”时的范例如下。
URL中包含参数时
GET /k/v1/app/customize.json?app=8 HTTP/1.1 Host: example.cybozu.cn:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
请求正文中包含参数时
头部
GET /k/v1/app/customize.json HTTP/1.1 Host: example.cybozu.cn:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU= Content-Type: application/json
正文
{
"app": 8
}应答参数
| 参数名称 | 值的类型 | 说明 |
|---|---|---|
| scope | 字符串 | 自定义的应用范围。
|
| desktop | 对象 | 通过PC导入的文件的对象。 |
| desktop.js | 数组 | JavaScript文件信息的数组。 |
| desktop.js[].type | 字符串 | 文件的添加方法。
|
| desktop.js[].url | 字符串 | 文件的URL。 |
| desktop.js[].file | 对象 | 通过附件上传的文件信息的对象。 |
| desktop.js[].file.contentType | 字符串 | MIME类型。 |
| desktop.js[].file.fileKey | 字符串 | key。 |
| desktop.js[].file.name | 字符串 | 名称。 |
| desktop.js[].file.size | 字符串 | 大小（单位byte）。 |
| desktop.css | 数组 | CSS文件信息的数组。 |
| desktop.css[].type | 字符串 | 文件的添加方法。
|
| desktop.css[].url | 字符串 | 文件的URL。 |
| desktop.css[].file | 对象 | 通过附件上传的文件信息的对象。 |
| desktop.css[].file.contentType | 字符串 | MIME类型。 |
| desktop.css[].file.fileKey | 字符串 | key。 |
| desktop.css[].file.name | 字符串 | 名称。 |
| desktop.css[].file.size | 字符串 | 大小（单位byte）。 |
| mobile | 对象 | 通过移动端导入的文件的对象。 |
| mobile.js | 数组 | JavaScript文件信息的数组。 |
| mobile.js[].type | 字符串 | 文件的添加方法。
|
| mobile.js[].url | 字符串 | 文件的URL。 |
| mobile.js[].file | 对象 | 通过附件上传的文件信息的对象。 |
| mobile.js[].file.contentType | 字符串 | MIME类型。 |
| mobile.js[].file.fileKey | 字符串 | key。 |
| mobile.js[].file.name | 字符串 | 名称。 |
| mobile.js[].file.size | 字符串 | 大小（单位byte）。 |
| mobile.css | 数组 | CSS文件信息的数组。 |
| mobile.css[].type | 字符串 | 文件的添加方法。
|
| mobile.css[].url | 字符串 | 文件的URL。 |
| mobile.css[].file | 对象 | 通过附件上传的文件信息的对象。 |
| mobile.css[].file.contentType | 字符串 | MIME类型。 |
| mobile.css[].file.fileKey | 字符串 | key。 |
| mobile.css[].file.name | 字符串 | 名称。 |
| mobile.css[].file.size | 字符串 | 大小（单位byte）。 |
| revision | 字符串 | 应用设置的版本号。 |
应答的范例
{
"scope": "ALL",
"desktop": {
"js": [
{
"type": "URL",
"url": "https://www.example.cn/example.js"
},
{
"type": "FILE",
"file": {
"contentType": "application/javascript",
"fileKey": "20150519023802B3EB762E870645F889B22F9D4F1F3059023",
"name": "sample.js",
"size": "12345"
}
}
],
"css": []
},
"mobile": {
"js": [
{
"type": "FILE",
"file": {
"contentType": "application/javascript",
"fileKey": "20140823043800E9F53A742F7F4416B6E47234DBD6C0D4025",
"name": "mobile.js",
"size": "12345"
}
},
{
"type": "URL",
"url": "https://www.example.cn/example-mobile.js"
}
],
"css": []
},
"revision": "15"
}JavaScript范例
使用API请求发送 kintone REST API 请求
var body = {
"app": 1
};
kintone.api(kintone.api.url('/k/v1/app/customize', true), 'GET', body, function(resp) {
// success
console.log(resp);
}, function(error) {
// error
console.log(error);
});使用 XMLHttpRequest 请求
var url = 'https://{subdomain}.cybozu.cn/k/v1/app/customize.json?app=1';
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();