> ## 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.

# Overview

> DingTalk Spreadsheet OpenAPI provides RESTful APIs for data read/write, worksheet management, cell lookup, and range locking, used for data sync, reporting, and office automation.

DingTalk Spreadsheet OpenAPI provides a set of RESTful interfaces that allow developers to operate DingTalk Spreadsheet documents programmatically. Use these APIs to automate data read/write operations, manage worksheets, look up cells, lock ranges, and more. They are suitable for scenarios such as data synchronization, report generation, and office automation.

## Open API overview

DingTalk Spreadsheet provides a rich set of open APIs. Choose the APIs that fit your business needs.

### Worksheet

| **API**                                                          | **Description**                                                                | **Version** |
| ---------------------------------------------------------------- | ------------------------------------------------------------------------------ | ----------- |
| [Create a worksheet](/open/development/create-a-worksheet)       | Create a new worksheet in a spreadsheet document.                              | New         |
| [Delete a worksheet](/open/development/delete-classic-workbooks) | Delete a worksheet from a spreadsheet.                                         | New         |
| [Get a worksheet](/open/development/obtain-worksheet-properties) | Get the properties of a worksheet.                                             | New         |
| [Update a worksheet](/open/development/update-worksheet)         | Modify the meta attributes of a specified worksheet in a DingTalk Spreadsheet. | New         |
| [Get all worksheets](/open/development/obtain-all-worksheets)    | Get information about all worksheets in a specified spreadsheet.               | New         |

### Rows and columns

| **API**                                                                                           | **Description**                                                                                                                                       | **Version** |
| ------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| [Delete Record](/open/development/delete-row)                                                     | Delete the specified records.                                                                                                                         | New         |
| [Delete Column](/open/development/delete-column)                                                  | Delete the specified columns.                                                                                                                         | New         |
| [Set row height automatically](/open/development/set-row-height-automatically)                    | Automatically adjust the height of a specified record in a DingTalk Spreadsheet based on the given font size, so that the content is fully displayed. | New         |
| [Batch set column widths](/open/development/api-setcolumnswidth)                                  | Set the widths of multiple consecutive columns starting from a specified column in a DingTalk Spreadsheet at once.                                    | New         |
| [Batch set row heights](/open/development/api-setrowsheight)                                      | Set the heights of multiple consecutive records starting from a specified record in a DingTalk Spreadsheet at once.                                   | New         |
| [Append records to a worksheet](/open/development/append-line)                                    | Append multiple records of data to the end of existing data in a worksheet.                                                                           | New         |
| [Hide or show records](/open/development/set-row-visibility)                                      | Hide or show records.                                                                                                                                 | New         |
| [Hide or show columns](/open/development/set-column-visibility)                                   | Hide or show columns.                                                                                                                                 | New         |
| [Insert records above a specified record](/open/development/insert-rows-before-rows)              | Insert multiple records above a specified record.                                                                                                     | New         |
| [Insert columns to the left of a specified column](/open/development/insert-column-before-column) | Insert multiple columns to the left of a specified column.                                                                                            | New         |

### Cell range

| **API**                                                                     | **Description**                                                                                                    | **Version** |
| --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ----------- |
| [Merge Cells](/open/development/merge-cells)                                | Merge multiple cells in a specified range of a DingTalk Spreadsheet into one.                                      | New         |
| [Insert a Dropdown List](/open/development/insert-drop-down-list)           | Set Dropdown List options for a specified cell range in a DingTalk Spreadsheet.                                    | New         |
| [Delete a Dropdown List](/open/development/delete-drop-down-list)           | Remove the Dropdown List configuration set for a specified cell range in a DingTalk Spreadsheet.                   | New         |
| [Get a cell range](/open/development/get-cell-properties)                   | Get cell properties.                                                                                               | New         |
| [Update a cell range](/open/development/update-cell-properties)             | Update cell information.                                                                                           | New         |
| [Find a cell in a worksheet](/open/development/find-the-next-eligible-cell) | Find the next cell that matches a given string based on the specified criteria.                                    | New         |
| [Find all matching cells](/open/development/find-all-matching-cells)        | Search for cells containing the target text in a specified worksheet and return a list of matching cell positions. | New         |
| [Clear data in a cell range](/open/development/clear-cell-data)             | Clear the data in a cell range, excluding formatting.                                                              | New         |
| [Clear all content in a cell range](/open/development/clear-all)            | Clear all content in a cell range, including formatting.                                                           | New         |

