获取应用的图表设置。

URI

URI根据正式环境还是确认应用各动作的测试环境的不同而不同。

如应用中存在两个名字一样的图表，调用该API时会报错。

获取正式环境的设置时

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

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

获取确认应用各动作的测试环境的设置时

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

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

HTTP方法

GET

必要的访问权限

应用的管理权限

请求参数

请求的范例

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

URL中包含参数时

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

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

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

正文

{
  "app": 1,
  "lang": "zh"
}

应答参数

应答的范例

{
  "reports": {
    "初始设置": {
      "id": "7319",
      "chartType": "BAR",
      "chartMode": "NORMAL",
      "name": "初始设置",
      "index": "0",
      "groups": [
        {
          "code": "单选框"
        }
      ],
      "aggregations": [
        {
          "type": "COUNT"
        }
      ],
      "filterCond": "",
      "sorts": [
        {
          "by": "TOTAL",
          "order": "DESC"
        }
      ],
      "periodicReport": null
    },
    "各种图表的设置": {
      "id": "7321",
      "chartType": "TABLE",
      "name": "各种图表的设置",
      "index": "1",
      "groups": [
        {
          "code": "单选框"
        },
        {
          "code": "创建时间",
          "per": "YEAR"
        },
        {
          "code": "时间",
          "per": "MINUTE"
        }
      ],
      "aggregations": [
        {
          "type": "COUNT"
        },
        {
          "type": "SUM",
          "code": "数值"
        },
        {
          "type": "AVERAGE",
          "code": "计算"
        },
        {
          "type": "MAX",
          "code": "创建时间"
        },
        {
          "type": "MIN",
          "code": "时间"
        }
      ],
      "filterCond": "记录编号 = \"1\" and 文本编辑器 like \"aaa\"",
      "sorts": [
        {
          "by": "TOTAL",
          "order": "DESC"
        },
        {
          "by": "GROUP1",
          "order": "ASC"
        },
        {
          "by": "GROUP2",
          "order": "DESC"
        }
      ],
      "periodicReport": null
    },
    "定期报表ON": {
      "id": "7323",
      "chartType": "BAR",
      "chartMode": "NORMAL",
      "name": "定期报表ON",
      "index": "2",
      "groups": [
        {
          "code": "单选框"
        }
      ],
      "aggregations": [
        {
          "type": "COUNT"
        }
      ],
      "filterCond": "",
      "sorts": [
        {
          "by": "TOTAL",
          "order": "DESC"
        }
      ],
      "periodicReport": {
        "active": true,
        "period": {
          "every": "QUARTER",
          "pattern": "JAN_APR_JUL_OCT",
          "dayOfMonth": "END_OF_MONTH",
          "time": "23:30"
        }
      }
    }
  },
  "revision": "77"
}

JavaScript范例

使用API请求发送 kintone REST API 请求

var body = {
  'app': kintone.app.getId()
};
kintone.api(kintone.api.url('/k/v1/app/reports', 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/reports.json?app=' + appId + '&lang=zh';
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();