> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 列出多行记录

> 调用本接口可分页获取 AI 表格指定数据表中的多行记录,用于查询和遍历表格数据。

调用本接口，获取AI表格里指定数据表的多行记录。

## 请求

### 基本信息

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

### 请求头

| 名称                          | 类型     | 是否必填 | 描述                                                                                                         |
| --------------------------- | ------ | ---- | ---------------------------------------------------------------------------------------------------------- |
| x-acs-dingtalk-access-token | String | 是    | 调用该接口的访问凭证，可通过[获取企业内部应用的accessToken](/zh/open/development/obtain-the-access-token-of-an-internal-app)接口获取。 |

### 路径参数

| 名称            | 类型     | 是否必填 | 描述                                                                                                                                                             |
| ------------- | ------ | ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| baseId        | String | 是    | AI表格ID，获取方式请参考[数据结构](/zh/open/development/data-structure)。                                                                                                     |
| sheetIdOrName | String | 是    | 数据表ID或数据表名称。数据表ID可以通过以下两种方式获取：   - 调用[获取所有数据表](/zh/open/development/api-notable-getallsheets)接口获取。 - 调用[获取数据表](/zh/open/development/api-notable-getsheet)接口获取。 |

### 查询参数

| 名称         | 类型     | 是否必填 | 描述                                                                                                                                                                                       |
| ---------- | ------ | ---- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| operatorId | String | 是    | 操作人的unionId，可通过以下两种方式获取：   - 可以调用[查询用户详情](/zh/open/development/query-user-details)接口获取。 - 可以调用[通过免登码获取用户信息](/zh/open/development/obtain-the-userid-of-a-user-by-using-the-log-free)接口获取。 |

### 请求体

