Skip to main content
Call this API to retrieve cell attributes. Currently, you can retrieve the value, formula, display value, background color, font size, horizontal alignment, and vertical alignment of cells.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/ranges/{rangeAddress}
HTTP MethodGET
Supported app typeappType-Internal app
Required permissionpermission-Document.Workbook.Read-Spreadsheet read permission

Request headers

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
workbookIdStringYesThe ID of the spreadsheet file. The nodeId(dentryUuid) returned by the Knowledge Base API is the workbookId of the spreadsheet. Obtain it by calling the Get a node or Create a Knowledge Base document API.
sheetIdStringYesThe ID or name of the worksheet. Obtain the value of the id or name parameter by calling the Get all worksheets API.
rangeAddressStringYesThe range address.

Query parameters

NameTypeRequiredDescription
selectStringNoFilters the fields to return. If this parameter is not specified, all fields are returned. - For example, select=values returns only the values field. - To return multiple fields, separate them with commas. For example, select=values,formulas returns only the values and formulas fields. We recommend that you specify this parameter to improve performance and avoid API timeouts caused by adding return values later.
operatorIdStringYesThe unionId of the operator. - Obtain the unionid parameter value by calling the Get user information by silent login code API. - Obtain the unionid parameter value by calling the Query user details API. If the operator has no permission, the API returns the error The operator has no permission.

Request example

