Получение конкретного свойства документа

Этот 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 Specification определяет публично доступное программное интерфейсное описание и позволяет выполнять REST-взаимодействия непосредственно из веб-браузера.

Вы можете использовать утилиту командной строки cURL для простого доступа к веб-сервисам Aspose.Cells. Следующий пример демонстрирует, как выполнять вызовы облачного API с помощью cURL.

Запрос

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

Подробности ответа

JSON-объект, возвращаемый API, содержит следующие поля:

Поле	Тип	Описание
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 обрабатывает низкоуровневые детали, позволяя вам сосредоточиться на задачах вашего проекта. Полный список облачных SDK Aspose.Cells представлен в репозитории на GitHub.

Следующие примеры кода демонстрируют, как выполнять вызовы веб-сервисов Aspose.Cells с использованием различных SDK:

Терминология

Термин	Определение
Свойство документа	Часть метаданных, связанная с рабочей книгой Excel (например, Автор, Заголовок, Создано).
Метаданные	Общий термин для данных, описывающих другие данные; в данном контексте означает свойства документа.
Пользовательское свойство	Свойство, определённое пользователем и не входящее в набор встроенных свойств.

Часто задаваемые вопросы

В: Как получить свойство Автор файла Excel, хранящегося в Aspose Cloud?
О: Отправьте GET-запрос по адресу https://api.aspose.cloud/v3.0/cells/{fileName}/documentproperties/author с действующим Bearer-токеном. JSON-ответ будет содержать DocumentProperty.Name = "Author" и его Value.

В: Какая ошибка возвращается, если запрошенное свойство не существует?
О: API возвращает HTTP 404 с JSON-телом, содержащим Code: 404 и Status: "Property not found".

В: Нужно ли указывать storageName, если файл находится в хранилище по умолчанию?
О: Нет. Параметр запроса storageName является необязательным; пропустите его, чтобы использовать хранилище по умолчанию, настроенное для вашей учётной записи.

Получение метаданных из файлов Excel