Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets |
| HTTP Method | GET |
| Supported app type | appType-Internal app |
| Required permissions | permission-Document.Workbook.Read-Spreadsheet read permission |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential used to call this API. Obtain it by calling the Get the access token of an internal app API. |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| workbookId | String | Yes | The spreadsheet file ID. The nodeId(dentryUuid) returned by the Knowledge Base API is the workbookId of the spreadsheet. Obtain it by calling the Get a node and Create a Knowledge Base document APIs. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| operatorId | String | Yes | The unionId of the operator. - Obtain the unionid parameter value by calling the Get user information by silent login code API. - Obtain the unionid parameter value by calling the Query user details API. If the operator does not have the required permissions, the API returns the error The operator has no permission. |
Request example
HTTPResponse
Response body
| Name | Type | Description |
|---|---|---|
| value | Array | The list of worksheet information. |
| id | String | The worksheet ID. |
| name | String | The worksheet name. |
Response body example
Error codes
If an error is returned when you call this API, refer to the Global error codes document to find a solution based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | invalidRequest.inputArgs.invalid | %s | Invalid request parameter. Check the error message. |
| 400 | invalidRequest.inputArgs.workbookIdIllegal | The workbookId is illegal. | Invalid workbookId. |
| 400 | invalidRequest.resource.notWorkbook | %s | Unsupported document type. Check the workbookId. |
| 403 | forbidden.accessDenied | The operator has no permission. | The current user does not have permission for this operation. |
| 403 | forbidden.acrossOrg | %s | Invalid request. Verify that the document belongs to the organization specified by the access token. |
| 403 | forbidden.operationIllegal | %s | Invalid request operation. Check the error message. |
| 403 | forbidden.document.sizeOverLimit | The document size is over limit and the server is unable to complete your request. Retry is unlikely to work unless the document size is decreased. | The spreadsheet content is too large. Reduce the spreadsheet content and try again. |
| 404 | invalidRequest.resource.notFound | %s | Request failed. The requested resource cannot be found. |
| 500 | serviceBusy | The server is busy and unable to complete your request. Please try again later. | The service is busy. Try again later. |
| 500 | internalError | The server encountered an internal error and was unable to complete your request. Please try again later. | Internal server error. Try again later. |