| 名称             | 类型              | 是否必填 | 描述                                                                                 |          |         |              |      |           |         |            |       |           |
| -------------- | --------------- | ---- | ---------------------------------------------------------------------------------- | -------- | ------- | ------------ | ---- | --------- | ------- | ---------- | ----- | --------- |
| filter         | Object          | 否    | 筛选条件，设置后将只返回满足条件的记录。                                                               |          |         |              |      |           |         |            |       |           |
| combination    | String          | 否    | 条件组合方式，可选值：   - **and**：同时满足所有条件 - **or**：满足任一条件                                   |          |         |              |      |           |         |            |       |           |
| conditions     | Array           | 是    | 条件。                                                                                |          |         |              |      |           |         |            |       |           |
| field          | String          | 是    | 字段ID或字段名。                                                                          |          |         |              |      |           |         |            |       |           |
| operator       | String          | 是    | 条件类型：equal                                                                         | notEqual | greater | greaterEqual | less | lessEqual | contain | notContain | empty | notEmpty。 |
| value          | Array of Any    | 否    | 条件值，参考[记录值格式](https://open.dingtalk.com/document/development/record-value-format)。 |          |         |              |      |           |         |            |       |           |
| maxResults     | Integer         | 否    | 每页获取的数据量，默认值为100，最小值为1，最大值为100。                                                    |          |         |              |      |           |         |            |       |           |
| nextToken      | String          | 否    | 上一次查询返回的游标，首次查询时不需要传。                                                              |          |         |              |      |           |         |            |       |           |
| fieldIdOrNames | Array of String | 否    | 可选。指定要返回的字段列表。 建议在字段较多时按需传入，可显著减少响应体积；单次最多 100 个。                                  |          |         |              |      |           |         |            |       |           |

### 请求示例

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
POST /v1.0/notable/bases/qnYxxx/sheets/数据表/records/list?operatorId=union_id HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

{
  "maxResults" : 100,
  "nextToken" : "tuvxxx",
  "filter": {
    "conditions": [{
      "field": '数字',
      "operator": 'equal',
      "value": [32],
    }],
  },
}
```

Java

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
// 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.ListRecordsHeaders listRecordsHeaders = new com.aliyun.dingtalknotable_1_0.models.ListRecordsHeaders();
        listRecordsHeaders.xAcsDingtalkAccessToken = "<your access token>";
        
        com.aliyun.dingtalknotable_1_0.models.ListRecordsRequest listRecordsRequest = new com.aliyun.dingtalknotable_1_0.models.ListRecordsRequest()
                .setOperatorId("union_id")
                .setMaxResults(100)
                .setNextToken("tuvxxx");
        try {
            client.listRecordsWithOptions("qnYxxx", "数据表", listRecordsRequest, listRecordsHeaders, 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

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
# -*- 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()
        list_records_headers = dingtalknotable__1__0_models.ListRecordsHeaders()
        list_records_headers.x_acs_dingtalk_access_token = '<your access token>'
        list_records_request = dingtalknotable__1__0_models.ListRecordsRequest(
            operator_id='union_id',
            max_results=100,
            next_token='tuvxxx'
        )
        try:
            client.list_records_with_options('qnYxxx', '数据表', list_records_request, list_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()
        list_records_headers = dingtalknotable__1__0_models.ListRecordsHeaders()
        list_records_headers.x_acs_dingtalk_access_token = '<your access token>'
        list_records_request = dingtalknotable__1__0_models.ListRecordsRequest(
            operator_id='union_id',
            max_results=100,
            next_token='tuvxxx'
        )
        try:
            await client.list_records_with_options_async('qnYxxx', '数据表', list_records_request, list_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

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
<?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\ListRecordsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vnotable_1_0\Models\ListRecordsRequest;
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();
        $listRecordsHeaders = new ListRecordsHeaders([]);
        $listRecordsHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $listRecordsRequest = new ListRecordsRequest([
            "operatorId" => "union_id",
            "maxResults" => 100,
            "nextToken" => "tuvxxx"
        ]);
        try {
            $client->listRecordsWithOptions("qnYxxx", "数据表", $listRecordsRequest, $listRecordsHeaders, 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));
```

Go

```go theme={"theme":{"light":"github-light","dark":"github-dark"}}
// 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
  }

  listRecordsHeaders := &dingtalknotable_1_0.ListRecordsHeaders{}
  listRecordsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  listRecordsRequest := &dingtalknotable_1_0.ListRecordsRequest{
    OperatorId: tea.String("union_id"),
    MaxResults: tea.Int32(100),
    NextToken: tea.String("tuvxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.ListRecordsWithOptions(tea.String("qnYxxx"), tea.String("数据表"), listRecordsRequest, listRecordsHeaders, &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

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
'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 listRecordsHeaders = new dingtalknotable_1_0.ListRecordsHeaders({ });
    listRecordsHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let listRecordsRequest = new dingtalknotable_1_0.ListRecordsRequest({
      operatorId: 'union_id',
      maxResults: 100,
      nextToken: 'tuvxxx',
    });
    try {
      await client.listRecordsWithOptions('qnYxxx', '数据表', listRecordsRequest, listRecordsHeaders, 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));
```

C#

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
// 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.ListRecordsHeaders listRecordsHeaders = new AlibabaCloud.SDK.Dingtalknotable_1_0.Models.ListRecordsHeaders();
            listRecordsHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalknotable_1_0.Models.ListRecordsRequest listRecordsRequest = new AlibabaCloud.SDK.Dingtalknotable_1_0.Models.ListRecordsRequest
            {
                OperatorId = "union_id",
                MaxResults = 100,
                NextToken = "tuvxxx",
            };
            try
            {
                client.ListRecordsWithOptions("qnYxxx", "数据表", listRecordsRequest, listRecordsHeaders, 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 属性，可帮助开发定位问题
                }
            }
        }

    }
}
```

## 响应

### 响应体

| 名称               | 类型                 | 描述             |
| ---------------- | ------------------ | -------------- |
| hasMore          | Boolean            | 是否有更多数据。       |
| nextToken        | String             | 分页游标。          |
| records          | Array              | 记录数据列表。        |
| id               | String             | 记录ID。          |
| fields           | `Map<String, Any>` | 字段值。           |
|                  | Any                | 字段值。           |
| createdBy        | Object             | 创建人。           |
| unionId          | String             | 创建人的unionId。   |
| lastModifiedBy   | Object             | 上次修改人。         |
| unionId          | String             | 上次修改人的unionId。 |
| createdTime      | Long               | 创建时间。          |
| lastModifiedTime | Long               | 上次修改时间。        |

### 响应体示例

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
Content-Type:application/json

{
  "hasMore" : true,
  "nextToken" : "nextToken",
  "records" : [ {
    "id" : "qkexxx",
    "fields" : {
      "数字" : 32
    },
    "createdBy" : {
      "unionId" : "union_id"
    },
    "lastModifiedBy" : {
      "unionId" : "union_id"
    },
    "createdTime" : 1728644688000,
    "lastModifiedTime" : 1728644688000
  } ]
}
```

### 错误码

若调用该接口报错，可根据错误信息在[全局错误码](/zh/open/development/server-api-error-codes-1)文档中查找解决方案。

| 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.                                                                            | 文档已损坏              |
| 400      | invalidRequest.dataNotReady               | The requested data is not available yet. Please try again later.                                                                                     | 被请求的资源或数据还未准备完毕    |
| 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                                                                                                                                                   | 资源不存在，数据不存在或被彻底删除  |
| 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.                                                                      | 请求超时               |