Group Rows in Excel Worksheet using Aspose.Cells Cloud API

This REST API groups rows on an Excel worksheet.

Prerequisites:

A valid OAuth 2.0 access token (Bearer JWT) must be supplied in the Authorization header.
The workbook must already exist in the specified folder of the chosen storageName (or the default storage) before the request is made.

PostGroupWorksheetRows API

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

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 workbook file.
sheetName	string	path	The name of the worksheet.
firstIndex	integer	query	Zero‑based index of the first row to be grouped.
lastIndex	integer	query	Zero‑based index of the last row to be grouped.
hide	boolean	query	Indicates whether the grouped rows should be hidden (`true` or `false`).
folder	string	query	Path to the folder that contains the workbook.
storageName	string	query	Name of the storage where the workbook is located.

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

Request

curl -v "https://api.aspose.cloud/v3.0/cells/test.xlsx/worksheets/Sheet1/cells/rows/group?firstIndex=1&lastIndex=2&hide=true" \
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>"

Response

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

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.

Typical error responses:

400 Bad Request – check that firstIndex and lastIndex are valid integers and that firstIndex ≤ lastIndex.
401 Unauthorized – verify that the Authorization header contains a current JWT token.
404 Not Found – ensure the workbook (name) and worksheet (sheetName) exist in the specified folder/storageName.

Cloud SDK Family

Using an SDK is the best way to speed up development. 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:

Retrieve a Single Row from an Excel Worksheet using Aspose.Cells Cloud API Ungroup rows on an Excel Worksheet