### Conditional Formatting

| **API**                                                                                       | **Description**                                                                          | **Version** |
| --------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ----------- |
| [Create a Conditional Formatting rule](/open/development/create-conditional-formatting-rules) | Create a Conditional Formatting rule in a specified worksheet of a DingTalk Spreadsheet. | New         |

### Filter

| **API**                                                             | **Description**                                                                                                                      | **Version** |
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
| [Create a Filter](/open/development/api-createfilter)               | Create a global Filter on a specified worksheet in a DingTalk Spreadsheet and define the Filter range.                               | New         |
| [Update a Filter](/open/development/api-updatefilter)               | Batch update Filters for multiple columns in a global Filter at once.                                                                | New         |
| [Delete a Filter](/open/development/api-deletefilter)               | Delete the global Filter on a specified worksheet, so that all records hidden by the Filter are displayed again.                     | New         |
| [Get a Filter](/open/development/api-getfilter)                     | Query the currently active global Filter information on a specified worksheet.                                                       | New         |
| [Sort within a Filter](/open/development/api-sortfilter)            | Sort data within the global Filter range by a specified column in ascending or descending order.                                     | New         |
| [Set Filter criteria](/open/development/api-setfiltercriteria)      | Set or update Filter criteria for a specified column in a global Filter.                                                             | New         |
| [Delete Filter criteria](/open/development/api-clearfiltercriteria) | Clear the Filter criteria of a specified column in a global Filter, so that the column no longer participates in Filter calculation. | New         |

### Filter View

| **API**                                                                      | **Description**                                                                                                                    | **Version** |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| [Create a Filter View](/open/development/api-createfilterview)               | Create a Filter View on a specified worksheet in a DingTalk Spreadsheet, and specify the View name and Filter range.               | New         |
| [Update a Filter View](/open/development/api-updatefilterview)               | Update the name, range, or Filter criteria of a specified Filter View.                                                             | New         |
| [Delete a Filter View](/open/development/api-deletefilterview)               | Delete a Filter View and all its Filter criteria on a specified worksheet.                                                         | New         |
| [Get the list of Filter Views](/open/development/api-getfilterviews)         | Get the list of all Filter Views on a specified worksheet.                                                                         | New         |
| [Set Filter View criteria](/open/development/api-setfilterviewcriteria)      | Set or update Filter criteria for a column in a specified Filter View.                                                             | New         |
| [Delete Filter View criteria](/open/development/api-clearfilterviewcriteria) | Clear the Filter criteria of a column in a specified Filter View, so that the column no longer participates in Filter calculation. | New         |

### Floating image

| **API**                                                           | **Description**                                                                         | **Version** |
| ----------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------- |
| [Create a floating image](/open/development/api-createfloatimage) | Get the list of all floating images in a specified worksheet of a DingTalk Spreadsheet. | New         |
| [Update a floating image](/open/development/api-updatefloatimage) | Update the properties of an existing floating image in a DingTalk Spreadsheet.          | New         |
| [Delete a floating image](/open/development/api-deletefloatimage) | Delete a floating image from a specified worksheet in a DingTalk Spreadsheet.           | New         |

## Glossary

### workbookId

The unique identifier of a spreadsheet file. It is the `nodeId` (`dentryUuid`) returned by the Knowledge Base API, and can also be obtained from the spreadsheet URL. Obtain it in one of the following ways:

* **Method 1**: Get it from the spreadsheet URL.

* **Method 2**: Get it from the document information.

* **Method 3**: Get it through the Knowledge Base API.

  Call the [Get a node](/open/development/get-knowledge-base-acquisition-node) or [Create a Knowledge Base document](/open/development/create-team-space-document) API. The returned `nodeId` (`dentryUuid`) is the `workbookId`.

### sheetId

The ID or name of a worksheet. Get it through the [Get all worksheets](/open/development/obtain-all-worksheets) API, or pass the worksheet title directly.

### rangeAddress

The cell range address, using A1 notation.

### operatorId

The `unionId` of the operator, used to identify the user performing the action and to verify permissions.
