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

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

Prerequisites

  • A valid Aspose Cloud account.
  • An OAuth 2.0 access token (Bearer token).
  • The workbook must be stored in Aspose Cloud storage or a location you specify with folder/storageName.

REST API

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

Note: All Aspose.Cloud endpoints require HTTPS.

Authentication

To call the API you must include an Authorization header containing a valid Bearer token:

-H "Authorization: Bearer <access_token>"

You can obtain an access token by following the OAuth 2.0 token‑generation guide.

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"
}

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."
}

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