Append rows to a worksheet - DingTalk Help Center

Call this API to append one or more rows of data after the last existing record in a DingTalk Spreadsheet worksheet. The system automatically locates the last record that contains data and inserts the new rows immediately below it.

API call description

Automatically locates the last record that contains data in the worksheet and appends new rows below it.
Supports appending multiple rows at once through the values two-dimensional array.
If the worksheet is empty, data is written starting from the first record.
Returns the cell range (in A1 notation) where the appended data resides.
The number of columns in the appended data should match the number of columns in the existing worksheet data to ensure data alignment.

Request

Basic information

Field	Value
HTTP URL	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/appendRows`
HTTP Method	POST
Supported app type	appType-Internal app
Permissions	permission-Document.Workbook.Write-DingTalk Spreadsheet write permission

Request headers

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential for calling this API. To obtain it, call the Get the access token of an internal app API.

Path parameters

Name	Type	Required	Description
workbookId	String	Yes	The spreadsheet file ID. Pass `nodeId` (dentryUuid), which serves as the spreadsheet `workbookId`. You can obtain it by calling the Get a node or Create a Knowledge Base document API.
sheetId	String	Yes	The ID or title of the worksheet. You can obtain it by calling the Get all worksheets API, or pass the worksheet title directly.

Query parameters

Name	Type	Required	Description
operatorId	String	Yes	The unionId of the operator. You can obtain it by calling either the Obtain user information by silent login code API or the Query user details by userId API.

Request body

Name	Type	Required	Description
values	Array of Array	Yes	The list of data to append.

Request example

HTTP

POST /v1.0/doc/workbooks/e54Lqxxx/sheets/Sheet1/appendRows?operatorId=ppgAQxxxxgiEiE HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:f86e0xxx
Content-Type:application/json

{
  "values" : [ [ "text" ] ]
}

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.AppendRowsHeaders appendRowsHeaders = new com.aliyun.dingtalkdoc_1_0.models.AppendRowsHeaders();
        appendRowsHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.AppendRowsRequest appendRowsRequest = new com.aliyun.dingtalkdoc_1_0.models.AppendRowsRequest()
                .setOperatorId("ppgAQxxxxgiEiE")
                .setValues(java.util.Arrays.asList(
                    java.util.Arrays.asList(
                        "text"
                    )
                ));
        try {
            client.appendRowsWithOptions("e54Lqxxx", "Sheet1", appendRowsRequest, appendRowsHeaders, 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 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 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()
        append_rows_headers = dingtalkdoc__1__0_models.AppendRowsHeaders()
        append_rows_headers.x_acs_dingtalk_access_token = '<your access token>'
        append_rows_request = dingtalkdoc__1__0_models.AppendRowsRequest(
            operator_id='ppgAQxxxxgiEiE',
            values=[
                [
                    'text'
                ]
            ]
        )
        try:
            client.append_rows_with_options('e54Lqxxx', 'Sheet1', append_rows_request, append_rows_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 locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        append_rows_headers = dingtalkdoc__1__0_models.AppendRowsHeaders()
        append_rows_headers.x_acs_dingtalk_access_token = '<your access token>'
        append_rows_request = dingtalkdoc__1__0_models.AppendRowsRequest(
            operator_id='ppgAQxxxxgiEiE',
            values=[
                [
                    'text'
                ]
            ]
        )
        try:
            await client.append_rows_with_options_async('e54Lqxxx', 'Sheet1', append_rows_request, append_rows_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 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\AppendRowsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\AppendRowsRequest;
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();
        $appendRowsHeaders = new AppendRowsHeaders([]);
        $appendRowsHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $appendRowsRequest = new AppendRowsRequest([
            "operatorId" => "ppgAQxxxxgiEiE",
            "values" => [
                [
                    "text"
                ]
            ]
        ]);
        try {
            $client->appendRowsWithOptions("e54Lqxxx", "Sheet1", $appendRowsRequest, $appendRowsHeaders, 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 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
  }

  appendRowsHeaders := &dingtalkdoc_1_0.AppendRowsHeaders{}
  appendRowsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  appendRowsRequest := &dingtalkdoc_1_0.AppendRowsRequest{
    OperatorId: tea.String("ppgAQxxxxgiEiE"),
    Values: [][]*string{[]*string{tea.String("text")}},
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.AppendRowsWithOptions(tea.String("e54Lqxxx"), tea.String("Sheet1"), appendRowsRequest, appendRowsHeaders, &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 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 appendRowsHeaders = new dingtalkdoc_1_0.AppendRowsHeaders({ });
    appendRowsHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let appendRowsRequest = new dingtalkdoc_1_0.AppendRowsRequest({
      operatorId: 'ppgAQxxxxgiEiE',
      values: [
        [
          'text'
        ]
      ],
    });
    try {
      await client.appendRowsWithOptions('e54Lqxxx', 'Sheet1', appendRowsRequest, appendRowsHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains the code and message properties, which 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.AppendRowsHeaders appendRowsHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.AppendRowsHeaders();
            appendRowsHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.AppendRowsRequest appendRowsRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.AppendRowsRequest
            {
                OperatorId = "ppgAQxxxxgiEiE",
                Values = new List<List<string>>
                {
                    new List<string>
                    {
                        "text"
                    }
                },
            };
            try
            {
                client.AppendRowsWithOptions("e54Lqxxx", "Sheet1", appendRowsRequest, appendRowsHeaders, 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 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 locate the issue
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
a1Notation	String	The range address in A1 notation.

Response body example

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

{
  "a1Notation" : "a1_notation"
}

Error codes

If the API call returns an error, find the solution in the Global error codes documentation based on the error message.

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

​API call description

​Request

​Basic information

​Request headers

​Path parameters

​Query parameters

​Request body

​Request example

​Response

​Response body

​Response body example

​Error codes