获取列表的设置

aki发表于:2016年12月28日 10:45:02更新于:2018年03月09日 15:29:10

获取应用的列表设置。

URI

获取正式环境的设置时所使用的URI跟获取测试环境设置时不一样。

获取正式环境的设置时

https://(子域名).cybozu.cn/k/v1/app/views.json

来宾空间内的应用:https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/app/views.json

获取测试环境的设置时

https://(子域名).cybozu.cn/k/v1/preview/app/views.json

来宾空间内的应用:https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/preview/app/views.json

HTTP 方法

GET

访问权限

  • 要获取正式环境的设置,需要有应用记录的查看权限。

  • 要获取测试环境的设置,需要有应用的管理权限。

  • 不可使用API令牌来执行该API。

请求

参数

参数名称要指定的值必须说明
app整 数必须指定应用的ID。
lang字符串
列表或字段名称如果设置了多语言,需要指定要获取的名称的语言。
  • 获取日语的名称时:ja

  • 获取英语的名称时:en

  • 获取中文的名称时:zh

  • 获取头部的「Accept-Language」属性中的语言时:user
    ※如果头部中不指定“Accept-Language”,会默认获取中文。

  • 获取默认的名称时:default

省略时,获取默认名称。

请求的范例

要发送的请求根据参数发送方式的不同而不同。以下是指定参数“app”和“lang”的请求的例子。

URL中包含参数时

GET /k/v1/app/views.json?app=8&lang=ja HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

请求正文中包含参数时
头部

GET /k/v1/app/views.json HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

正文

应答

参数

参数名称值的类型说明
revision字符串应用的设定的修订号。
views数组列表设置的数组。
views. (列表名称).builtinType字符串执行者为自己的记录列表的情况下输出。值为“ASSIGNEE”。
此列表当流程管理功能启用时系统自动设置。
views. (列表名称).date字符串日历形式列表的情况下输出。是作为日期使用的字段的代码。
views. (列表名称).fields数组表格形式列表的情况下输出。是要显示的字段的代码的数组。
views. (列表名称).filterCond字符串是记录的筛选条件。用查询形式显示。查询形式请参考以下页面。
批量获取记录(在查询中指定条件)
views. (列表名称).html字符串自定义形式列表的情况下输出。是自定义时使用的HTML内容。
views. (列表名称).id字符串列表ID。
views. (列表名称).index字符串列表的显示顺序(升序)。
views. (列表名称).name字符串列表名称。
views. (列表名称).pager布尔值自定义形式列表的情况下输出。设置是否分页显示。
  • true:显示

  • false:不显示

views. (列表名称).sort字符串记录的排序条件。用查询形式显示。查询形式请参考以下页面。
批量获取记录(在查询中指定条件)
views. (列表名称).title字符串日历形式列表的情况下输出。作为标题使用的字段的代码。
views. (列表名称).type字符串列表显示形式。
  • LIST:表格形式

  • CALENDAR:日历形式

  • CUSTOM:自定义形式

应答的范例

JavaScript 范例

kintone REST API

var body = {
    "app": 1,
    "lang": "zh"
};

kintone.api(kintone.api.url('/k/v1/app/views', 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/views.json?app=1&lang=ja';
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();

限制事项

在应用里,如果存在同样的列表名字的话,无法用这个API获取设置。

    您需要登录后才可以回复