全フィールドの取得

本インターフェースを呼び出して、データテーブル内の全フィールドを取得します。

リクエスト

基本情報

フィールド	値
HTTP URL	`https://api.dingtalk.io/v1.0/notable/bases/{baseId}/sheets/{sheetIdOrName}/fields`
HTTP Method	GET
対応アプリタイプ	appType-社内アプリ
必要な権限	permission-Notable.Base.Read.All-AIテーブルアプリの読み取り権限

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	はい	本インターフェースを呼び出すためのアクセス認証情報。社内アプリの access_token を取得するインターフェースを呼び出して取得します。

パスパラメータ

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

クエリパラメータ

名前	タイプ	必須	説明
operatorId	String	はい	操作者の unionId。以下の 2 つの方法で取得できます： - ユーザー詳細の照会インターフェースを呼び出して取得します。 - サイレントログインコードによるユーザー情報の取得インターフェースを呼び出して取得します。

リクエスト例

HTTP

GET /v1.0/notable/bases/xxxxx/sheets/データテーブル/fields?operatorId=xxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
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 {

    /**
     * <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.GetAllFieldsHeaders getAllFieldsHeaders = new com.aliyun.dingtalknotable_1_0.models.GetAllFieldsHeaders();
        getAllFieldsHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalknotable_1_0.models.GetAllFieldsRequest getAllFieldsRequest = new com.aliyun.dingtalknotable_1_0.models.GetAllFieldsRequest()
                .setOperatorId("xxxxx");
        try {
            client.getAllFieldsWithOptions("xxxxx", "データテーブル", getAllFieldsRequest, getAllFieldsHeaders, 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

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()
        get_all_fields_headers = dingtalknotable__1__0_models.GetAllFieldsHeaders()
        get_all_fields_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_all_fields_request = dingtalknotable__1__0_models.GetAllFieldsRequest(
            operator_id='xxxxx'
        )
        try:
            client.get_all_fields_with_options('xxxxx', 'データテーブル', get_all_fields_request, get_all_fields_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()
        get_all_fields_headers = dingtalknotable__1__0_models.GetAllFieldsHeaders()
        get_all_fields_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_all_fields_request = dingtalknotable__1__0_models.GetAllFieldsRequest(
            operator_id='xxxxx'
        )
        try:
            await client.get_all_fields_with_options_async('xxxxx', 'データテーブル', get_all_fields_request, get_all_fields_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\GetAllFieldsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vnotable_1_0\Models\GetAllFieldsRequest;
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();
        $getAllFieldsHeaders = new GetAllFieldsHeaders([]);
        $getAllFieldsHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $getAllFieldsRequest = new GetAllFieldsRequest([
            "operatorId" => "xxxxx"
        ]);
        try {
            $client->getAllFieldsWithOptions("xxxxx", "データテーブル", $getAllFieldsRequest, $getAllFieldsHeaders, 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));

// This file is auto-generated, don't edit it. Thanks.
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
  }

  getAllFieldsHeaders := &dingtalknotable_1_0.GetAllFieldsHeaders{}
  getAllFieldsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  getAllFieldsRequest := &dingtalknotable_1_0.GetAllFieldsRequest{
    OperatorId: tea.String("xxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetAllFieldsWithOptions(tea.String("xxxxx"), tea.String("データテーブル"), getAllFieldsRequest, getAllFieldsHeaders, &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 getAllFieldsHeaders = new dingtalknotable_1_0.GetAllFieldsHeaders({ });
    getAllFieldsHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let getAllFieldsRequest = new dingtalknotable_1_0.GetAllFieldsRequest({
      operatorId: 'xxxxx',
    });
    try {
      await client.getAllFieldsWithOptions('xxxxx', 'データテーブル', getAllFieldsRequest, getAllFieldsHeaders, 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));

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

        /// <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.GetAllFieldsHeaders getAllFieldsHeaders = new AlibabaCloud.SDK.Dingtalknotable_1_0.Models.GetAllFieldsHeaders();
            getAllFieldsHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalknotable_1_0.Models.GetAllFieldsRequest getAllFieldsRequest = new AlibabaCloud.SDK.Dingtalknotable_1_0.Models.GetAllFieldsRequest
            {
                OperatorId = "xxxxx",
            };
            try
            {
                client.GetAllFieldsWithOptions("xxxxx", "データテーブル", getAllFieldsRequest, getAllFieldsHeaders, 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	String	フィールド ID。
name	String	フィールド名。
type	String	フォールド種類。
property	`Map<String, Any>`	フィールド属性。具体的なフォーマットはフィールド属性を参照してください。
	Any	フィールド属性。

レスポンスボディの例

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

{
  "value" : [ {
    "id" : "xxxxx",
    "name" : "名前",
    "type" : "text",
    "property" : {
      "key" : "{}"
    }
  } ]
}

エラーコード

本インターフェースの呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントで解決策を検索してください。

HttpCode	エラーコード	エラーメッセージ	説明
500	internalError	The server encountered an internal error and was unable to complete your request. Please try again later.	システムエラー
500	unknownError	Unknown Error	不明なエラー
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	リソースが存在しません。データが存在しないか、完全に削除されています。
504	service.timeout	The server is busy and unable to complete your request. Please try again later.	リクエストタイムアウト。

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディの例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディの例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディの例

エラーコード