Refresh an Auto Filter in an Excel Worksheet

What does Refresh do?

Calling the endpoint re‑applies the current filter criteria after the worksheet data has changed (e.g., rows added or removed). The operation does not modify the filter definition; it simply updates the view and returns a status response.

REST API

This REST API refreshes an auto‑filter on an Excel worksheet (API version v3.0).

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

Security and Authentication

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

Response

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

HTTP Status Codes

Code	Meaning	Description
200	OK	Filter applied successfully; response contains operation 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.

Example error responses

// 400 Bad Request
{
    "Code": 400,
    "Message": "Invalid parameter: sheetName not found."
}

// 401 Unauthorized
{
    "Code": 401,
    "Message": "Authentication failed. JWT token is missing or invalid."
}

// 413 Payload Too Large
{
    "Code": 413,
    "Message": "The uploaded file exceeds the maximum allowed size."
}

// 500 Internal Server Error
{
    "Code": 500,
    "Message": "An unexpected error occurred on the server."
}

How to Use the PostWorksheetAutoFilterRefresh API with SDKs

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

Request

curl -v "https://api.aspose.cloud/v3.0/cells/Book1.xlsx/worksheets/Sheet1/autoFilter/refresh" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <your-jwt-token>"

Response

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

Use Aspose.Cells Cloud SDKs

Using an SDK is the best way to speed up development. An SDK handles low‑level details and lets you 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:

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