获取kintone REST API列表

aki发表于:2016年12月09日 13:59:08更新于:2023年02月17日 13:12:09

获取kintone REST API列表

获取可在kintone中使用的REST API列表。

无法获取以下API的schema信息。

HTTP 方法

GET

URI

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

必要的访问权限

※未登录用户也可执行。

※空间/用户/来宾空间等功能未启用的情况下也可以获取所有API列表


请求参数

应答

参数名称值的类型内 容
apis对象

各API信息列表。 即使空间、用户、来宾空间未启用,也会获取所有API列表。

apis.(key)对象key是表示API的ID。
apis.(key).link字符串是API的URL,用于获取API的schema信息。
应答的范例
{
  "baseUrl": "https://********.cybozu.cn/k/v1/",
  "apis": {
    "records/get": {
      "link": "apis/records/get.json"
    },
    ...
  },
}

JavaScript示例

kintone REST API

kintone.api(kintone.api.url('/k/v1/apis', true), 'GET', {}, function(resp) {
    // success
    console.log(resp);
}, function(error) {
    // error
    console.log(error);
});

XMLHttpRequest

var url = 'https://{subdomain}.cybozu.cn/k/v1/apis.json';
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();