Skip to main content
Call this API to get all tables of an AI Table.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/notable/bases/{baseId}/sheets
HTTP MethodGET
Supported app typeappType-Internal app
Permissions requiredpermission-Notable.Base.Read.All-Read permissions for AI Table apps

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Obtain it by calling the Get the access token of an internal app API.

Path parameter

NameTypeRequiredDescription
baseIdStringYesThe ID of the AI Table. For how to obtain it, see Data structure.

Query parameter

NameTypeRequiredDescription
operatorIdStringYesThe unionId of the operator. Obtain it in either of the following ways: - Call the Query user details API. - Call the Obtain the user ID of a user by using the silent login code API.

Request example

HTTP
GET /v1.0/notable/bases/qnYxxx/sheets?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>Initialize the account Client with a 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.GetAllSheetsHeaders getAllSheetsHeaders = new com.aliyun.dingtalknotable_1_0.models.GetAllSheetsHeaders();
        getAllSheetsHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalknotable_1_0.models.GetAllSheetsRequest getAllSheetsRequest = new com.aliyun.dingtalknotable_1_0.models.GetAllSheetsRequest()
                .setOperatorId("xxxxx");
        try {
            client.getAllSheetsWithOptions("qnYxxx", getAllSheetsRequest, getAllSheetsHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // The err contains the code and message attributes, which help with troubleshooting
            }

        } 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)) {
                // The err contains the code and message attributes, which help with troubleshooting
            }

        }        
    }
}
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:
        """
        Initialize the account Client with a 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()
        get_all_sheets_headers = dingtalknotable__1__0_models.GetAllSheetsHeaders()
        get_all_sheets_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_all_sheets_request = dingtalknotable__1__0_models.GetAllSheetsRequest(
            operator_id='xxxxx'
        )
        try:
            client.get_all_sheets_with_options('qnYxxx', get_all_sheets_request, get_all_sheets_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err contains the code and message attributes, which help with troubleshooting
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_all_sheets_headers = dingtalknotable__1__0_models.GetAllSheetsHeaders()
        get_all_sheets_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_all_sheets_request = dingtalknotable__1__0_models.GetAllSheetsRequest(
            operator_id='xxxxx'
        )
        try:
            await client.get_all_sheets_with_options_async('qnYxxx', get_all_sheets_request, get_all_sheets_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err contains the code and message attributes, which help with troubleshooting
                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\GetAllSheetsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vnotable_1_0\Models\GetAllSheetsRequest;
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();
        $getAllSheetsHeaders = new GetAllSheetsHeaders([]);
        $getAllSheetsHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $getAllSheetsRequest = new GetAllSheetsRequest([
            "operatorId" => "xxxxx"
        ]);
        try {
            $client->getAllSheetsWithOptions("qnYxxx", $getAllSheetsRequest, $getAllSheetsHeaders, 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)) {
                // The err contains the code and message attributes, which help with troubleshooting
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));
Go
// 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:
// 
// Initialize the account Client with a 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
  }

  getAllSheetsHeaders := &dingtalknotable_1_0.GetAllSheetsHeaders{}
  getAllSheetsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  getAllSheetsRequest := &dingtalknotable_1_0.GetAllSheetsRequest{
    OperatorId: tea.String("xxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetAllSheetsWithOptions(tea.String("qnYxxx"), getAllSheetsRequest, getAllSheetsHeaders, &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)) {
      // The err contains the code and message attributes, which help with troubleshooting
    }

  }
  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 a 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 getAllSheetsHeaders = new dingtalknotable_1_0.GetAllSheetsHeaders({ });
    getAllSheetsHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let getAllSheetsRequest = new dingtalknotable_1_0.GetAllSheetsRequest({
      operatorId: 'xxxxx',
    });
    try {
      await client.getAllSheetsWithOptions('qnYxxx', getAllSheetsRequest, getAllSheetsHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // The err contains the code and message attributes, which help with troubleshooting
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
C#
// 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>Initialize the account Client with a 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.GetAllSheetsHeaders getAllSheetsHeaders = new AlibabaCloud.SDK.Dingtalknotable_1_0.Models.GetAllSheetsHeaders();
            getAllSheetsHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalknotable_1_0.Models.GetAllSheetsRequest getAllSheetsRequest = new AlibabaCloud.SDK.Dingtalknotable_1_0.Models.GetAllSheetsRequest
            {
                OperatorId = "xxxxx",
            };
            try
            {
                client.GetAllSheetsWithOptions("qnYxxx", getAllSheetsRequest, getAllSheetsHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // The err contains the code and message attributes, which help with troubleshooting
                }
            }
            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))
                {
                    // The err contains the code and message attributes, which help with troubleshooting
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
valueArrayThe list of tables.
idStringThe table ID.
nameStringThe table name.

Response body example

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

{
  "value" : [ {
    "id" : "edKxxxx",
    "name" : "Table"
  } ]
}

Error codes

If an error occurs when you call this API, find a solution in the Global error codes documentation based on the error message.
HttpCodeError codeError messageDescription
500internalErrorThe server encountered an internal error and was unable to complete your request. Please try again later.System error.
500unknownErrorUnknown ErrorUnknown error.
400invalidRequest.inputArgs.invalid%sThe request parameter is invalid. See the error message for details.
400invalidRequest.document.stillInitializingThe document is under initialization. Please try again laterThe document is initializing. Try again later.
400invalidRequest.document.brokenThe document is broken and the server is unable to complete your request.The document is broken.
403forbidden.operationIllegal%sNo permissions.
403invalidRequest.document.typeIllegal%sUnsupported document type. Check the baseId.
404invalidRequest.document.notFoundFail 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.
404invalidRequest.resource.notFound%sThe resource does not exist. The data does not exist or has been permanently deleted.
504service.timeoutThe server is busy and unable to complete your request. Please try again later.Request timed out.