Get a Specific Document Property

This REST API reads a document property by name.

REST API

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

Request Parameters

Parameter Name	Type	Location	Description
name	string	path	The name of the Excel file.
propertyName	string	path	The name of the document property to retrieve.
folder	string	query	The folder containing the file (optional).
storageName	string	query	The storage name (optional).

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 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/documentproperties/author" \
  -X GET \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt token>"

Response

{
  "DocumentProperty": {
    "Name": "Author",
    "Value": "",
    "BuiltIn": "True",
    "link": {
      "Href": "/test.xlsx/documentproperties/Author",
      "Rel": "self",
      "Title": null,
      "Type": null
    }
  },
  "Code": 200,
  "Status": "OK"
}

Response Details

The JSON object returned by the API contains the following fields:

Field	Type	Description
DocumentProperty.Name	string	The name of the property (e.g., `Author`).
DocumentProperty.Value	string	The value of the property. May be empty if not set.
DocumentProperty.BuiltIn	boolean	Indicates whether the property is a built‑in Excel property.
DocumentProperty.link.Href	string	Relative URL to the property resource.
DocumentProperty.link.Rel	string	Relation type, usually `self`.
DocumentProperty.link.Title	string	Human‑readable title (may be `null`).
DocumentProperty.link.Type	string	MIME type of the linked resource (may be `null`).
Code	integer	HTTP status code returned by the service.
Status	string	Textual description of the status (e.g., `OK`).

Error Responses

HTTP Status	Code	Description
400	`InvalidParameter`	One or more request parameters are invalid.
401	`AuthenticationFailed`	Missing or invalid JWT token.
404	`PropertyNotFound`	The specified document property does not exist.
500	`InternalError`	An unexpected error occurred on the server.

A typical error body looks like:

{
  "Code": 404,
  "Status": "Property not found"
}

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 make calls to Aspose.Cells web services using various SDKs:

Terminology

Term	Definition
Document Property	A piece of metadata associated with an Excel workbook (e.g., Author, Title, Created).
Metadata	General term for data that describes other data; in this context it refers to document properties.
Custom Property	A user‑defined property not included in the built‑in set.

Frequently Asked Questions

Q: How can I retrieve the Author property of an Excel file stored in Aspose Cloud?
A: Send a GET request to https://api.aspose.cloud/v3.0/cells/{fileName}/documentproperties/author with a valid Bearer token. The response JSON includes DocumentProperty.Name = "Author" and its Value.

Q: What error is returned if the requested property does not exist?
A: The API returns HTTP 404 with a JSON body containing Code: 404 and Status: "Property not found".

Q: Do I need to specify storageName when the file is in the default storage?
A: No. The storageName query parameter is optional; omit it to use the default storage configured for your account.

Get metadata from Excel files