Add a dynamic filter in an Excel worksheet using Aspose.Cells Cloud API

REST API

This REST API adds a dynamic filter to an Excel worksheet.

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

Security and Authentication

The Aspose.Cells Cloud APIs are secure and require JWT token-based authentication.

Request parameters

Parameter Name	Type	Location	Description
name	string	path	The name of the Excel file (e.g., `Book1.xlsx`).
sheetName	string	path	The name of the worksheet that contains the range to be filtered.
range	string	query	The cell range on which the filter is applied (e.g., `A1:B1`).
fieldIndex	integer	query	Zero‑based index of the column within the range to which the dynamic filter is applied.
dynamicFilterType	string	query	The type of dynamic filter. Supported values are listed below.
matchBlanks	boolean	query	Indicates whether blank cells should be included in the filter results.
refresh	boolean	query	If `true`, the filter is refreshed after being applied.
folder	string	query	The folder path in storage where the workbook is located.
storageName	string	query	The name of the Aspose Cloud storage to use.

Supported dynamicFilterType values

BelowAverage – rows whose value is below the column’s average.
AboveAverage – rows whose value is above the column’s average.
Tomorrow – rows with dates equal to tomorrow’s date.
Yesterday – rows with dates equal to yesterday’s date.
NextWeek – rows with dates falling in the next calendar week.
LastMonth – rows with dates from the previous month.
ThisYear – rows with dates occurring in the current year.

Response

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

Http Status Codes

Code	Meaning	Description
200	OK	Compression succeeded; response contains compressed file details.
400	Bad Request	Missing or invalid parameters (e.g., unsupported file type).
401	Unauthorized	Invalid or missing JWT token.
413	Payload Too Large	Uploaded file exceeds size limit.
500	Internal Server Error	Unexpected server error.

How to Use the PutWorksheetDynamicFilter API with SDKs

PutWorksheetDynamicFilter API Specification

The OpenAPI Specification defines a publicly accessible programming interface and lets you carry out 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 Cloud API with cURL. First obtain a JWT token by authenticating against the /connect/token endpoint and replace <jwt token> with the token value.

Request

curl -v "https://api.aspose.cloud/v3.0/cells/Book1.xlsx/worksheets/Sheet1/autoFilter/dynamicFilter?range=A1:B1&fieldIndex=0&dynamicFilterType=BelowAverage&matchBlanks=true" \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt token>" \
  -d '{}'   # PUT request has an empty JSON body

Response

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

Use Aspose.Cells Cloud SDKs

Using an SDK is the most efficient way to develop. An SDK abstracts low‑level details so you can focus on your project logic. Please check out 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:

Add a Filter in an Excel Worksheet AutoFitterOptions – Properties & Usage Guide | Aspose.Cells Cloud API