获取特定文档属性

此 REST API 可按名称读取文档属性。

REST API

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

请求参数

参数名称	类型	位置	描述
name	string	path	Excel 文件的名称。
propertyName	string	path	要检索的文档属性名称。
folder	string	query	包含该文件的文件夹（可选）。
storageName	string	query	存储空间名称（可选）。

OpenAPI 规范定义了一个公开可访问的编程接口，允许您直接通过网页浏览器执行 REST 交互。

您可使用 cURL 命令行工具 轻松访问 Aspose.Cells Web 服务。以下示例展示了如何使用 cURL 调用云 API。

请求

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

响应

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

响应详情

API 返回的 JSON 对象包含以下字段：

字段	类型	描述
DocumentProperty.Name	string	属性的名称（例如 `Author`）。
DocumentProperty.Value	string	属性的值；若未设置则可能为空字符串。
DocumentProperty.BuiltIn	boolean	表示该属性是否为 Excel 内置属性。
DocumentProperty.link.Href	string	属性资源的相对 URL。
DocumentProperty.link.Rel	string	关系类型，通常为 `self`。
DocumentProperty.link.Title	string	人类可读的标题（可能为 `null`）。
DocumentProperty.link.Type	string	链接资源的 MIME 类型（可能为 `null`）。
Code	integer	服务返回的 HTTP 状态码。
Status	string	状态的文本描述（例如 `OK`）。

错误响应

HTTP 状态码	错误代码	描述
400	`InvalidParameter`	一个或多个请求参数无效。
401	`AuthenticationFailed`	缺少或 JWT 令牌无效。
404	`PropertyNotFound`	指定的文档属性不存在。
500	`InternalError`	服务器发生意外错误。

典型错误响应体如下：

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

云 SDK 家族

使用 SDK 是加速开发的最佳方式。SDK 会处理底层细节，使您能专注于项目任务。请查看 GitHub 仓库，了解 Aspose.Cells Cloud SDK 的完整列表。

以下代码示例展示了如何使用多种 SDK 调用 Aspose.Cells Web 服务：

术语说明

术语	定义
Document Property（文档属性）	与 Excel 工作簿关联的元数据项（例如作者、标题、创建时间）。
Metadata（元数据）	泛指描述其他数据的数据；本文中特指文档属性。
Custom Property（自定义属性）	用户自定义的属性，不包含在内置属性集中。

常见问题

Q: 如何检索存储于 Aspose Cloud 的 Excel 文件的 Author 属性？
A: 向 https://api.aspose.cloud/v3.0/cells/{fileName}/documentproperties/author 发送 GET 请求，并附带有效的 Bearer 令牌。响应 JSON 中将包含 DocumentProperty.Name = "Author" 及其 Value。

Q: 若请求的属性不存在，会返回什么错误？
A: API 将返回 HTTP 404 状态，并附带 JSON 响应体：Code: 404 与 Status: "Property not found"。

Q: 若文件位于默认存储中，是否必须指定 storageName？
A: 否。storageName 查询参数为可选项；省略该参数即可使用账户默认配置的存储空间。

Aspose.Cells Cloud API — 更新（设置）文档属性从 Excel 文件获取元数据