HTTP
GET /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/ranges/A1:B2?select=values&operatorId=ppgAxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:f86e0bxxx
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 using 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.GetRangeHeaders getRangeHeaders = new com.aliyun.dingtalkdoc_1_0.models.GetRangeHeaders();
        getRangeHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.GetRangeRequest getRangeRequest = new com.aliyun.dingtalkdoc_1_0.models.GetRangeRequest()
                .setSelect("values")
                .setOperatorId("ppgAxxx");
        try {
            client.getRangeWithOptions("e54Lq3xxx", "Sheet1", "A1:B2", getRangeRequest, getRangeHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // The err object 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)) {
                // The err object 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

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 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()
        get_range_headers = dingtalkdoc__1__0_models.GetRangeHeaders()
        get_range_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_range_request = dingtalkdoc__1__0_models.GetRangeRequest(
            select='values',
            operator_id='ppgAxxx'
        )
        try:
            client.get_range_with_options('e54Lq3xxx', 'Sheet1', 'A1:B2', get_range_request, get_range_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object contains code and message attributes that help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_range_headers = dingtalkdoc__1__0_models.GetRangeHeaders()
        get_range_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_range_request = dingtalkdoc__1__0_models.GetRangeRequest(
            select='values',
            operator_id='ppgAxxx'
        )
        try:
            await client.get_range_with_options_async('e54Lq3xxx', 'Sheet1', 'A1:B2', get_range_request, get_range_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object 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\GetRangeHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\GetRangeRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using 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();
        $getRangeHeaders = new GetRangeHeaders([]);
        $getRangeHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $getRangeRequest = new GetRangeRequest([
            "select" => "values",
            "operatorId" => "ppgAxxx"
        ]);
        try {
            $client->getRangeWithOptions("e54Lq3xxx", "Sheet1", "A1:B2", $getRangeRequest, $getRangeHeaders, 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)) {
                // The err object 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));
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 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
  }

  getRangeHeaders := &dingtalkdoc_1_0.GetRangeHeaders{}
  getRangeHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  getRangeRequest := &dingtalkdoc_1_0.GetRangeRequest{
    Select: tea.String("values"),
    OperatorId: tea.String("ppgAxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetRangeWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), tea.String("A1:B2"), getRangeRequest, getRangeHeaders, &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)) {
      // The err object 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
// 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 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 getRangeHeaders = new $dingtalkdoc_1_0.GetRangeHeaders({ });
    getRangeHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let getRangeRequest = new $dingtalkdoc_1_0.GetRangeRequest({
      select: "values",
      operatorId: "ppgAxxx",
    });
    try {
      await client.getRangeWithOptions("e54Lq3xxx", "Sheet1", "A1:B2", getRangeRequest, getRangeHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // The err object contains code and message attributes that help 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 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.GetRangeHeaders getRangeHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetRangeHeaders();
            getRangeHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetRangeRequest getRangeRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetRangeRequest
            {
                Select = "values",
                OperatorId = "ppgAxxx",
            };
            try
            {
                client.GetRangeWithOptions("e54Lq3xxx", "Sheet1", "A1:B2", getRangeRequest, getRangeHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // The err object 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))
                {
                    // The err object contains code and message attributes that help locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
valuesArrayThe values of the cells. If a cell contains a formula, the calculated result of the formula is returned. The values are returned as a two-dimensional array. The first dimension represents all rows within the range, and the second dimension represents the cell values of each row within the range.
Array of AnyThe values of the cells. If a cell contains a formula, the calculated result of the formula is returned. The values are returned as a two-dimensional array. The first dimension represents all rows within the range, and the second dimension represents the cell values of each row within the range.
formulasArrayThe formulas of the cells. The formulas are returned as a two-dimensional array. The first dimension represents all rows within the range, and the second dimension represents the formulas of all cells in each row within the range.
Array of StringThe formulas of the cells. The formulas are returned as a two-dimensional array. The first dimension represents all rows within the range, and the second dimension represents the formulas of all cells in each row within the range.
displayValuesArrayThe display values of the cells. The display value is the result shown on the spreadsheet interface. Compared with values, it is affected by factors such as the number format (for example, decimal places, percent, and date format). The display values are returned as a two-dimensional array. The first dimension represents all rows within the range, and the second dimension represents the display values of all cells in each row within the range.
Array of StringThe display values of the cells. The display value is the result shown on the spreadsheet interface. Compared with values, it is affected by factors such as the number format (for example, decimal places, percent, and date format). The display values are returned as a two-dimensional array. The first dimension represents all rows within the range, and the second dimension represents the display values of all cells in each row within the range.
backgroundColorsArrayThe background colors of the cells. The background colors are returned as a two-dimensional array. The first dimension represents all rows within the range, and the second dimension represents the background colors of all cells in each row within the range.
ArrayThe background colors of the cells. The background colors are returned as a two-dimensional array. The first dimension represents all rows within the range, and the second dimension represents the background colors of all cells in each row within the range.
redIntegerThe red component of the RGB value.
greenIntegerThe green component of the RGB value.
blueIntegerThe blue component of the RGB value.
hexStringStringThe color in hexadecimal notation.
fontSizesArrayThe font sizes of the cells. The font sizes are returned as a two-dimensional array. The first dimension represents all rows within the range, and the second dimension represents the font sizes of all cells in each row within the range.
Array of IntegerThe font sizes of the cells. The font sizes are returned as a two-dimensional array. The first dimension represents all rows within the range, and the second dimension represents the font sizes of all cells in each row within the range.
horizontalAlignmentsArrayThe horizontal alignments of the cells. The horizontal alignments are returned as a two-dimensional array. The first dimension represents all rows within the range, and the second dimension represents the horizontal alignments of all cells in each row within the range.
Array of StringThe horizontal alignments of the cells. The horizontal alignments are returned as a two-dimensional array. The first dimension represents all rows within the range, and the second dimension represents the horizontal alignments of all cells in each row within the range.
verticalAlignmentsArrayThe vertical alignments of the cells. The vertical alignments are returned as a two-dimensional array. The first dimension represents all rows within the range, and the second dimension represents the vertical alignments of all cells in each row within the range.
Array of StringThe vertical alignments of the cells. The vertical alignments are returned as a two-dimensional array. The first dimension represents all rows within the range, and the second dimension represents the vertical alignments of all cells in each row within the range.

Response body example

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

{
  "values" : [ [ "1" ] ],
  "formulas" : [ [ "=B1+C2" ] ],
  "displayValues" : [ [ "100%" ] ],
  "backgroundColors" : [ [ {
    "red" : 0,
    "green" : 0,
    "blue" : 0,
    "hexString" : "#000000"
  } ] ],
  "fontSizes" : [ [ 14 ] ],
  "horizontalAlignments" : [ [ "general" ] ],
  "verticalAlignments" : [ [ "middle" ] ]
}

Error codes

If an error occurs when you call this API, look up the solution in the Global error codes document based on the error message.
HttpCodeError codeError messageDescription
400invalidRequest.inputArgs.invalid%sThe request parameter is invalid. 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 for this operation.
403forbidden.acrossOrg%sThe request is invalid. Check whether the document to access belongs to the organization specified by the access token.
403forbidden.operationIllegal%sThe requested operation is invalid. 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 the spreadsheet content.
404invalidRequest.resource.notFound%sThe request failed. The resource to access cannot 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.An internal server error occurred. Try again later.