Skip to main content
Call this API to clear the data in a cell range, excluding formatting.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/ranges/{rangeAddress}/clearData
HTTP MethodPOST
Supported app typesappType-Internal app appType-Third-party enterprise app
Required permissionspermission-Document.Workbook.Write-DingTalk Spreadsheet write permission

Request headers

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Obtain it as follows: - For an internal app, call the Obtain the access token of an internal app API. - For a third-party enterprise app, call the Obtain the access token of an authorized organization for a third-party app API.

Path parameters

NameTypeRequiredDescription
workbookIdStringYesThe spreadsheet file ID. The nodeId(dentryUuid) returned by the Knowledge Base API is the workbookId of the spreadsheet. Obtain it by calling the Get node or Create a Knowledge Base document API.
sheetIdStringYesThe ID or title of the worksheet. - For an internal app, call the Get all worksheets API to get the ID, or pass the worksheet title. - For a third-party enterprise app, pass the worksheet title. See the figure below for how to view the worksheet title.
rangeAddressStringYesThe cell range to clear, in the format top-left cell of the range:bottom-right cell of the range. For example, B2:C3 represents the range shown in the figure below.

Query parameters

NameTypeRequiredDescription
operatorIdStringYesThe unionId of the operator. Call the Query user details API to get it.

Request example

HTTP
POST /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/ranges/A1:B1/clearData?operatorId=ppgAxxx 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 {

    /**
     * Initialize the account Client with a Token
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkdoc_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.dingtalkdoc_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkdoc_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkdoc_1_0.models.ClearDataHeaders clearDataHeaders = new com.aliyun.dingtalkdoc_1_0.models.ClearDataHeaders();
        clearDataHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.ClearDataRequest clearDataRequest = new com.aliyun.dingtalkdoc_1_0.models.ClearDataRequest()
                .setOperatorId("ppgAxxx");
        try {
            client.clearDataWithOptions("e54Lq3xxx", "Sheet1", "A1:B1", clearDataRequest, clearDataHeaders, 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 diagnose issues
            }

        } 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 diagnose issues
            }

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

from typing import List

from alibabacloud_dingtalk.doc_1_0.client import Client as dingtalkdoc_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.doc_1_0 import models as dingtalkdoc__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() -> dingtalkdoc_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 dingtalkdoc_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        clear_data_headers = dingtalkdoc__1__0_models.ClearDataHeaders()
        clear_data_headers.x_acs_dingtalk_access_token = '<your access token>'
        clear_data_request = dingtalkdoc__1__0_models.ClearDataRequest(
            operator_id='ppgAxxx'
        )
        try:
            client.clear_data_with_options('e54Lq3xxx', 'Sheet1', 'A1:B1', clear_data_request, clear_data_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 diagnose issues
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        clear_data_headers = dingtalkdoc__1__0_models.ClearDataHeaders()
        clear_data_headers.x_acs_dingtalk_access_token = '<your access token>'
        clear_data_request = dingtalkdoc__1__0_models.ClearDataRequest(
            operator_id='ppgAxxx'
        )
        try:
            await client.clear_data_with_options_async('e54Lq3xxx', 'Sheet1', 'A1:B1', clear_data_request, clear_data_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 diagnose issues
                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\Vdoc_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\ClearDataHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\ClearDataRequest;
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();
        $clearDataHeaders = new ClearDataHeaders([]);
        $clearDataHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $clearDataRequest = new ClearDataRequest([
            "operatorId" => "ppgAxxx"
        ]);
        try {
            $client->clearDataWithOptions("e54Lq3xxx", "Sheet1", "A1:B1", $clearDataRequest, $clearDataHeaders, 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 diagnose issues
            }
        }
    }
}
$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 (
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkdoc_1_0  "github.com/alibabacloud-go/dingtalk/doc_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

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

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

  clearDataHeaders := &dingtalkdoc_1_0.ClearDataHeaders{}
  clearDataHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  clearDataRequest := &dingtalkdoc_1_0.ClearDataRequest{
    OperatorId: tea.String("ppgAxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.ClearDataWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), tea.String("A1:B1"), clearDataRequest, clearDataHeaders, &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 diagnose issues
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
Node.js
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkdoc_1_0, * as $dingtalkdoc_1_0 from '@alicloud/dingtalk/doc_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';

export default class Client {

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

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let clearDataHeaders = new $dingtalkdoc_1_0.ClearDataHeaders({ });
    clearDataHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let clearDataRequest = new $dingtalkdoc_1_0.ClearDataRequest({
      operatorId: "ppgAxxx",
    });
    try {
      await client.clearDataWithOptions("e54Lq3xxx", "Sheet1", "A1:B1", clearDataRequest, clearDataHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains code and message attributes that help diagnose issues
      }

    }    
  }

}

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 
    {

        /**
         * Initialize the account Client with a Token
         * @return Client
         * @throws Exception
         */
        public static AlibabaCloud.SDK.Dingtalkdoc_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkdoc_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.ClearDataHeaders clearDataHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.ClearDataHeaders();
            clearDataHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.ClearDataRequest clearDataRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.ClearDataRequest
            {
                OperatorId = "ppgAxxx",
            };
            try
            {
                client.ClearDataWithOptions("e54Lq3xxx", "Sheet1", "A1:B1", clearDataRequest, clearDataHeaders, 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 diagnose issues
                }
            }
            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 diagnose issues
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
a1NotationStringThe cell address.

Response body example

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

{
  "a1Notation" : "A1:B2"
}

Error codes

If an error occurs when calling this API, find the solution in the Global error codes document based on the error message.
HttpCodeError codeError messageDescription
400invalidRequest.inputArgs.invalid%sInvalid request parameter. Check the error message.
400invalidRequest.inputArgs.workbookIdIllegalThe workbookId is illegal.The workbookId is invalid.
400invalidRequest.resource.notWorkbook%sUnsupported document type. Check the workbookId.
403forbidden.accessDeniedThe operator has no permission.The current user does not have permission to perform this action.
403forbidden.acrossOrg%sInvalid request. Verify that the document to access belongs to the organization specified by the access token.
403forbidden.operationIllegal%sInvalid request action. Check the error message.
403forbidden.document.sizeOverLimitThe document size is over limit and the server is unable to complete your request. Retry is unlikely to work unless the document size is decreased.The spreadsheet content is too large. Try reducing it.
404invalidRequest.resource.notFound%sRequest failed. The resource to access could not be found.
500serviceBusyThe server is busy and unable to complete your request. Please try again later.The service is busy. Try again later.
500internalErrorThe server encountered an internal error and was unable to complete your request. Please try again later.Internal server error. Try again later.