金山文档开放平台主题
创建数据表
在指定文档（在线表格）内新建一个数据表，可同时指定表名、视图和字段等信息
提示
新建数据表需要指定宿主文档的file_token，如果您还没有文档（在线表格），可以先进行文档创建，注意文档的后缀名应为.ksheet。
如果您使用的是个人文档，请参照个人文档创建空白文档，如果您使用的是应用文档，请参照应用文档创建空白文档。
基本信息
请求方法：POST
请求路径：/api/v1/openapi/ksheet/:file_token/sheets
请求主机：developer.kdocs.cn
限流频次
| 应用类型 | 限额 |
|---|---|
测试应用 | 10,000 次/天 |
正式应用 | 10,000,000 次/天 |
权限范围
要调用此 API，需要以下权限
| 权限值 | 显示名称 | 权限说明 |
|---|---|---|
edit_personal_files | 编辑文档内容 | 编辑文档内容 |
Path 参数
| 参数 | 必须 | 类型 | 说明 |
|---|---|---|---|
file_token | 是 | string |
Query 参数
| 参数 | 必须 | 类型 | 说明 |
|---|---|---|---|
access_token | 是 | string |
Body 参数
| 参数 | 必须 | 类型 | 说明 |
|---|---|---|---|
name | 是 | string | Sheet 名称 |
views | 是 | views[] | Sheet 的视图列表 |
fields | 是 | fields[] | Sheet 的字段列表 |
返回参数
| 参数 | 必须 | 类型 | 说明 |
|---|---|---|---|
code | 是 | integer | 错误码 |
data | 是 | data {} | 响应数据 |
示例
请求示例
curl --request POST \
--url 'https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets?access_token=xxxx' \
--header 'Content-Type: application/json' \
--data '{"name":"sheetName","views":[{"name":"view1","type":"grid"},{"name":"view2","type":"kanban"},{"name":"view3","type":"gallery"}],"fields":[{"name":"field1","type":"SingleLineText"},{"name":"field2","type":"SingleSelect","items":[{"value":"A"},{"value":"B"},{"value":"C"}]}]}'
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"name\":\"sheetName\",\"views\":[{\"name\":\"view1\",\"type\":\"grid\"},{\"name\":\"view2\",\"type\":\"kanban\"},{\"name\":\"view3\",\"type\":\"gallery\"}],\"fields\":[{\"name\":\"field1\",\"type\":\"SingleLineText\"},{\"name\":\"field2\",\"type\":\"SingleSelect\",\"items\":[{\"value\":\"A\"},{\"value\":\"B\"},{\"value\":\"C\"}]}]}");
Request request = new Request.Builder()
.url("https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets?access_token=xxxx")
.post(body)
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets?access_token=xxxx"
payload := strings.NewReader("{\"name\":\"sheetName\",\"views\":[{\"name\":\"view1\",\"type\":\"grid\"},{\"name\":\"view2\",\"type\":\"kanban\"},{\"name\":\"view3\",\"type\":\"gallery\"}],\"fields\":[{\"name\":\"field1\",\"type\":\"SingleLineText\"},{\"name\":\"field2\",\"type\":\"SingleSelect\",\"items\":[{\"value\":\"A\"},{\"value\":\"B\"},{\"value\":\"C\"}]}]}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
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")
payload = "{\"name\":\"sheetName\",\"views\":[{\"name\":\"view1\",\"type\":\"grid\"},{\"name\":\"view2\",\"type\":\"kanban\"},{\"name\":\"view3\",\"type\":\"gallery\"}],\"fields\":[{\"name\":\"field1\",\"type\":\"SingleLineText\"},{\"name\":\"field2\",\"type\":\"SingleSelect\",\"items\":[{\"value\":\"A\"},{\"value\":\"B\"},{\"value\":\"C\"}]}]}"
headers = { 'Content-Type': "application/json" }
conn.request("POST", "/api/v1/openapi/ksheet/123/sheets?access_token=xxxx", payload, headers)
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?access_token=xxxx",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"name\":\"sheetName\",\"views\":[{\"name\":\"view1\",\"type\":\"grid\"},{\"name\":\"view2\",\"type\":\"kanban\"},{\"name\":\"view3\",\"type\":\"gallery\"}],\"fields\":[{\"name\":\"field1\",\"type\":\"SingleLineText\"},{\"name\":\"field2\",\"type\":\"SingleSelect\",\"items\":[{\"value\":\"A\"},{\"value\":\"B\"},{\"value\":\"C\"}]}]}",
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
const data = JSON.stringify({
"name": "sheetName",
"views": [
{
"name": "view1",
"type": "grid"
},
{
"name": "view2",
"type": "kanban"
},
{
"name": "view3",
"type": "gallery"
}
],
"fields": [
{
"name": "field1",
"type": "SingleLineText"
},
{
"name": "field2",
"type": "SingleSelect",
"items": [
{
"value": "A"
},
{
"value": "B"
},
{
"value": "C"
}
]
}
]
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets?access_token=xxxx");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "developer.kdocs.cn",
"port": null,
"path": "/api/v1/openapi/ksheet/123/sheets?access_token=xxxx",
"headers": {
"Content-Type": "application/json"
}
};
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.write(JSON.stringify({
name: 'sheetName',
views: [
{name: 'view1', type: 'grid'},
{name: 'view2', type: 'kanban'},
{name: 'view3', type: 'gallery'}
],
fields: [
{name: 'field1', type: 'SingleLineText'},
{
name: 'field2',
type: 'SingleSelect',
items: [{value: 'A'}, {value: 'B'}, {value: 'C'}]
}
]
}));
req.end();
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets?access_token=xxxx");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"name\":\"sheetName\",\"views\":[{\"name\":\"view1\",\"type\":\"grid\"},{\"name\":\"view2\",\"type\":\"kanban\"},{\"name\":\"view3\",\"type\":\"gallery\"}],\"fields\":[{\"name\":\"field1\",\"type\":\"SingleLineText\"},{\"name\":\"field2\",\"type\":\"SingleSelect\",\"items\":[{\"value\":\"A\"},{\"value\":\"B\"},{\"value\":\"C\"}]}]}");
CURLcode ret = curl_easy_perform(hnd);
var client = new RestClient("https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets?access_token=xxxx");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\"name\":\"sheetName\",\"views\":[{\"name\":\"view1\",\"type\":\"grid\"},{\"name\":\"view2\",\"type\":\"kanban\"},{\"name\":\"view3\",\"type\":\"gallery\"}],\"fields\":[{\"name\":\"field1\",\"type\":\"SingleLineText\"},{\"name\":\"field2\",\"type\":\"SingleSelect\",\"items\":[{\"value\":\"A\"},{\"value\":\"B\"},{\"value\":\"C\"}]}]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
返回示例
{
"code": 0,
"data": {
"detail": {
"sheet": {
"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"
}
]
}
}
}
}
错误码
请参考错误码说明