Skip to main content
Call this API to search all cells that contain the target text within a specified worksheet of a DingTalk Spreadsheet, and return the position list of matching cells. This is suitable for scenarios where specific content needs to be located in bulk within large datasets. It supports multiple search modes, including exact match, case sensitivity, regular expressions, and search within formulas.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/findAll
HTTP MethodPOST
Supported app typesappType-Internal app
Permission requiredpermission-Document.Workbook.Read-DingTalk Spreadsheet read permission

Request headers

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

Path parameters

NameTypeRequiredDescription
workbookIdStringYesThe spreadsheet file ID. The nodeId(dentryUuid) returned by the Knowledge Base API is the spreadsheet workbookId. You can obtain it by calling the Get node and Create a Knowledge Base document APIs.
sheetIdStringYesThe worksheet ID or title. Call the Get all worksheets API to obtain the ID and title of the worksheet.

Query parameters

NameTypeRequiredDescription
operatorIdStringYesThe unionId of the operator. Call the Query user details API to obtain it. If the operator has no permission, the API returns the error The operator has no permission.
selectStringNoFilters the fields to be returned. If this parameter is not specified, all fields are returned. - If select=a1Notation, only the a1Notation field is returned. - To return multiple fields, separate them with commas. For example, select=a1Notation,values returns only the a1Notation and values fields. Specifying this parameter is recommended to improve performance and avoid API timeouts when additional return values are added in the future.

Request body

NameTypeRequiredDescription
textStringYesThe text to find. If useRegExp is enabled, this is a regular expression pattern. Example: “\d+“
findOptionsObjectYesThe find options.
matchEntireCellBooleanNoWhether to match the entire cell. Valid values: - true: Yes - false: No (default)
matchCaseBooleanNoWhether the search is case sensitive. Valid values: - true: Yes - false: No (default)
useRegExpBooleanNoWhether text is a regular expression. Valid values: - true: Yes - false: No (default)
matchFormulaTextBooleanNoWhether to search by the raw formula text. Valid values: - true: Yes - false: No (default) For example, if a cell is populated with the formula “=A1+B1” and the displayed value is 4: - When the search text is “4” and matchFormulaText is true, the cell is not included in the results. - When the search text is “=A1” and matchFormulaText is true, the cell is included in the results.
scopeStringNoThe search scope. The format is a Range address expressed in A1 notation.
includeHiddenBooleanNoWhether to include hidden cells, that is, cells made invisible by hidden rows or columns, filters, groups, or similar features. Cells that the user does not have permission to view are not included. Valid values: - true: Yes - false: No (default)
unionCellsBooleanYesWhether to aggregate the addresses of the found cells. Aggregation is recommended; otherwise, a large number of addresses may be returned. Valid values: - true: Yes - false: No (default)

Request example

HTTP
POST /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/findAll?operatorId=ppgAxxx&select=a1Notation HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:f86e0bxxx
Content-Type:application/json

