Get Vertical Page Breaks

This REST API retrieves vertical page breaks from a worksheet.

Rest Api

GET https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/verticalpagebreaks

Request Parameters

Parameter Name	Type	Location	Description	Required
`name`	string	path	The name of the Excel file.	Yes
`sheetName`	string	path	The name of the worksheet from which to read breaks.	Yes
`folder`	string	query	The folder in storage that contains the file.	No
`storageName`	string	query	The name of the Aspose Cloud storage to use.	No

The OpenAPI Specification defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.

You can use cURL to access Aspose.Cells web services easily. The following example shows how to make a call to the Cloud API with cURL.

Request

curl -v "https://api.aspose.cloud/v3.0/cells/sampleExcelPageBreaks.xlsx/worksheets/Sheet1/verticalpagebreaks" \
  -X GET \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt token>"

Response

{
  "VerticalPageBreaks": {
    "VerticalPageBreakList": [
      {
        "Column": 3,
        "EndRow": 1048575,
        "StartRow": 0
      }
    ],
    "link": {
      "Href": "https://api.aspose.cloud/v3.0/cells/sampleExcelPageBreaks.xlsx/worksheets/Sheet1/VerticalPageBreaks",
      "Rel": "self",
      "Title": null,
      "Type": null
    }
  },
  "Code": 200,
  "Status": "OK"
}

Response Details

Field	Type	Description
`VerticalPageBreakList`	array	A collection of vertical page‑break objects.
`Column`	int	The column index (zero‑based) where the break occurs.
`StartRow`	int	The first row of the break range (zero‑based).
`EndRow`	int	The last row of the break range (zero‑based, typically `1048575` for the last row).
`link.Href`	string	Self‑referencing URL for the resource (HTTPS).
`Code`	int	HTTP status code returned by the service.
`Status`	string	Textual description of the HTTP status.

Error Handling

HTTP Code	Meaning	Typical Cause
401	Unauthorized	Missing or invalid JWT token.
404	Not Found	Specified file or worksheet does not exist.
400	Bad Request	Invalid or malformed query parameters.
500	Internal Server Error	Unexpected server‑side condition.

Check the Code and Status fields in the JSON response for additional details.

Cloud SDK Family

Using an SDK is the fastest way to develop against Aspose.Cells Cloud. An SDK abstracts low‑level details so you can focus on your business logic. Please check 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:

Get Horizontal Page Breaks Add Horizontal Page Break