金山文档开放平台

主题

回到顶部
本页内容

遍历记录

遍历数据表内的记录

基本信息

请求方法：GET

请求路径：/api/v1/openapi/ksheet/:file_token/sheets/:sheet_id/records

请求主机：developer.kdocs.cn

限流频次

应用类型限额
测试应用
10,000 次/天
正式应用
10,000,000 次/天

权限

要调用此 API，需要以下权限

权限值显示名称权限说明
access_personal_files
访问个人文档
访问用户个人文档列表

Path 参数

参数必须类型说明
file_token
是
string
文档 ID
sheet_id
是
integer
Sheet ID

Query 参数

参数必须类型说明
access_token
是
string
访问令牌
preferId
否
boolean
使用 id 来标识字段和选项。(为 true 时，fields 参数也按照 id 做解析)
pageSize
否
integer
用于分页获取记录，避免记录过多时一次性返回大量内容。默认值为 100
viewId
否
string
填写后将从被指定的视图获取该用户所见到的记录；若不填写，则从工作表获取记录
maxRecords
否
integer
指定要获取的“前 maxRecords 条记录”，若不填写，则默认返回全部记录
fields
否
string
指定所返回记录中的字段信息，若不填写，则默认返回全部字段内的信息。依据 preferId 的值，需要输入字段名或字段 id
offset
否
string
存在分页时，指定本次查询的起始记录。若不填写或填写为空字符串，则从第一条记录开始获取。查询到最后一页或第 maxRecords 条记录时，返回数据将不再包含 offset 值
pageNum
否
integer
页码, 与offset互斥，如果 offset 和 pageNum 同时出现时，优先处理 pageNum 忽略 offset。与pageSize共同决定所查询的记录范围。当pageNum*pageSize超出最大记录数时，将返回空的结果。 例如: pageNum=3,pageSize=100, 即将总记录数分为每页为100条的记录范围, 3表示查询这个记录范围的第3页(第301条-第400条)

返回参数

参数类型说明
code
integer
错误码
+
data
data {}
响应数据

示例

请求示例 

curl --request GET \
	--url 'https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets/2/records?access_token=xxxx&preferId=false&pageSize=50&viewId=111&maxRecords=10&fields=xxxx&offset=2'

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
	.url("https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets/2/records?access_token=xxxx&preferId=false&pageSize=50&viewId=111&maxRecords=10&fields=xxxx&offset=2")
	.get()
	.build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets/2/records?access_token=xxxx&preferId=false&pageSize=50&viewId=111&maxRecords=10&fields=xxxx&offset=2"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

import http.client

conn = http.client.HTTPSConnection("developer.kdocs.cn")

conn.request("GET", "/api/v1/openapi/ksheet/123/sheets/2/records?access_token=xxxx&preferId=false&pageSize=50&viewId=111&maxRecords=10&fields=xxxx&offset=2")

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
	CURLOPT_URL => "https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets/2/records?access_token=xxxx&preferId=false&pageSize=50&viewId=111&maxRecords=10&fields=xxxx&offset=2",
	CURLOPT_RETURNTRANSFER => true,
	CURLOPT_ENCODING => "",
	CURLOPT_MAXREDIRS => 10,
	CURLOPT_TIMEOUT => 30,
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
	echo "cURL Error #:" . $err;
} else {
	echo $response;
}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
	if (this.readyState === this.DONE) {
		console.log(this.responseText);
	}
});

xhr.open("GET", "https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets/2/records?access_token=xxxx&preferId=false&pageSize=50&viewId=111&maxRecords=10&fields=xxxx&offset=2");

xhr.send(data);

const http = require("https");

const options = {
	"method": "GET",
	"hostname": "developer.kdocs.cn",
	"port": null,
	"path": "/api/v1/openapi/ksheet/123/sheets/2/records?access_token=xxxx&preferId=false&pageSize=50&viewId=111&maxRecords=10&fields=xxxx&offset=2",
	"headers": {}
};

const req = http.request(options, function (res) {
	const chunks = [];

	res.on("data", function (chunk) {
		chunks.push(chunk);
	});

	res.on("end", function () {
		const body = Buffer.concat(chunks);
		console.log(body.toString());
	});
});

req.end();

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets/2/records?access_token=xxxx&preferId=false&pageSize=50&viewId=111&maxRecords=10&fields=xxxx&offset=2");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets/2/records?access_token=xxxx&preferId=false&pageSize=50&viewId=111&maxRecords=10&fields=xxxx&offset=2");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);

返回示例 

{
  "code": 0,
  "data": {
    "detail": {
      "records": [
        {
          "fields": {},
          "id": "B"
        },
        {
          "fields": {},
          "id": "C"
        },
        {
          "fields": {},
          "id": "D"
        }
      ]
    }
  }
}

错误码

请参考错误码说明