Index
本篇介绍如何使用API来创建应用以及更改应用的设置。要在大量的应用中设置相同的设置时,使用API可以大大提高效率。
应用的创建和设置更改的流程
按以下流程创建应用以及更改设置。
如要更改现有应用的设置,Step 1不需要。只要操作Step 2和3。
Step 1 | 在测试环境中创建应用 创建应用。此步只有当新建应用的时候才需要。 |
Step 2 | 设置应用 对应用进行必要的设置。 |
Step 3 | 将应用的设置反映到正式环境中 完成应用的设置,并将应用的设置反映到正式环境中。该操作的效果相当于在kintone的应用设置页面中点击[设置完成]。 |
Step 1 在测试环境中创建应用
创建应用。此步只有当新建应用的时候才需要。
应用创建在测试环境中。在Step 3中将设置反映到正式环境中之前,所创建的应用不可以使用。
※所谓测试环境是指:在部署应用之前,临时存放应用信息的地方。
URI
https://(子域名).cybozu.cn/k/v1/preview/app.json
来宾空间的应用:https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/preview/app.json
※执行此API时,不会被计算到API请求数中。
HTTP方法
POST
必要的访问权限
应用的创建权限
※不可使用API令牌来执行此API。
请求参数
参数名称 | 要指定的值 | 必须 | 说明 |
---|---|---|---|
name | 字符串 | 必须 | 应用的名称不得超过64个字符。 |
space | 数值 | 在空间的主题中创建应用时,要指定空间的ID。 | |
thread | 数值 | 在空间的主题中创建应用时,要指定主题的ID。 |
请求的范例
头部
POST /k/v1/preview/app.json HTTP/1.1 Host: example.cybozu.cn:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU= Content-Type: application/json
正文
{ "name": "案件管理", "space": 10, "thread": 11 }
在创建应用时自动添加的以下字段,根据执行API的用户所设置的显示语言来显示。
记录编号
创建人
更新人
创建时间
更新时间
状态
执行者
类别
执行API的用户将语言设置为“与Web浏览器的设置相同”时,
如有Accept-Language头部,则使用该设置。如没有Accept-Language头部,则获取在cybozu.cn共通管理的“本地化设置”中设置的语言。
应答参数
参数名称 | 值的类型 | 说明 |
---|---|---|
app | 字符串 | 创建的应用的ID。 |
revision | 字符串 | 创建的应用的版本号。 |
应答的范例
{ "app": "23", "revision": "1" }
JavaScript范例
使用API请求发送 kintone REST API 请求
var body = { "name": "案件管理", "space": 1001, "thread": 1001 } kintone.api(kintone.api.url('/k/v1/preview/app', true), 'POST', body, function(resp) { // success console.log(resp); }, function(error) { // error console.log(error); });
使用 XMLHttpRequest 请求
var body = { "name": "案件管理", "space": 1001, "thread": 1001, // CSRF TOKEN: 从kintone里执行API(POST, PUT, DELETE)时需要设置 "__REQUEST_TOKEN__": kintone.getRequestToken() }; var url = 'https://{subdomain}.cybozu.cn/k/v1/preview/app.json'; var xhr = new XMLHttpRequest(); xhr.open('POST', 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));
Step 2 设置应用
将必要的设置应用到应用中。
关于更改应用的设置的方法,请根据需要参考如下链接。
Step 3 将应用的设置反映到正式环境中
完成应用的设置,并将应用的设置反映到正式环境中。
将应用的设置反映到正式环境中
到此,应用的设置完成。