新增记录 - DingTalk Help Center

调用本接口，在AI表格里的指定数据表中新增行记录。

请求

基本信息

字段	值
HTTP URL	`https://api.dingtalk.io/v1.0/notable/bases/{baseId}/sheets/{sheetIdOrName}/records`
HTTP Method	POST
支持的应用类型	appType-企业内部应用
权限要求	permission-Notable.Base.Write.All-AI表格应用写权限

请求头

名称	类型	是否必填	描述
x-acs-dingtalk-access-token	String	是	调用该接口的访问凭证，可调用获取企业内部应用的accessToken接口获取。

路径参数

名称	类型	是否必填	描述
baseId	String	是	AI表格ID，获取方式请参考数据结构。
sheetIdOrName	String	是	数据表ID或数据表名称。数据表ID可以通过以下两种方式获取： - 调用获取所有数据表接口获取。 - 调用获取数据表接口获取。

查询参数

名称	类型	是否必填	描述
operatorId	String	是	操作人的unionId，可通过以下两种方式获取： - 调用查询用户详情接口获取。 - 调用通过免登码获取用户信息接口获取。
clientToken	String	否	格式为标准的 UUID v4，用于操作幂等性控制。 - 值为空：发起新的请求 - 值非空：幂等更新，相同值的重复请求不会重复执行

请求体

名称	类型	是否必填	描述
records	Array	是	需要写入的行记录数据。
fields	`Map<String, Any>`	是	该行记录中各字段的值，采用 `Map<String, Any>` 格式： - key：字段名称（String类型），对应数据表中的字段名 - value：字段值（Any类型），根据字段类型传入相应格式的值，具体的字段值格式请参考记录值格式文档。记录值格式。
	Any	否	字段值。根据字段类型不同，值的格式也不同，具体请参考记录值格式。

请求示例

HTTP

POST /v1.0/notable/bases/qnYxxx/sheets/数据表/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": {
        "标题": "123",
        "数字": 100,
        "人员": [
          {
            "unionId": "unionId_1"
          }
        ],
        "日期": 1766959192000
      }
    }
  ]
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>使用 Token 初始化账号Client</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", "数据表", 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 中含有 code 和 message 属性，可帮助开发定位问题
            }

        } 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 中含有 code 和 message 属性，可帮助开发定位问题
            }

        }        
    }
}

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:
        """
        使用 Token 初始化账号Client
        @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', '数据表', 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 中含有 code 和 message 属性，可帮助开发定位问题
                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', '数据表', 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 中含有 code 和 message 属性，可帮助开发定位问题
                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 {

    /**
     * 使用 Token 初始化账号Client
     * @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", "数据表", $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 中含有 code 和 message 属性，可帮助开发定位问题
            }
        }
    }
}
$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:
// 
// 使用 Token 初始化账号Client
// 
// @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("数据表"), 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 中含有 code 和 message 属性，可帮助开发定位问题
    }

  }
  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 {

  /**
   * 使用 Token 初始化账号Client
   * @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', '数据表', insertRecordsRequest, insertRecordsHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err 中含有 code 和 message 属性，可帮助开发定位问题
      }

    }    
  }

}

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>使用 Token 初始化账号Client</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", "数据表", insertRecordsRequest, insertRecordsHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err 中含有 code 和 message 属性，可帮助开发定位问题
                }
            }
            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 中含有 code 和 message 属性，可帮助开发定位问题
                }
            }
        }

    }
}

响应

响应体

名称	类型	描述
value	Array	写入成功记录的记录ID集合。
id	String	记录ID。

响应体示例

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

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

错误码

若调用该接口报错，可根据错误信息在全局错误码文档中查找解决方案。

HttpCode	错误码	错误信息	说明
400	invalidRequest.inputArgs.invalid	%s	请求参数不合法，请查看错误信息。
400	invalidRequest.document.stillInitializing	The document is under initialization. Please try again later	文档初始化中，请稍后重试
400	invalidRequest.document.broken	The document is broken and the server is unable to complete your request.	文档已损坏
403	forbidden.operationIllegal	%s	无权限
403	invalidRequest.document.typeIllegal	%s	不支持的文档类型，请检查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.	文档不存在
404	invalidRequest.resource.notFound	%s	资源不存在，数据不存在或被彻底删除
409	invalidRequest.duplicateClientToken	Duplicate ClientToken detected. Please generate a new client token and retry.	幂等键重复，请生成新的幂等键后重试。
500	internalError	The server encountered an internal error and was unable to complete your request. Please try again later.	系统错误
500	unknownError	Unknown Error	未知错误
504	service.timeout	The server is busy and unable to complete your request. Please try again later.	请求超时

​请求

​基本信息

​请求头

​路径参数

​查询参数

​请求体

​请求示例

​响应

​响应体

​响应体示例

​错误码

请求

基本信息

请求头

路径参数

查询参数

请求体

请求示例

响应

响应体

响应体示例

错误码