金山文档开放平台

主题

回到顶部
本页内容

删除字段

删除数据表内的指定字段

基本信息

请求方法：DELETE

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

请求主机：developer.kdocs.cn

限流频次

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

权限

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

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

Path 参数

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

Query 参数

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

Body 参数

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

返回参数

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

示例

请求示例 

curl --request DELETE \
	--url 'https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets/2/fields?access_token=xxxx' \
	--header 'Content-Type: application/json' \
	--data '{"fields":[{"id":"H"}]}'

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"fields\":[{\"id\":\"H\"}]}");
Request request = new Request.Builder()
	.url("https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets/2/fields?access_token=xxxx")
	.delete(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/2/fields?access_token=xxxx"

	payload := strings.NewReader("{\"fields\":[{\"id\":\"H\"}]}")

	req, _ := http.NewRequest("DELETE", 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\":[{\"id\":\"H\"}]}"

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

conn.request("DELETE", "/api/v1/openapi/ksheet/123/sheets/2/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/123/sheets/2/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 => "DELETE",
	CURLOPT_POSTFIELDS => "{\"fields\":[{\"id\":\"H\"}]}",
	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": [
		{
			"id": "H"
		}
	]
});

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

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

xhr.open("DELETE", "https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets/2/fields?access_token=xxxx");
xhr.setRequestHeader("Content-Type", "application/json");

xhr.send(data);

const http = require("https");

const options = {
	"method": "DELETE",
	"hostname": "developer.kdocs.cn",
	"port": null,
	"path": "/api/v1/openapi/ksheet/123/sheets/2/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: [{id: 'H'}]}));
req.end();

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets/2/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\":[{\"id\":\"H\"}]}");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets/2/fields?access_token=xxxx");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\"fields\":[{\"id\":\"H\"}]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

返回示例 

{
  "code": 0,
  "data": {
    "detail": {
      "fields": [
        {
          "deleted": true,
          "id": "H"
        }
      ]
    }
  }
}

错误码

请参考错误码说明