Insert records - DingTalk Help Center

Call this API to insert records into a specified table in an AI Table.

Request

Basic information

Field	Value
HTTP URL	`https://api.dingtalk.io/v1.0/notable/bases/{baseId}/sheets/{sheetIdOrName}/records`
HTTP Method	POST
Supported app type	appType-Internal app
Permissions	permission-Notable.Base.Write.All-Write permission for the AI Table app

Request headers

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

Path parameters

Name	Type	Required	Description
baseId	String	Yes	The ID of the AI Table. For how to obtain it, see Data structure.
sheetIdOrName	String	Yes	The table ID or table name. You can obtain the table ID in either of the following ways: - Call the Get all tables API. - Call the Get a table API.

Query parameters

Name	Type	Required	Description
operatorId	String	Yes	The unionId of the operator. Obtain it in either of the following ways: - Call the Query user details API. - Call the Obtain user information by silent login code API.
clientToken	String	No	A standard UUID v4 string used for idempotency control. - Empty: Initiates a new request. - Non-empty: Performs an idempotent update. Repeated requests with the same value are not executed multiple times.

Request body

Name	Type	Required	Description
records	Array	Yes	The record data to be inserted.
fields	`Map<String, Any>`	Yes	The field values of the record, in the `Map<String, Any>` format: - key: The field name (String type), corresponding to the field name in the table. - value: The field value (Any type). Pass a value in the appropriate format based on the field type. For details about the field value format, see Record value format.
	Any	No	The field value. The format varies depending on the field type. For details, see Record value format.

Request example

HTTP

POST /v1.0/notable/bases/qnYxxx/sheets/Table/records?operatorId=xx123x&clientToken=550e8400-e29b-41d4-a716-446655440000 HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxx
Content-Type:application/json

