Add Date Filter to an Excel Worksheet

REST API

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

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

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 workbook name.
sheetName string Path The worksheet name.
range string Query Excel range to which the filter is applied (e.g., A1:B1).
fieldIndex integer Query Zero‑based index of the column to filter.
dateTimeGroupingType string Query Grouping type for the date/time filter. Allowed values are Day, Hour, Minute, Month, Second, Year. Values are case‑sensitive; the default is Day.
year integer Query Year component of the filter value.
month integer Query Month component of the filter value.
day integer Query Day component of the filter value.
hour integer Query Hour component of the filter value.
minute integer Query Minute component of the filter value.
second integer Query Second component of the filter value.
matchBlanks boolean Query Include blank cells (true or false).
refresh boolean Query Refresh the filter after applying (true or false).
folder string Query Folder path of the original workbook.
storageName string Query Name of the storage service.

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 PutWorksheetDateFilter API with SDKs

PutWorksheetDateFilter API Specification

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 make a call to the Cloud API with cURL.

Use Aspose.Cells Cloud SDKs

Using an SDK is the fastest way to develop. An SDK handles low‑level details so you can 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 call Aspose.Cells web services using various SDKs:

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