Find a cell in a worksheet

Find the next cell that matches the given string based on the specified conditions. The search scope covers the entire worksheet starting after the top-left cell of the specified range (that is, rangeAddress). If the findOptions.scope parameter is specified, the search scope is further intersected with it.

Request

Basic information

Field	Value
HTTP URL	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/ranges/{rangeAddress}/findNext`
HTTP Method	POST
Supported app types	appType-Internal app
Required permissions	permission-Document.Workbook.Read-DingTalk Spreadsheet read permission

Request headers

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential used to call this API. Call the Get the access token of an internal app API to obtain it.

Path parameters

Name	Type	Required	Description
workbookId	String	Yes	The spreadsheet file ID. Pass `nodeId` (dentryUuid) as the spreadsheet `workbookId`. Call the Get a node or Create a Knowledge Base document API to obtain it.
sheetId	String	Yes	The ID or title of the worksheet. Call the Get all worksheets API to obtain the ID, or pass the worksheet title.
rangeAddress	String	Yes	The starting position of the search. The search starts after the top-left cell of this range (the top-left cell itself is excluded).

Query parameters

Name	Type	Required	Description
operatorId	String	Yes	The unionId of the operator.

Request body

Name	Type	Required	Description
text	String	Yes	The text to find.
findOptions	Object	No	The find options.
matchEntireCell	Boolean	No	Whether to match the entire cell: - true: Yes - false: No
matchCase	Boolean	No	Whether to match case: - true: Yes - false: No
useRegExp	Boolean	No	Whether the text parameter is a regular expression: - true: Yes - false: No
matchFormulaText	Boolean	No	Whether to search within formulas: - true: Yes - false: No
scope	String	No	The search scope. Specify a Range address in A1 notation.
includeHidden	Boolean	No	Whether to include hidden cells, that is, cells made invisible by hidden rows or columns, filters, groups, and similar features. Cells the user has no permission to view are not included. - true: Yes - false: No

Request example

HTTP

POST /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/ranges/B2:C3/findNext?operatorId=ppgAxxx 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" : true
  }
}

Java

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.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 {
        
        com.aliyun.dingtalkdoc_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkdoc_1_0.models.RangeFindNextHeaders rangeFindNextHeaders = new com.aliyun.dingtalkdoc_1_0.models.RangeFindNextHeaders();
        rangeFindNextHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.RangeFindNextRequest.RangeFindNextRequestFindOptions findOptions = new com.aliyun.dingtalkdoc_1_0.models.RangeFindNextRequest.RangeFindNextRequestFindOptions()
                .setMatchEntireCell(true)
                .setMatchCase(true)
                .setUseRegExp(true)
                .setMatchFormulaText(true)
                .setScope("A:A")
                .setIncludeHidden(true);
        com.aliyun.dingtalkdoc_1_0.models.RangeFindNextRequest rangeFindNextRequest = new com.aliyun.dingtalkdoc_1_0.models.RangeFindNextRequest()
                .setOperatorId("ppgAxxx")
                .setText("DingTalk")
                .setFindOptions(findOptions);
        try {
            client.rangeFindNextWithOptions("e54Lq3xxx", "Sheet1", "B2:C3", rangeFindNextRequest, rangeFindNextHeaders, 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 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 locate the issue
            }

        }        
    }
}

Python

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

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()
        range_find_next_headers = dingtalkdoc__1__0_models.RangeFindNextHeaders()
        range_find_next_headers.x_acs_dingtalk_access_token = '<your access token>'
        find_options = dingtalkdoc__1__0_models.RangeFindNextRequestFindOptions(
            match_entire_cell=True,
            match_case=True,
            use_reg_exp=True,
            match_formula_text=True,
            scope='A:A',
            include_hidden=True
        )
        range_find_next_request = dingtalkdoc__1__0_models.RangeFindNextRequest(
            operator_id='ppgAxxx',
            text='DingTalk',
            find_options=find_options
        )
        try:
            client.range_find_next_with_options('e54Lq3xxx', 'Sheet1', 'B2:C3', range_find_next_request, range_find_next_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 locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        range_find_next_headers = dingtalkdoc__1__0_models.RangeFindNextHeaders()
        range_find_next_headers.x_acs_dingtalk_access_token = '<your access token>'
        find_options = dingtalkdoc__1__0_models.RangeFindNextRequestFindOptions(
            match_entire_cell=True,
            match_case=True,
            use_reg_exp=True,
            match_formula_text=True,
            scope='A:A',
            include_hidden=True
        )
        range_find_next_request = dingtalkdoc__1__0_models.RangeFindNextRequest(
            operator_id='ppgAxxx',
            text='DingTalk',
            find_options=find_options
        )
        try:
            await client.range_find_next_with_options_async('e54Lq3xxx', 'Sheet1', 'B2:C3', range_find_next_request, range_find_next_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 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\RangeFindNextHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\RangeFindNextRequest\findOptions;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\RangeFindNextRequest;
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();
        $rangeFindNextHeaders = new RangeFindNextHeaders([]);
        $rangeFindNextHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $findOptions = new findOptions([
            "matchEntireCell" => true,
            "matchCase" => true,
            "useRegExp" => true,
            "matchFormulaText" => true,
            "scope" => "A:A",
            "includeHidden" => true
        ]);
        $rangeFindNextRequest = new RangeFindNextRequest([
            "operatorId" => "ppgAxxx",
            "text" => "DingTalk",
            "findOptions" => $findOptions
        ]);
        try {
            $client->rangeFindNextWithOptions("e54Lq3xxx", "Sheet1", "B2:C3", $rangeFindNextRequest, $rangeFindNextHeaders, 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 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));

package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "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"
)

// Description:
// 
// 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
  }

  rangeFindNextHeaders := &dingtalkdoc_1_0.RangeFindNextHeaders{}
  rangeFindNextHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  findOptions := &dingtalkdoc_1_0.RangeFindNextRequestFindOptions{
    MatchEntireCell: tea.Bool(true),
    MatchCase: tea.Bool(true),
    UseRegExp: tea.Bool(true),
    MatchFormulaText: tea.Bool(true),
    Scope: tea.String("A:A"),
    IncludeHidden: tea.Bool(true),
  }
  rangeFindNextRequest := &dingtalkdoc_1_0.RangeFindNextRequest{
    OperatorId: tea.String("ppgAxxx"),
    Text: tea.String("DingTalk"),
    FindOptions: findOptions,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.RangeFindNextWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), tea.String("B2:C3"), rangeFindNextRequest, rangeFindNextHeaders, &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 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 dingtalkdoc_1_0 = require('@alicloud/dingtalk/doc_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 dingtalkdoc_1_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let rangeFindNextHeaders = new dingtalkdoc_1_0.RangeFindNextHeaders({ });
    rangeFindNextHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let findOptions = new dingtalkdoc_1_0.RangeFindNextRequestFindOptions({
      matchEntireCell: true,
      matchCase: true,
      useRegExp: true,
      matchFormulaText: true,
      scope: 'A:A',
      includeHidden: true,
    });
    let rangeFindNextRequest = new dingtalkdoc_1_0.RangeFindNextRequest({
      operatorId: 'ppgAxxx',
      text: 'DingTalk',
      findOptions: findOptions,
    });
    try {
      await client.rangeFindNextWithOptions('e54Lq3xxx', 'Sheet1', 'B2:C3', rangeFindNextRequest, rangeFindNextHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains code and message attributes that help locate the issue
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));

using Newtonsoft.Json;
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.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.RangeFindNextHeaders rangeFindNextHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.RangeFindNextHeaders();
            rangeFindNextHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.RangeFindNextRequest.RangeFindNextRequestFindOptions findOptions = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.RangeFindNextRequest.RangeFindNextRequestFindOptions
            {
                MatchEntireCell = true,
                MatchCase = true,
                UseRegExp = true,
                MatchFormulaText = true,
                Scope = "A:A",
                IncludeHidden = true,
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.RangeFindNextRequest rangeFindNextRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.RangeFindNextRequest
            {
                OperatorId = "ppgAxxx",
                FindOptions = findOptions,
            };
            try
            {
                client.RangeFindNextWithOptions("e54Lq3xxx", "Sheet1", "B2:C3", rangeFindNextRequest, rangeFindNextHeaders, 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 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 locate the issue
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
a1Notation	String	The address of the cell found, expressed in A1 notation.

Response body example

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

{
  "a1Notation" : "C2"
}

Error codes

If an error is returned when you call this API, look up the solution in the Global error codes document based on the error message.

HttpCode	Error code	Error message	Description
400	invalidRequest.inputArgs.workbookIdIllegal	The workbookId is illegal.	The workbookId is invalid.
400	invalidRequest.inputArgs.operatorIdIllegal	The operatorId is illegal.	The operatorId is invalid.
400	invalidRequest.inputArgs.invalid	%s	The request parameter is invalid. See the error message for details.
400	invalidRequest.resource.notWorkbook	%s	The document type is not supported. Check the workbookId.
403	forbidden.operationIllegal	%s	The requested action is invalid. See the error message for details.
403	forbidden.accessDenied	The operator has no permission.	The current user does not have permission to perform this action.
403	forbidden.document.sizeOverLimit	The 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 content and try again.
403	forbidden.acrossOrg	%s	The request is invalid. Verify that the document to access belongs to the organization specified by the access token.
404	invalidRequest.resource.notFound	%s	The request failed because the resource to access could not be found.
500	internalError	The server encountered an internal error and was unable to complete your request. Please try again later.	Internal server error. Try again later.
500	serviceBusy	The server is busy and unable to complete your request. Please try again later.	The service is busy. Try again later.

API calling guide

Authentication & authorization

Contacts

Calendar

Conferencing

AI Table

Docs & files

IM

Request

Basic information

Request headers

Path parameters

Query parameters

Request body

Request example

Response

Response body

Response body example

Error codes

​Request

​Basic information

​Request headers

​Path parameters

​Query parameters

​Request body

​Request example

​Response

​Response body

​Response body example

​Error codes

Request

Basic information

Request headers

Path parameters

Query parameters

Request body

Request example

Response

Response body

Response body example

Error codes