Delete a Filter from an Excel Worksheet – Aspose.Cells Cloud API

REST API

This REST API deletes an AutoFilter on an Excel worksheet.

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

Security and Authentication

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

Request parameters

Parameter Name Type Location Required? Description
name string Path Yes The workbook name.
sheetName string Path Yes The worksheet name.
range string Query No The cell range to which the filter applies (e.g., A1:C10).
fieldIndex integer Query Yes Zero‑based index of the column to which the filter is applied.
dateTimeGroupingType string Query No How date/time values are grouped: Day, Hour, Minute, Month, Second, or Year.
year integer Query No Year component for date grouping.
month integer Query No Month component for date grouping.
day integer Query No Day component for date grouping.
hour integer Query No Hour component for date grouping.
minute integer Query No Minute component for date grouping.
second integer Query No Second component for date grouping.
matchBlanks boolean Query No true / false – whether blank cells are included in the filter.
refresh boolean Query No true / false – whether to refresh the worksheet after deletion.
folder string Query No Original workbook folder.
storageName string Query No Storage name.

Response

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

Response 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 DeleteWorksheetFilter API with SDKs

DeleteWorksheetFilter 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 using cURL.

Use Aspose.Cells Cloud SDKs

Using an SDK is the most efficient way to accelerate development. An SDK handles low‑level details, allowing you to focus on your project tasks. Please check out the GitHub repository for a complete list of Aspose.Cells Cloud SDKs.

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