Skip to main content
Call this API to delete a field in an AI Table.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/notable/bases/{baseId}/sheets/{sheetIdOrName}/fields/{fieldIdOrName}
HTTP MethodDELETE
Supported app typeappType-Internal app
Permissions requiredpermission-Notable.Base.Write.All-AI Table app write permission

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Obtain it by calling the Get the access token of an internal app API.

Path parameters

NameTypeRequiredDescription
baseIdStringYesThe AI Table ID. For how to obtain it, see Data structure.
sheetIdOrNameStringYesThe Table ID or Table name. Obtain the Table ID in one of the following ways: - Call the Get all tables API. - Call the Get a table API.
fieldIdOrNameStringYesThe field ID or field name. Obtain the field ID by calling the Get all fields API.

Query parameters

NameTypeRequiredDescription
operatorIdStringYesThe unionId of the operator. Obtain it in one of the following ways: - Call the Query user details API. - Call the Get user information by silent login code API.

Request example

HTTP
DELETE /v1.0/notable/bases/xxxxx/sheets/Table/fields/Field?operatorId=xxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
Java
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client with a Token</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalknotable_1_0.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalknotable_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalknotable_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalknotable_1_0.models.DeleteFieldHeaders deleteFieldHeaders = new com.aliyun.dingtalknotable_1_0.models.DeleteFieldHeaders();
        deleteFieldHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalknotable_1_0.models.DeleteFieldRequest deleteFieldRequest = new com.aliyun.dingtalknotable_1_0.models.DeleteFieldRequest()
                .setOperatorId("xxxxx");
        try {
            client.deleteFieldWithOptions("xxxxx", "Table", "Field", deleteFieldRequest, deleteFieldHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains code and message attributes that help you locate the issue
            }

        } catch (Exception _err) {
            TeaException err = new TeaException(_err.getMessage(), _err);
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains code and message attributes that help you locate the issue
            }

        }        
    }
}
Python
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys

from typing import List