{
  "text" : "DingTalk",
  "findOptions" : {
    "matchEntireCell" : true,
    "matchCase" : true,
    "useRegExp" : true,
    "matchFormulaText" : true,
    "scope" : "A:A",
    "includeHidden" : false,
    "unionCells" : true
  }
}
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 using 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.SheetFindAllHeaders sheetFindAllHeaders = new com.aliyun.dingtalkdoc_1_0.models.SheetFindAllHeaders();
        sheetFindAllHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.SheetFindAllRequest.SheetFindAllRequestFindOptions findOptions = new com.aliyun.dingtalkdoc_1_0.models.SheetFindAllRequest.SheetFindAllRequestFindOptions()
                .setMatchEntireCell(true)
                .setMatchCase(true)
                .setUseRegExp(true)
                .setMatchFormulaText(true)
                .setScope("A:A")
                .setIncludeHidden(false)
                .setUnionCells(true);
        com.aliyun.dingtalkdoc_1_0.models.SheetFindAllRequest sheetFindAllRequest = new com.aliyun.dingtalkdoc_1_0.models.SheetFindAllRequest()
                .setOperatorId("ppgAxxx")
                .setSelect("a1Notation")
                .setText("DingTalk")
                .setFindOptions(findOptions);
        try {
            client.sheetFindAllWithOptions("e54Lq3xxx", "Sheet1", sheetFindAllRequest, sheetFindAllHeaders, 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 the code and message properties, which help developers 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 the code and message properties, which help developers locate the issue
            }

        }        
    }
}
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 using 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()
        sheet_find_all_headers = dingtalkdoc__1__0_models.SheetFindAllHeaders()
        sheet_find_all_headers.x_acs_dingtalk_access_token = '<your access token>'
        find_options = dingtalkdoc__1__0_models.SheetFindAllRequestFindOptions(
            match_entire_cell=True,
            match_case=True,
            use_reg_exp=True,
            match_formula_text=True,
            scope='A:A',
            include_hidden=False,
            union_cells=True
        )
        sheet_find_all_request = dingtalkdoc__1__0_models.SheetFindAllRequest(
            operator_id='ppgAxxx',
            select='a1Notation',
            text='DingTalk',
            find_options=find_options
        )
        try:
            client.sheet_find_all_with_options('e54Lq3xxx', 'Sheet1', sheet_find_all_request, sheet_find_all_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message properties, which help developers locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        sheet_find_all_headers = dingtalkdoc__1__0_models.SheetFindAllHeaders()
        sheet_find_all_headers.x_acs_dingtalk_access_token = '<your access token>'
        find_options = dingtalkdoc__1__0_models.SheetFindAllRequestFindOptions(
            match_entire_cell=True,
            match_case=True,
            use_reg_exp=True,
            match_formula_text=True,
            scope='A:A',
            include_hidden=False,
            union_cells=True
        )
        sheet_find_all_request = dingtalkdoc__1__0_models.SheetFindAllRequest(
            operator_id='ppgAxxx',
            select='a1Notation',
            text='DingTalk',
            find_options=find_options
        )
        try:
            await client.sheet_find_all_with_options_async('e54Lq3xxx', 'Sheet1', sheet_find_all_request, sheet_find_all_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message properties, which help developers 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\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\SheetFindAllHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SheetFindAllRequest\findOptions;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SheetFindAllRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using 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();
        $sheetFindAllHeaders = new SheetFindAllHeaders([]);
        $sheetFindAllHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $findOptions = new findOptions([
            "matchEntireCell" => true,
            "matchCase" => true,
            "useRegExp" => true,
            "matchFormulaText" => true,
            "scope" => "A:A",
            "includeHidden" => false,
            "unionCells" => true
        ]);
        $sheetFindAllRequest = new SheetFindAllRequest([
            "operatorId" => "ppgAxxx",
            "select" => "a1Notation",
            "text" => "DingTalk",
            "findOptions" => $findOptions
        ]);
        try {
            $client->sheetFindAllWithOptions("e54Lq3xxx", "Sheet1", $sheetFindAllRequest, $sheetFindAllHeaders, 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 the code and message properties, which help developers 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 (
  "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 using 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
  }

  sheetFindAllHeaders := &dingtalkdoc_1_0.SheetFindAllHeaders{}
  sheetFindAllHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  findOptions := &dingtalkdoc_1_0.SheetFindAllRequestFindOptions{
    MatchEntireCell: tea.Bool(true),
    MatchCase: tea.Bool(true),
    UseRegExp: tea.Bool(true),
    MatchFormulaText: tea.Bool(true),
    Scope: tea.String("A:A"),
    IncludeHidden: tea.Bool(false),
    UnionCells: tea.Bool(true),
  }
  sheetFindAllRequest := &dingtalkdoc_1_0.SheetFindAllRequest{
    OperatorId: tea.String("ppgAxxx"),
    Select: tea.String("a1Notation"),
    Text: tea.String("DingTalk"),
    FindOptions: findOptions,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.SheetFindAllWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), sheetFindAllRequest, sheetFindAllHeaders, &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 the code and message properties, which help developers locate the issue
    }

  }
  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 using 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 sheetFindAllHeaders = new $dingtalkdoc_1_0.SheetFindAllHeaders({ });
    sheetFindAllHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let findOptions = new $dingtalkdoc_1_0.SheetFindAllRequestFindOptions({
      matchEntireCell: true,
      matchCase: true,
      useRegExp: true,
      matchFormulaText: true,
      scope: "A:A",
      includeHidden: false,
      unionCells: true,
    });
    let sheetFindAllRequest = new $dingtalkdoc_1_0.SheetFindAllRequest({
      operatorId: "ppgAxxx",
      select: "a1Notation",
      text: "DingTalk",
      findOptions: findOptions,
    });
    try {
      await client.sheetFindAllWithOptions("e54Lq3xxx", "Sheet1", sheetFindAllRequest, sheetFindAllHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains the code and message properties, which help developers locate the issue
      }

    }    
  }

}

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 using 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.SheetFindAllHeaders sheetFindAllHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SheetFindAllHeaders();
            sheetFindAllHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SheetFindAllRequest.SheetFindAllRequestFindOptions findOptions = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SheetFindAllRequest.SheetFindAllRequestFindOptions
            {
                MatchEntireCell = true,
                MatchCase = true,
                UseRegExp = true,
                MatchFormulaText = true,
                Scope = "A:A",
                IncludeHidden = false,
                UnionCells = true,
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SheetFindAllRequest sheetFindAllRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SheetFindAllRequest
            {
                OperatorId = "ppgAxxx",
                Select = "a1Notation",
                Text = "DingTalk",
                FindOptions = findOptions,
            };
            try
            {
                client.SheetFindAllWithOptions("e54Lq3xxx", "Sheet1", sheetFindAllRequest, sheetFindAllHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains the code and message properties, which help developers 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 the code and message properties, which help developers locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
valueArrayIf no content is found, value is an empty array.
a1NotationStringThe address of the found cell. - If unionCells is set to true, the aggregated address may be A1:B3. - If unionCells is set to false, this is the address of a single cell, for example, A1.
valuesArray
Array of AnyThe value in the found cell (as displayed text).

Response body example

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

{
  "value" : [ {
    "a1Notation" : "A1:B3",
    "values" : [ [ "1" ] ]
  } ]
}

Error codes

If an error occurs when you call this API, refer to the Global error codes document based on the error message to find a solution.
HttpCodeError codeError messageDescription
400invalidRequest.inputArgs.workbookIdIllegalThe workbookId is illegal.The workbookId is invalid.
400invalidRequest.inputArgs.operatorIdIllegalThe operatorId is illegal.The operatorId is invalid.
400invalidRequest.inputArgs.invalid%sThe request parameter is invalid. Check the error message.
400invalidRequest.resource.notWorkbook%sUnsupported document type. Check the workbookId.
403forbidden.operationIllegal%sThe requested action is invalid. Check the error message.
403forbidden.accessDeniedThe operator has no permission.The current user does not have permission for this action.
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. Reduce the spreadsheet content and try again.
403forbidden.acrossOrg%sThe request is invalid. Check whether the document to be accessed belongs to the organization specified by the access token.
404invalidRequest.resource.notFound%sThe request failed. The requested resource cannot be found.
500internalErrorThe server encountered an internal error and was unable to complete your request. Please try again later.Internal server error. Try again later.
503serviceBusyThe server is busy and unable to complete your request. Please try again later.The service is busy. Try again later.