金山文档开放平台

主题

回到顶部
本页内容

创建字段

在指定文档的指定数据表内创建字段

基本信息

请求方法：POST

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

请求主机：developer.kdocs.cn

限流频次

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

权限

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

权限值显示名称权限说明
edit_personal_files
编辑文档内容
编辑文档内容

注意:

字段相关的接口是批量的，允许在一个请求中创建/更新多个字段。

Query 参数

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

Path 参数

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

Body 参数

参数必须类型说明
+
fields
是
fields[]
字段列表

注意

新建字段时必须指定字段名称。

此外，部分字段的额外配置规则见下：

  • 记录关联
{
  "linkSheet": number,   //（新建字段时必须指定）
  "multipleLinks": bool, //（新建字段时必须指定）
  "linkPrefix": string,  //（建议指定，用于规范新建的关联字段及被动创建的反向关联字段的名称）
}
  • 联系人
{
  "multipleContacts": bool, //（新建字段时必须指定）
  "noticeNewContact": bool  //（新建字段时必须指定）
}
部分字段的额外属性返回值结构
  • 单选项/多选项
"items": [
    {
        "id": string,
        "value": string,
        "color": number
    }, ...
]
  • 等级
"max": number
  • 超链接
"displayText": string
  • 联系人
"supportMulti": boolean
  • 记录关联
"linkSheet": number,
"linkField": string,
"supportMulti": boolean

返回参数

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

示例

请求示例 

curl --request POST \
	--url 'https://developer.kdocs.cn/api/v1/openapi/ksheet/6666/sheets/1234/fields?access_token=xxxx' \
	--header 'Content-Type: application/json' \
	--data '{"fields":[{"name":"Field A","type":"Checkbox"},{"name":"Field B","type":"SingleSelect","items":[{"value":"item1"},{"value":"item2"}]},{"name":"Field C","type":"Rating","max":5}]}'

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"fields\":[{\"name\":\"Field A\",\"type\":\"Checkbox\"},{\"name\":\"Field B\",\"type\":\"SingleSelect\",\"items\":[{\"value\":\"item1\"},{\"value\":\"item2\"}]},{\"name\":\"Field C\",\"type\":\"Rating\",\"max\":5}]}");
Request request = new Request.Builder()
	.url("https://developer.kdocs.cn/api/v1/openapi/ksheet/6666/sheets/1234/fields?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/6666/sheets/1234/fields?access_token=xxxx"

	payload := strings.NewReader("{\"fields\":[{\"name\":\"Field A\",\"type\":\"Checkbox\"},{\"name\":\"Field B\",\"type\":\"SingleSelect\",\"items\":[{\"value\":\"item1\"},{\"value\":\"item2\"}]},{\"name\":\"Field C\",\"type\":\"Rating\",\"max\":5}]}")

	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 = "{\"fields\":[{\"name\":\"Field A\",\"type\":\"Checkbox\"},{\"name\":\"Field B\",\"type\":\"SingleSelect\",\"items\":[{\"value\":\"item1\"},{\"value\":\"item2\"}]},{\"name\":\"Field C\",\"type\":\"Rating\",\"max\":5}]}"

headers = { 'Content-Type': "application/json" }

conn.request("POST", "/api/v1/openapi/ksheet/6666/sheets/1234/fields?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/6666/sheets/1234/fields?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 => "{\"fields\":[{\"name\":\"Field A\",\"type\":\"Checkbox\"},{\"name\":\"Field B\",\"type\":\"SingleSelect\",\"items\":[{\"value\":\"item1\"},{\"value\":\"item2\"}]},{\"name\":\"Field C\",\"type\":\"Rating\",\"max\":5}]}",
	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({
	"fields": [
		{
			"name": "Field A",
			"type": "Checkbox"
		},
		{
			"name": "Field B",
			"type": "SingleSelect",
			"items": [
				{
					"value": "item1"
				},
				{
					"value": "item2"
				}
			]
		},
		{
			"name": "Field C",
			"type": "Rating",
			"max": 5
		}
	]
});

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/6666/sheets/1234/fields?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/6666/sheets/1234/fields?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({
  fields: [
    {name: 'Field A', type: 'Checkbox'},
    {
      name: 'Field B',
      type: 'SingleSelect',
      items: [{value: 'item1'}, {value: 'item2'}]
    },
    {name: 'Field C', type: 'Rating', max: 5}
  ]
}));
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/6666/sheets/1234/fields?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, "{\"fields\":[{\"name\":\"Field A\",\"type\":\"Checkbox\"},{\"name\":\"Field B\",\"type\":\"SingleSelect\",\"items\":[{\"value\":\"item1\"},{\"value\":\"item2\"}]},{\"name\":\"Field C\",\"type\":\"Rating\",\"max\":5}]}");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://developer.kdocs.cn/api/v1/openapi/ksheet/6666/sheets/1234/fields?access_token=xxxx");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\"fields\":[{\"name\":\"Field A\",\"type\":\"Checkbox\"},{\"name\":\"Field B\",\"type\":\"SingleSelect\",\"items\":[{\"value\":\"item1\"},{\"value\":\"item2\"}]},{\"name\":\"Field C\",\"type\":\"Rating\",\"max\":5}]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

返回示例 

{
  "code": 0,
  "data": {
    "detail": {
      "fields": [
        {
          "id": "H",
          "name": "Field A",
          "type": "Checkbox"
        },
        {
          "id": "I",
          "items": [
            {
              "id": "H",
              "value": "item1"
            },
            {
              "id": "I",
              "value": "item2"
            }
          ],
          "name": "Field B",
          "type": "SingleSelect"
        },
        {
          "id": "J",
          "max": 5,
          "name": "Field C",
          "type": "Rating"
        }
      ]
    }
  }
}

错误码

请参考错误码说明