{
  "records": [
    {
      "fields": {
        "Title": "123",
        "Number": 100,
        "User": [
          {
            "unionId": "unionId_1"
          }
        ],
        "Date": 1766959192000
      }
    }
  ]
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client with Token</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalknotable_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.dingtalknotable_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalknotable_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalknotable_1_0.models.InsertRecordsHeaders insertRecordsHeaders = new com.aliyun.dingtalknotable_1_0.models.InsertRecordsHeaders();
        insertRecordsHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalknotable_1_0.models.InsertRecordsRequest.InsertRecordsRequestRecords records0 = new com.aliyun.dingtalknotable_1_0.models.InsertRecordsRequest.InsertRecordsRequestRecords();
        com.aliyun.dingtalknotable_1_0.models.InsertRecordsRequest insertRecordsRequest = new com.aliyun.dingtalknotable_1_0.models.InsertRecordsRequest()
                .setOperatorId("xx123x")
                .setClientToken("550e8400-e29b-41d4-a716-446655440000")
                .setRecords(java.util.Arrays.asList(
                    records0
                ));
        try {
            client.insertRecordsWithOptions("qnYxxx", "Table", insertRecordsRequest, insertRecordsHeaders, 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 properties to help you 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 properties to help you 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.notable_1_0.client import Client as dingtalknotable_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.notable_1_0 import models as dingtalknotable__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() -> dingtalknotable_1_0Client:
        """
        Initialize the account Client with Token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalknotable_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        insert_records_headers = dingtalknotable__1__0_models.InsertRecordsHeaders()
        insert_records_headers.x_acs_dingtalk_access_token = '<your access token>'
        records_0 = dingtalknotable__1__0_models.InsertRecordsRequestRecords()
        insert_records_request = dingtalknotable__1__0_models.InsertRecordsRequest(
            operator_id='xx123x',
            client_token='550e8400-e29b-41d4-a716-446655440000',
            records=[
                records_0
            ]
        )
        try:
            client.insert_records_with_options('qnYxxx', 'Table', insert_records_request, insert_records_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 properties to help you locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        insert_records_headers = dingtalknotable__1__0_models.InsertRecordsHeaders()
        insert_records_headers.x_acs_dingtalk_access_token = '<your access token>'
        records_0 = dingtalknotable__1__0_models.InsertRecordsRequestRecords()
        insert_records_request = dingtalknotable__1__0_models.InsertRecordsRequest(
            operator_id='xx123x',
            client_token='550e8400-e29b-41d4-a716-446655440000',
            records=[
                records_0
            ]
        )
        try:
            await client.insert_records_with_options_async('qnYxxx', 'Table', insert_records_request, insert_records_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 properties to help you 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\Vnotable_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vnotable_1_0\Models\InsertRecordsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vnotable_1_0\Models\InsertRecordsRequest\records;
use AlibabaCloud\SDK\Dingtalk\Vnotable_1_0\Models\InsertRecordsRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with 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();
        $insertRecordsHeaders = new InsertRecordsHeaders([]);
        $insertRecordsHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $records0 = new records([]);
        $insertRecordsRequest = new InsertRecordsRequest([
            "operatorId" => "xx123x",
            "clientToken" => "550e8400-e29b-41d4-a716-446655440000",
            "records" => [
                $records0
            ]
        ]);
        try {
            $client->insertRecordsWithOptions("qnYxxx", "Table", $insertRecordsRequest, $insertRecordsHeaders, 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 properties to help you 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"
  dingtalknotable_1_0  "github.com/alibabacloud-go/dingtalk/notable_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

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

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

  insertRecordsHeaders := &dingtalknotable_1_0.InsertRecordsHeaders{}
  insertRecordsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  records0 := &dingtalknotable_1_0.InsertRecordsRequestRecords{}
  insertRecordsRequest := &dingtalknotable_1_0.InsertRecordsRequest{
    OperatorId: tea.String("xx123x"),
    ClientToken: tea.String("550e8400-e29b-41d4-a716-446655440000"),
    Records: []*dingtalknotable_1_0.InsertRecordsRequestRecords{records0},
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.InsertRecordsWithOptions(tea.String("qnYxxx"), tea.String("Table"), insertRecordsRequest, insertRecordsHeaders, &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 properties to help you 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 dingtalknotable_1_0 = require('@alicloud/dingtalk/notable_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * Initialize the account Client with Token
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalknotable_1_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let insertRecordsHeaders = new dingtalknotable_1_0.InsertRecordsHeaders({ });
    insertRecordsHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let records0 = new dingtalknotable_1_0.InsertRecordsRequestRecords({ });
    let insertRecordsRequest = new dingtalknotable_1_0.InsertRecordsRequest({
      operatorId: 'xx123x',
      clientToken: '550e8400-e29b-41d4-a716-446655440000',
      records: [
        records0
      ],
    });
    try {
      await client.insertRecordsWithOptions('qnYxxx', 'Table', insertRecordsRequest, insertRecordsHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains code and message properties to help you 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 Token</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Dingtalknotable_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalknotable_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalknotable_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalknotable_1_0.Models.InsertRecordsHeaders insertRecordsHeaders = new AlibabaCloud.SDK.Dingtalknotable_1_0.Models.InsertRecordsHeaders();
            insertRecordsHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalknotable_1_0.Models.InsertRecordsRequest.InsertRecordsRequestRecords records0 = new AlibabaCloud.SDK.Dingtalknotable_1_0.Models.InsertRecordsRequest.InsertRecordsRequestRecords();
            AlibabaCloud.SDK.Dingtalknotable_1_0.Models.InsertRecordsRequest insertRecordsRequest = new AlibabaCloud.SDK.Dingtalknotable_1_0.Models.InsertRecordsRequest
            {
                OperatorId = "xx123x",
                ClientToken = "550e8400-e29b-41d4-a716-446655440000",
                Records = new List<AlibabaCloud.SDK.Dingtalknotable_1_0.Models.InsertRecordsRequest.InsertRecordsRequestRecords>
                {
                    records0
                },
            };
            try
            {
                client.InsertRecordsWithOptions("qnYxxx", "Table", insertRecordsRequest, insertRecordsHeaders, 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 properties to help you 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 properties to help you locate the issue
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
value	Array	The list of IDs of records that were successfully inserted.
id	String	The record ID.

Response body example

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

{
  "value" : [ {
    "id" : "xxxx"
  } ]
}

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.

HttpCode	Error code	Error message	Description
400	invalidRequest.inputArgs.invalid	%s	Invalid request parameter. See the error message for details.
400	invalidRequest.document.stillInitializing	The document is under initialization. Please try again later	The document is being initialized. Try again later.
400	invalidRequest.document.broken	The document is broken and the server is unable to complete your request.	The document is damaged.
403	forbidden.operationIllegal	%s	No permission.
403	invalidRequest.document.typeIllegal	%s	Unsupported document type. Check the baseId.
404	invalidRequest.document.notFound	Fail to find the requested resource by the given baseId. Please make sure the given baseId is valid, and the operatorId has permission to access it.	The document does not exist.
404	invalidRequest.resource.notFound	%s	The resource does not exist. The data does not exist or has been permanently deleted.
409	invalidRequest.duplicateClientToken	Duplicate ClientToken detected. Please generate a new client token and retry.	Duplicate idempotency key. Generate a new idempotency key and try again.
500	internalError	The server encountered an internal error and was unable to complete your request. Please try again later.	System error.
500	unknownError	Unknown Error	Unknown error.
504	service.timeout	The server is busy and unable to complete your request. Please try again later.	Request timed out.

​Request

​Basic information

​Request headers

​Path parameters

​Query parameters

​Request body

​Request example

​Response

​Response body

​Response body example

​Error codes