中文
获取通知条件（应用）。
URI
获取正式环境的设置时所使用的URI跟获取测试环境设置时不一样。
获取正式环境的设置时
https://(子域名).cybozu.cn/k/v1/app/notifications/general.json
来宾空间内的应用：https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/app/notifications/general.json
获取测试环境的设置时
https://(子域名).cybozu.cn/k/v1/preview/app/notifications/general.json
来宾空间内的应用：https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/preview/app/notifications/general.json
HTTP方法
GET
必要的访问权限
应用的管理权限
请求参数
| 参数名称 | 要指定的值 | 必须 | 说明 |
|---|---|---|---|
| app | 数值或字符串 | 必须 | 指定应用的ID。 |
请求的范例
要发送的请求根据参数的发送方式不同而不同。以下是指定参数“app”时的请求范例。
URL中包含参数时
GET /k/v1/app/notifications/general.json?app=8 HTTP/1.1 Host: example.cybozu.cn:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
请求正文中包含参数时
头部
GET /k/v1/app/notifications/general.json HTTP/1.1 Host: example.cybozu.cn:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU= Content-Type: application/json
正文
{
"app": "8"
}应答参数
| 参数名称 | 值的类型 | 说明 |
|---|---|---|
| notifications | 数组 | 用于存放设置通知条件对象的数组。 |
| notifications[].entity | 对象 | 表示设置通知条件的对象。 |
| notifications[].entity.type | 字符串 | 设置通知条件对象的类型。
|
| notifications[].entity.code | 字符串 | 设置通知条件对象的字段代码。 FIELD_ENTITY 时：字段代码 如果是来宾用户，在用户名前加上“guest/”。 |
| notifications[].includeSubs | 布尔值 | 是否将设置继承给其下属组织。 除非 notifications[].entity.type 在 ORGANIZATION 或 FIELD_ENTITY 中指定了选择组织字段，否则始终返回False。
|
| notifications[].recordAdded | 布尔值 | 是否通过添加记录进行通知的设置。
|
| notifications[].recordEdited | 布尔值 | 是否通过编辑记录进行通知的设置。
|
| notifications[].commentAdded | 布尔值 | 是否通过填写回复进行通知的设置。
|
| notifications[].statusChanged | 布尔值 | 是否通过状态的更新进行通知的设置。
|
| notifications[].fileImported | 布尔值 | 是否通过文件导入进行通知的设置。
|
| notifyToCommenter | 布尔值 | 设置将回复填写到记录时是否会通知填写回复的用户。
|
| revision | 字符串 | 应用的设定的修订号。 |
应答的范例
{
"notifications": [
{
"entity": {
"type": "USER",
"code": "user1"
},
"includeSubs": false,
"recordAdded": true,
"recordEdited": true,
"commentAdded": false,
"statusChanged": false,
"fileImported": true
}
],
"notifyToCommenter": true,
"revision": "2"
}JavaScript范例
使用API请求发送 kintone REST API 请求
var body = {
'app': kintone.app.getId()
};
kintone.api(kintone.api.url('/k/v1/app/notifications/general', true), 'GET', body, function(resp) {
// success
console.log(resp);
}, function(error) {
// error
console.log(error);
});使用 XMLHttpRequest 请求
var appId = kintone.app.getId();
var url = 'https://{subdomain}.cybozu.cn/k/v1/app/notifications/general.json?app=' + appId;
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();