Get Names from an Excel Workbook

This REST API retrieves the defined names from an Excel workbook.

REST API

GET https://api.aspose.cloud/v3.0/cells/{name}/names

The request parameters are:

Parameter Name	Type	Location	Description
name	string	path	The workbook file name.
folder	string	query	The folder that contains the workbook.
storageName	string	query	The name of the storage to use.

Authentication – The API requires an OAuth2/JWT bearer token. Obtain a token from https://api.aspose.cloud/connect/token using your client‑id and client‑secret, then include the header Authorization: Bearer <jwt token> in every request.

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. The example below demonstrates how to call the Aspose.Cells Cloud API with cURL.

Request

curl -v "https://api.aspose.cloud/v3.0/cells/Sample_Test_Book.xls/names" \
  -X GET \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt token>"

Response

{
  "Status": "string",
  "Names": {
    "link": {
      "Href": "string",
      "Rel": "string",
      "Title": "string",
      "Type": "string"
    },
    "Count": 0,
    "NameList": [
      {
        "link": {
          "Href": "string",
          "Rel": "string",
          "Title": "string",
          "Type": "string"
        }
      }
    ]
  }
}

Response fields

Status (string) – Operation status message.
Names.link (object) – Hyperlink information for the collection.
Names.Count (integer) – Total number of defined names returned.
Names.NameList (array) – List of name objects; each object contains a link object with navigation details.

Error handling – The service may return the following HTTP status codes:

Code	Meaning	Recommended action
401	Unauthorized	Verify that a valid JWT token is supplied.
404	Not Found	Check that the workbook name, folder, and storage are correct.
500	Internal Server Error	Retry later or contact Aspose support if the problem persists.

Cloud SDK Family

Using an SDK is the fastest way to develop. An SDK handles low‑level details, allowing you to focus on your project. 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:

Autofit Rows on an Excel Workbook Calculate All Formulas on an Excel Workbook