Хранение и запрос метаданных контейнера

Применимо к: Разработчик

Используйте метаданные, когда приложению требуются структурированные поля для файлов в контейнере SharePoint Embedded. Метаданные хранятся в виде столбцов в и в качестве значений fileStorageContainer полей в элементах диска контейнера. Приложение отвечает за создание схемы столбцов и управление ею для каждого экземпляра контейнера. Полный список свойств ресурсов контейнера см. в разделе Тип ресурса fileStorageContainer.

Разрешения и поддерживаемые вызывающие

Вызовите API метаданных с помощью маркера носителя только для приложения или делегированного маркера носителя. Используется FileStorageContainer.Selected для приложений и делегированных вызовов.

Владельцы и руководители контейнеров могут создавать, обновлять и удалять столбцы. Члены контейнера могут считывать и выводить список столбцов.

Выбор типов столбцов

Метаданные SharePoint Embedded поддерживают следующие свойства типа столбца: boolean, choice, currency, dateTime, hyperlinkOrPicture, number, personOrGroupи text. Он также поддерживает параметры столбцов, такие как indexed, isDeletable, isSealed, name, readOnlyи type.

Имена столбцов должны соответствовать правилам SharePoint. Не используйте имена, которые содержат !, начинаются с цифры или пунктуации, содержат пробелы, выглядят как ссылки на ячейки электронной таблицы, представляют локализованные значения true или false или используйте зарезервированные имена, такие как Author, Createdили Description.

Создание столбца

Создайте столбец в контейнере перед записью значений полей в файлах.

POST https://graph.microsoft.com/beta/storage/fileStorage/containers/{container-id}/columns
Content-Type: application/json

{
  "description": "test",
  "displayName": "Title",
  "enforceUniqueValues": false,
  "hidden": false,
  "indexed": false,
  "name": "Title",
  "text": {
    "allowMultipleLines": false,
    "appendChangesToExistingText": false,
    "linesForEditing": 0,
    "maxLength": 255
  }
}

Запрос на создание не поддерживает type, а текст maxLength должен быть меньше или равен 255.

Примечание.

С января 2026 г. API-интерфейсы столбцов контейнеров (список, создание, обновление, удаление столбцов) также доступны в конечной точке Microsoft Graph версии 1.0 . Вы можете заменить на /beta//v1.0/ в запросах столбца ниже. Бета-версия конечной точки остается доступной.

Управление столбцами

Используйте идентификатор столбца, возвращенный операцией создания или создания списка.

GET https://graph.microsoft.com/beta/storage/fileStorage/containers/{container-id}/columns
GET https://graph.microsoft.com/beta/storage/fileStorage/containers/{container-id}/columns/{column-id}
PATCH https://graph.microsoft.com/beta/storage/fileStorage/containers/{container-id}/columns/{column-id}
DELETE https://graph.microsoft.com/beta/storage/fileStorage/containers/{container-id}/columns/{column-id}

Исправление поддерживаемых свойств при изменении схемы. Можно обновить любое свойство столбца, кроме id свойства .

{
  "required": true,
  "hidden": false,
  "description": "This is my new column description"
}

Чтение и запись метаданных файла

Значения полей хранятся в полях элементов списка элемента диска. Чтение всех полей или выбор необходимых для пользовательского интерфейса.

GET https://graph.microsoft.com/beta/drives/{drive-id}/items/{item-id}/listitem/fields
GET https://graph.microsoft.com/beta/drives/{drive-id}/items/{item-id}/listitem/fields?$select=Name,Color

Исправление значений полей для обновления метаданных. Используйте null для очистки значения поля, если столбец допускает пустые значения.

PATCH https://graph.microsoft.com/beta/drives/{drive-id}/items/{item-id}/listitem/fields
Content-Type: application/json

{
  "Color": "Fuchsia",
  "Quantity": 934
}

{
  "Color": null
}

Запрос файлов по метаданным

Используйте параметры запроса OData для настраиваемых столбцов, если требуется структурированная фильтрация или упорядочение внутри диска контейнера.

GET https://graph.microsoft.com/beta/drives/{drive-id}/items?$orderby=listitem/fields/TestField asc&$filter=startswith(listitem/fields/TestField, '3')&$expand=listitem($expand=fields)

Используйте, $expand=listitem($expand=fields) когда результату требуются значения полей в ответе. Создавайте индексированные столбцы для фильтров с высокой кратностью, которые часто выполняет приложение.

Сведения о полнотекстовом поиске по контейнерам и пользовательским метаданным (с помощью суффикса OWSTEXT свойства) см. в разделе Поиск контейнеров и файлов. Используйте OData $filter для структурированных запросов на одном диске контейнера; используйте поиск запросов с бесплатным текстом во многих контейнерах.

Сохранение согласованности схемы

Создание обязательных столбцов во время подготовки контейнера. Сохраните ожидаемую версию схемы в данных приложения и выполните миграцию при появлении новых столбцов. Избегайте удаления столбцов, пока не узнаете, что рабочие процессы, запросы, экспорт или поиск не зависят от их значений.

Дальнейшие действия

  • Last updated on