Get Column Details – Aspose.Cells Cloud API Reference (v4.0)

This REST API reads worksheet column data by the column’s index.

Security and Authentication

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

REST API

GET https://api.aspose.cloud/v4.0/cells/{name}/worksheets/{sheetName}/cells/columns/{columnIndex}

Request parameters

Parameter Name Type Location Description Required
name string path The name of the workbook file. Yes
sheetName string path The name of the worksheet that contains the column. Yes
columnIndex integer path Zero‑based index of the column to retrieve. Yes
folder string query The folder path in storage where the workbook is located. (optional) No
storageName string query The name of the storage service (e.g., Aspose Cloud Storage). (optional) No

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

cURL Request

curl -X GET "https://api.aspose.cloud/v4.0/cells/test.xlsx/worksheets/Sheet1/cells/columns/0" \
     -H "accept: application/json" \
     -H "Authorization: Bearer <access_token>"

cURL Response

{
  "Column": {
    "GroupLevel": 0,
    "Index": 10,
    "IsHidden": false,
    "Width": 8.5,
    "Style": {
      "link": {
        "Href": "/style",
        "Rel": "self"
      }
    },
    "link": {
      "Href": "https://api.aspose.cloud/v4.0/cells/test.xlsx/worksheets/Sheet1/cells/columns/0",
      "Rel": "self"
    }
  },
  "Code": 200,
  "Status": "OK"
}

Response Schema

Field Type Description
Column.GroupLevel integer Outline level of the column (used for grouping).
Column.Index integer Zero‑based index of the column.
Column.IsHidden boolean Indicates whether the column is hidden.
Column.Width number Width of the column in characters.
Column.Style object Style information; contains a link to the style resource.
Column.link object Self‑link to the column resource.
Code integer HTTP status code of the response.
Status string Textual description of the status (e.g., OK).

Possible Errors

HTTP Status Code Message When it occurs
400 400 Bad Request Required parameter is missing or malformed.
401 401 Unauthorized Missing or invalid Authorization header.
404 404 Not Found The specified workbook, worksheet, or column does not exist.
500 500 Internal Server Error Unexpected server‑side problem.

Example – 404 Not Found

{
  "Code": 404,
  "Message": "Column index out of range."
}

Example – 401 Unauthorized

{
  "Code": 401,
  "Message": "Invalid or missing authentication token."
}

Cloud SDK Family

Using an SDK is the fastest way to develop against the API. SDKs handle low‑level details, allowing you to focus on your business logic. See 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 an Empty Column to an Excel Worksheet – Aspose.Cells Cloud API