金山文档开放平台

主题

回到顶部
本页内容

获取文档 Schema 信息

获取文档基础信息，包括数据表信息、字段信息和视图信息等

基本信息

请求方法：GET

请求路径：/api/v1/openapi/ksheet/:file_token/schemas

请求主机：developer.kdocs.cn

限流频次

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

权限

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

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

Path 参数

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

Query 参数

参数必须类型说明
access_token
是
string
访问令牌

返回参数

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

示例

请求示例 

curl --request GET \
	--url 'https://developer.kdocs.cn/api/v1/openapi/ksheet/123/schemas?access_token=xxxx'

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
	.url("https://developer.kdocs.cn/api/v1/openapi/ksheet/123/schemas?access_token=xxxx")
	.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/schemas?access_token=xxxx"

	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/schemas?access_token=xxxx")

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/schemas?access_token=xxxx",
	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/schemas?access_token=xxxx");

xhr.send(data);

const http = require("https");

const options = {
	"method": "GET",
	"hostname": "developer.kdocs.cn",
	"port": null,
	"path": "/api/v1/openapi/ksheet/123/schemas?access_token=xxxx",
	"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/schemas?access_token=xxxx");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://developer.kdocs.cn/api/v1/openapi/ksheet/123/schemas?access_token=xxxx");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);

返回示例 

{
  "code": 0,
  "data": {
    "detail": {
      "sheets": [
        {
          "fields": [
            {
              "id": "B",
              "name": "名称",
              "type": "MultiLineText"
            },
            {
              "id": "C",
              "name": "数量",
              "type": "Number"
            },
            {
              "id": "D",
              "name": "日期",
              "type": "Date"
            },
            {
              "id": "E",
              "items": [
                {
                  "id": "B",
                  "value": "未开始"
                },
                {
                  "id": "C",
                  "value": "进行中"
                },
                {
                  "id": "D",
                  "value": "已完成"
                }
              ],
              "name": "状态",
              "type": "SingleSelect"
            }
          ],
          "id": 1,
          "name": "数据表",
          "recordsCount": 100, // 所有记录（包含不可见）的数量
          "primaryFieldId": "B",
          "views": [
            {
              "id": "B",
              "name": "表格视图",
              "type": "Grid"
            }
          ]
        },
        {
          "fields": [
            {
              "id": "F",
              "name": "field1",
              "type": "SingleLineText"
            },
            {
              "id": "G",
              "items": [
                {
                  "id": "E",
                  "value": "A"
                },
                {
                  "id": "F",
                  "value": "B"
                },
                {
                  "id": "G",
                  "value": "C"
                }
              ],
              "name": "field2",
              "type": "SingleSelect"
            }
          ],
          "id": 3,
          "name": "sheet_for_paw",
          "primaryFieldId": "F",
          "views": [
            {
              "id": "C",
              "name": "view1",
              "type": "Grid"
            },
            {
              "id": "D",
              "name": "view2",
              "type": "Kanban"
            },
            {
              "id": "E",
              "name": "view3",
              "type": "Gallery"
            }
          ]
        }
      ]
    }
  }
}

错误码

请参考错误码说明