レコードの追加

本インターフェースを呼び出して、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	はい	本インターフェースを呼び出す際のアクセス認証情報です。社内アプリの access_token を取得インターフェースを呼び出して取得できます。

パスパラメータ

名前	タイプ	必須	説明
baseId	String	はい	AIテーブル ID。取得方法はデータ構造をご参照ください。
sheetIdOrName	String	はい	データテーブル ID またはデータテーブル名。データテーブル ID は以下の 2 つの方法で取得できます： - すべてのデータテーブルを取得インターフェースを呼び出して取得します。 - データテーブルを取得インターフェースを呼び出して取得します。

クエリパラメータ

名前	タイプ	必須	説明
operatorId	String	はい	操作者の unionId。以下の 2 つの方法で取得できます： - ユーザー詳細の照会インターフェースを呼び出して取得します。 - サイレントログインコードでユーザー情報を取得インターフェースを呼び出して取得します。
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.	リクエストタイムアウト

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード