Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/notable/bases/{baseId}/sheets/{sheetIdOrName}/records/list |
| HTTP Method | POST |
| Supported app type | appType-Internal app |
| Required permissions | permission-Notable.Base.Read.All-AI Table app read permission |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential used to call this API. To obtain it, see Get the access token of an internal app. |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| baseId | String | Yes | The ID of the AI Table. To obtain it, see Data structure. |
| sheetIdOrName | String | Yes | The table ID or table name. You can obtain the table ID in either of the following ways: - Call the Get all tables API. - Call the Get a table API. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| operatorId | String | Yes | The unionId of the operator. You can obtain it in either of the following ways: - Call the Query user details API. - Call the Obtain user information using the silent login code API. |
Request body
| Name | Type | Required | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| filter | Object | No | The filter. When set, only records that match the conditions are returned. | |||||||||
| combination | String | No | The combination mode of the conditions. Valid values: - and: All conditions must be met. - or: Any condition can be met. | |||||||||
| conditions | Array | Yes | The conditions. | |||||||||
| field | String | Yes | The field ID or field name. | |||||||||
| operator | String | Yes | The condition operator: equal | notEqual | greater | greaterEqual | less | lessEqual | contain | notContain | empty | notEmpty. |
| value | Array of Any | No | The condition value. See Record value format. | |||||||||
| maxResults | Integer | No | The number of records to return per page. Default: 100. Minimum: 1. Maximum: 100. | |||||||||
| nextToken | String | No | The pagination cursor returned by the previous query. Leave it empty for the first query. | |||||||||
| fieldIdOrNames | Array of String | No | Optional. The list of fields to return. When there are many fields, pass only the required ones to significantly reduce the response size. Up to 100 fields per request. |
Request example
HTTPResponse
Response body
| Name | Type | Description |
|---|---|---|
| hasMore | Boolean | Indicates whether more data is available. |
| nextToken | String | The pagination cursor. |
| records | Array | The list of records. |
| id | String | The record ID. |
| fields | Map<String, Any> | The field values. |
| Any | The field value. | |
| createdBy | Object | The creator. |
| unionId | String | The unionId of the creator. |
| lastModifiedBy | Object | The last modifier. |
| unionId | String | The unionId of the last modifier. |
| createdTime | Long | The created time. |
| lastModifiedTime | Long | The last modified time. |
Response example
Error codes
If an error is returned when you call this API, look up the solution in the Global error codes document based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | invalidRequest.inputArgs.invalid | %s | The request parameter is invalid. See the error message for details. |
| 400 | invalidRequest.document.stillInitializing | The document is under initialization. Please try again later | The document is being initialized. Try again later. |
| 400 | invalidRequest.document.broken | The document is broken and the server is unable to complete your request. | The document is corrupted. |
| 400 | invalidRequest.dataNotReady | The requested data is not available yet. Please try again later. | The requested resource or data is not ready yet. |
| 403 | forbidden.operationIllegal | %s | No permission. |
| 403 | invalidRequest.document.typeIllegal | %s | Unsupported document type. Check the 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. | The document does not exist. |
| 404 | invalidRequest.resource.notFound | %s | The resource does not exist. The data does not exist or has been permanently deleted. |
| 500 | internalError | The server encountered an internal error and was unable to complete your request. Please try again later. | System error. |
| 500 | unknownError | Unknown Error | Unknown error. |
| 504 | service.timeout | The server is busy and unable to complete your request. Please try again later. | The request timed out. |