from alibabacloud_dingtalk.notable_1_0.client import Client as dingtalknotable_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.notable_1_0 import models as dingtalknotable__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> dingtalknotable_1_0Client:
        """
        Initialize the account Client with a Token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalknotable_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        delete_field_headers = dingtalknotable__1__0_models.DeleteFieldHeaders()
        delete_field_headers.x_acs_dingtalk_access_token = '<your access token>'
        delete_field_request = dingtalknotable__1__0_models.DeleteFieldRequest(
            operator_id='xxxxx'
        )
        try:
            client.delete_field_with_options('xxxxx', 'Table', 'Field', delete_field_request, delete_field_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes that help you locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        delete_field_headers = dingtalknotable__1__0_models.DeleteFieldHeaders()
        delete_field_headers.x_acs_dingtalk_access_token = '<your access token>'
        delete_field_request = dingtalknotable__1__0_models.DeleteFieldRequest(
            operator_id='xxxxx'
        )
        try:
            await client.delete_field_with_options_async('xxxxx', 'Table', 'Field', delete_field_request, delete_field_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes that help you locate the issue
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
PHP
<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vnotable_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vnotable_1_0\Models\DeleteFieldHeaders;
use AlibabaCloud\SDK\Dingtalk\Vnotable_1_0\Models\DeleteFieldRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with a Token
     * @return Dingtalk Client
     */
    public static function createClient(){
        $config = new Config([]);
        $config->protocol = "https";
        $config->regionId = "central";
        return new Dingtalk($config);
    }

    /**
     * @param string[] $args
     * @return void
     */
    public static function main($args){
        $client = self::createClient();
        $deleteFieldHeaders = new DeleteFieldHeaders([]);
        $deleteFieldHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $deleteFieldRequest = new DeleteFieldRequest([
            "operatorId" => "xxxxx"
        ]);
        try {
            $client->deleteFieldWithOptions("xxxxx", "Table", "Field", $deleteFieldRequest, $deleteFieldHeaders, new RuntimeOptions([]));
        }
        catch (Exception $err) {
            if (!($err instanceof TeaError)) {
                $err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
            }
            if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
                // err contains code and message attributes that help you locate the issue
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));
Go
// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalknotable_1_0  "github.com/alibabacloud-go/dingtalk/notable_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

// Description:
// 
// Initialize the account Client with a Token
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *dingtalknotable_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalknotable_1_0.Client{}
  _result, _err = dingtalknotable_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  deleteFieldHeaders := &dingtalknotable_1_0.DeleteFieldHeaders{}
  deleteFieldHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  deleteFieldRequest := &dingtalknotable_1_0.DeleteFieldRequest{
    OperatorId: tea.String("xxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.DeleteFieldWithOptions(tea.String("xxxxx"), tea.String("Table"), tea.String("Field"), deleteFieldRequest, deleteFieldHeaders, &util.RuntimeOptions{})
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var err = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      err = _t
    } else {
      err.Message = tea.String(tryErr.Error())
    }
    if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
      // err contains code and message attributes that help you locate the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
Node.js
'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalknotable_1_0 = require('@alicloud/dingtalk/notable_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * Initialize the account Client with a Token
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalknotable_1_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let deleteFieldHeaders = new dingtalknotable_1_0.DeleteFieldHeaders({ });
    deleteFieldHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let deleteFieldRequest = new dingtalknotable_1_0.DeleteFieldRequest({
      operatorId: 'xxxxx',
    });
    try {
      await client.deleteFieldWithOptions('xxxxx', 'Table', 'Field', deleteFieldRequest, deleteFieldHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains code and message attributes that help you locate the issue
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
C#
// This file is auto-generated, don't edit it. Thanks.

using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>Initialize the account Client with a Token</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Dingtalknotable_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalknotable_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalknotable_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalknotable_1_0.Models.DeleteFieldHeaders deleteFieldHeaders = new AlibabaCloud.SDK.Dingtalknotable_1_0.Models.DeleteFieldHeaders();
            deleteFieldHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalknotable_1_0.Models.DeleteFieldRequest deleteFieldRequest = new AlibabaCloud.SDK.Dingtalknotable_1_0.Models.DeleteFieldRequest
            {
                OperatorId = "xxxxx",
            };
            try
            {
                client.DeleteFieldWithOptions("xxxxx", "Table", "Field", deleteFieldRequest, deleteFieldHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message attributes that help you locate the issue
                }
            }
            catch (Exception _err)
            {
                TeaException err = new TeaException(new Dictionary<string, object>
                {
                    { "message", _err.Message }
                });
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message attributes that help you locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
successBooleanWhether the operation succeeded.

Response body example

HTTP/1.1 200 OK
Content-Type:application/json

{
  "success" : true
}

Error codes

If an error is returned when you call this API, find the solution in the Global error codes document based on the error message.
HttpCodeError codeError messageDescription
500internalErrorThe server encountered an internal error and was unable to complete your request. Please try again later.System error.
500unknownErrorUnknown ErrorUnknown error.
400invalidRequest.inputArgs.invalid%sInvalid request parameter. See the error message for details.
400invalidRequest.document.stillInitializingThe document is under initialization. Please try again laterThe document is being initialized. Try again later.
400invalidRequest.document.brokenThe document is broken and the server is unable to complete your request.The document is corrupted.
403forbidden.operationIllegal%sNo permission.
403invalidRequest.document.typeIllegal%sUnsupported document type. Check the baseId.
404invalidRequest.document.notFoundFail to find the requested resource by the given baseId. Please make sure the given baseId is valid, and the operatorId has permission to access it.The document does not exist.
404invalidRequest.resource.notFound%sThe resource does not exist. The data does not exist or has been permanently deleted.
504service.timeoutThe server is busy and unable to complete your request. Please try again later.Request timed out.