Add a filter in an Excel worksheet

This REST API adds a filter for a specific column on an Excel worksheet.

REST API

PUT http://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/autoFilter/filter

Request parameters

Parameter Name	Type	Location	Description
name	string	Path	The workbook name.
sheetName	string	Path	The worksheet name.
range	string	Query	The cell range that contains the filter (e.g., `A1:B1`).
fieldIndex	integer	Query	Zero‑based index of the column to which the filter is applied.
criteria	string	Query	The filter criteria (e.g., a value or expression).
matchBlanks	string	Query	Set to `true` to include blank cells in the filter; otherwise `false`.
refresh	string	Query	Set to `true` to refresh the filter after applying; otherwise `false`.
folder	string	Query	The folder where the original workbook is stored.
storageName	string	Query	The name of the storage service.

The OpenAPI Specification defines a publicly accessible programming interface and lets you perform REST interactions directly from a web browser.

You can use the cURL command‑line tool to access Aspose.Cells web services easily. The following example shows how to call the API with cURL.

Request

curl -v "http://api.aspose.cloud/v3.0/cells/Book1.xlsx/worksheets/Sheet1/autoFilter/filter?range=A1:B1&fieldIndex=0&criteria=Year" \
-X PUT \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>"

Response

{
  "Code": 200,
  "Status": "OK"
}

Cloud SDK Family

Using an SDK is the fastest way to develop. An SDK handles low‑level details so you can focus on your project. Please check the GitHub repository for a complete list of Aspose.Cells Cloud SDKs.

The following code examples demonstrate how to call Aspose.Cells web services using various SDKs:

Get an auto filter in an Excel worksheet Add a color filter in an Excel worksheet