Add a custom criterion in an Excel worksheet – Aspose.Cells Cloud API
REST API
This REST API filters a list using a custom criteria.
PUT https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/autoFilter/custom
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 | Name of the Excel file. |
| sheetName | string | path | Name of the worksheet that contains the data to be filtered. |
| range | string | query | Cell range that the filter will be applied to (e.g., A1:B1). |
| fieldIndex | integer | query | Zero‑based index of the column on which the filter is applied. |
| operatorType1 | string | query | First comparison operator (e.g., LessOrEqual, Equal). |
| criteria1 | string | query | First filter value or expression. |
| isAnd | boolean | query | If true, combines the two criteria with AND; otherwise OR. |
| operatorType2 | string | query | Second comparison operator (optional). |
| criteria2 | string | query | Second filter value or expression (optional). |
| matchBlanks | boolean | query | When true, blanks are included in the filter results. |
| refresh | boolean | query | If true, forces the worksheet to refresh after applying the filter. |
| folder | string | query | Folder path in storage where the file is located. |
| storageName | string | query | Name of the storage service. |
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 PutWorksheetCustomFilter API with SDKs
PutWorksheetCustomFilter 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 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 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: