Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/insertRowsBefore |
| HTTP Method | POST |
| Supported app types | appType-Internal app appType-Third-party enterprise app |
| Required permissions | permission-Document.Workbook.Write-DingTalk Spreadsheet write permission |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential for calling this API. Obtain it as follows: - For an internal app, call the Get the access token of an internal app API. - For a third-party enterprise app, call the Get the access token of an organization authorized to a third-party 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 spreadsheet workbookId. Obtain it by calling the Get node or Create a Knowledge Base document API. |
| sheetId | String | Yes | The ID or title of the worksheet. - For an internal app, call the Get all worksheets API to get the ID, or pass the worksheet title. - For a third-party enterprise app, we recommend passing the worksheet title. See the figure below for the steps to view the worksheet title. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| operatorId | String | Yes | The unionId of the operator. Obtain it by calling the Query user details API. |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| row | Long | Yes | The cursor of the specified row, starting from 0. |
| rowCount | Long | Yes | The number of rows to insert. |
Request example
HTTPResponse
Response body
| Name | Type | Description |
|---|---|---|
| id | String | The worksheet ID. |
Response body example
Error codes
If an error occurs 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 | Invalid request parameter. See the error message for details. |
| 400 | invalidRequest.inputArgs.workbookIdIllegal | The workbookId is illegal. | The workbookId is invalid. |
| 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 action. |
| 403 | forbidden.acrossOrg | %s | Invalid request. Check whether the document being accessed belongs to the organization specified by the access token. |
| 403 | forbidden.operationIllegal | %s | Invalid request action. See the error message for details. |
| 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. | An internal server error occurred. Try again later. |