SharePoint Embedded

Microsoft SharePoint Embedded — это облачная система управления файлами и документами, подходящая для использования в любом приложении. SharePoint Embedded — это решение, доступное только для API, которое позволяет разработчикам приложений использовать возможности платформы хранения файлов Microsoft 365 и документов для любого приложения и подходит для предприятий, создающих бизнес-приложения и поставщики программного обеспечения, создавая мультитенантные приложения.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга	Class	Регионы
Copilot Studio	Стандарт	Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD)
Power Apps	Стандарт	Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Power Automate	Стандарт	Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)

Контакт
Имя	Microsoft
URL	https://learn.microsoft.com/en-us/sharepoint/dev/embedded/overview
Адрес электронной почты	spe-connector@service.microsoft.com

Метаданные соединителя
Publisher	Microsoft
Веб-сайт	https://learn.microsoft.com/en-us/sharepoint/dev/embedded/overview
Политика конфиденциальности	https://privacy.microsoft.com/
Категории	Содержимое и файлы

Начало работы

Прежде чем использовать соединитель SharePoint Embedded, необходимо создать приложение SharePoint Embedded. Дополнительные сведения и начало работы см. в документации по SharePoint Embedded .

Предоставление доступа к соединителю SharePoint Embedded

Чтобы соединитель SharePoint Embedded взаимодействовал с контейнерами хранилища файлов и содержимым в клиенте, необходимо создать applicationPermissionGrant приложение соединителя SharePoint Embedded в этом клиенте containerTypeRegistration . Это позволяет соединителю SharePoint Embedded обращаться к конкретному типу контейнера приложения в клиенте.

Предоставьте full разрешения для идентификатора e8e1b0bf-140f-4b8b-8e94-fbe8937fad04 приложения соединителя SharePoint Embedded для delegated вызовов с помощью API Microsoft Graph.

PUT /storage/fileStorage/containerTypeRegistrations/{containerTypeId}/applicationPermissionGrants/e8e1b0bf-140f-4b8b-8e94-fbe8937fad04
Content-Type: application/json
{
  "delegatedPermissions": ["full"],
  "applicationPermissions": ["none"]
}

Дополнительные сведения см. в справочной статье по API CreateStorageContainerTypeAppPermissionGrant .

Известные проблемы и ограничения

Максимальный поддерживаемый размер файла с задачей "Создание файла" составляет 10 МБ
Создание контейнеров недоступно в соединителе
Поддерживается только делегированная проверка подлинности

Действия

Активация контейнера	Активация контейнера
Возврат файла	Эта операция проверяет файл, который был извлечен в контейнере SharePoint Embedded.
Возьмите контейнер	Возьмите контейнер
Восстановление корзины контейнера	Восстановление корзины контейнера
Восстановление переработанных элементов	Эта операция восстанавливает один или несколько переработанных элементов из корзины контейнера SharePoint Embedded.
Вывод списка версий файлов	Эта операция содержит предыдущие версии файла в контейнере SharePoint Embedded.
Вывод списка переработанных контейнеров	Вывод списка переработанных контейнеров
Вывод списка полей файла	Эта операция получает поля элемента списка (метаданные), связанные с файлом в контейнере SharePoint Embedded.
Вывод списка разрешений контейнера	Вывод списка разрешений для контейнера
Вывод списка столбцов контейнеров	Список столбцов, определяющих схему контейнера
Извлечь файл	Эта операция извлекает файл в контейнере SharePoint Embedded, который предотвращает редактирование документа другими пользователями.
Настройка полей файла	Эта операция обновляет поля элементов списка (метаданные), связанные с файлом в контейнере SharePoint Embedded. Используйте значения NULL для очистки значений полей.
Обновление контейнера	Обновление контейнера
Обновление настраиваемых свойств контейнера	Обновление настраиваемых свойств контейнера
Обновление разрешения контейнера	Обновление разрешения для контейнера
Обновление содержимого файла	Эта операция обновляет содержимое файла.
Отменить извлечение	Эта операция удаляет извлечение файла в контейнере SharePoint Embedded.
Отправка приглашения на общий доступ	Эта операция отправляет приглашение на общий доступ к файлу в контейнере SharePoint Embedded.
Переименовать файл	Эта операция переименовывает файл в контейнере SharePoint Embedded.
Перечисление элементов в контейнере	Эта операция получает список файлов и вложенных папок в контейнере.
Получение версии файла	Эта операция получает определенную версию файла в контейнере SharePoint Embedded.
Получение настраиваемых свойств контейнера	Получение настраиваемых свойств контейнера
Получение разрешения на общий доступ	Эта операция получает определенное разрешение на общий доступ для файла в контейнере SharePoint Embedded.
Получение свойств файла	Эта операция получает свойства файла в контейнере SharePoint Embedded.
Получение столбца контейнера	Получение столбца контейнера
Получение эскиза	Эта операция получает определенный эскиз файла в контейнере SharePoint Embedded.
Получить содержимое файла	Эта операция получает содержимое файла.
Разрешения для общего доступа к элементам списка	Эта операция содержит разрешения на общий доступ для элемента в контейнере SharePoint Embedded.
Создание предварительной версии файла	Эта операция создает предварительную версию файла в контейнере SharePoint Embedded.
Создание разрешения контейнера	Создание разрешения для контейнера
Создание ссылки совместного доступа	Эта операция создает ссылку для общего доступа к файлу в контейнере SharePoint Embedded.
Создание столбца контейнера	Создание столбца, определяющего схему контейнера
Создать папку	Эта операция создает новую папку в контейнере SharePoint Embedded на корневом уровне или в другой папке.
Создать файл	Эта операция создает файл и возвращает метаданные driveItem.
Список контейнеров	Список контейнеров
Список переработанных элементов	Эта операция содержит элементы в корзине контейнера SharePoint Embedded.
Список эскизов	Эта операция содержит доступные эскизы для файла в контейнере SharePoint Embedded.
Удаление версии файла	Эта операция удаляет определенную версию файла в контейнере SharePoint Embedded.
Удаление корзины контейнера	Окончательное удаление корзины контейнера
Удаление переработанных элементов	Эта операция окончательно удаляет один или несколько переработанных элементов из корзины контейнера SharePoint Embedded.
Удаление разрешения контейнера	Удаление разрешения для контейнера
Удаление разрешения на общий доступ	Эта операция удаляет определенное разрешение общего доступа для файла в контейнере SharePoint Embedded.
Удаление столбца контейнера	Удаление столбца, определяющего схему контейнера
Удалить контейнер	Удаление контейнера
Удалить файл	Эта операция удаляет файл в контейнере SharePoint Embedded.

Активация контейнера

Идентификатор операции:: ActivateContainer

Активация контейнера

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Идентификатор контейнера

Возврат файла

Идентификатор операции:: CheckInFile

Эта операция проверяет файл, который был извлечен в контейнере SharePoint Embedded.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор файла	file-id	True	string	Уникальный идентификатор файла
Комментарий	comment		string	Комментарий для регистрации, связанный с версией
Вход как	checkInAs		string	Состояние документа после регистрации (опубликованного или дополнительного)

Возьмите контейнер

Идентификатор операции:: GetContainer

Возьмите контейнер

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Идентификатор контейнера

Возвращаемое значение

Тело: FileStorageContainer

Восстановление корзины контейнера

Идентификатор операции:: RestoreContainer

Восстановление корзины контейнера

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Идентификатор контейнера

Возвращаемое значение

Тело: FileStorageContainer

Восстановление переработанных элементов

Идентификатор операции:: RestoreRecycledFiles

Эта операция восстанавливает один или несколько переработанных элементов из корзины контейнера SharePoint Embedded.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификаторы элементов	ids	True	array of string	Массив идентификаторов переработанных элементов для восстановления

Возвращаемое значение

Имя	Путь	Тип	Описание
value	value	array of object
Идентификатор элемента	value.id	string	Идентификатор восстановленного элемента

Вывод списка версий файлов

Идентификатор операции:: ListFileVersions

Эта операция содержит предыдущие версии файла в контейнере SharePoint Embedded.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор файла	file-id	True	string	Уникальный идентификатор файла

Возвращаемое значение

Представляет коллекцию версий файлов

Тело: FileVersions

Вывод списка переработанных контейнеров

Идентификатор операции:: ListRecycledContainers

Вывод списка переработанных контейнеров

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор типа контейнера	containerType	True	string	Вывод списка переработанных контейнеров указанного типа контейнера

Возвращаемое значение

Тело: FileStorageContainer.List

Вывод списка полей файла

Идентификатор операции:: ListFileFields

Эта операция получает поля элемента списка (метаданные), связанные с файлом в контейнере SharePoint Embedded.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор файла	file-id	True	string	Уникальный идентификатор файла

Возвращаемое значение

Имя	Путь	Тип	Описание
Etag	@odata.etag	string	Значение ETag для полей

Вывод списка разрешений контейнера

Идентификатор операции:: ListPermissions

Вывод списка разрешений для контейнера

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Идентификатор контейнера

Возвращаемое значение

Тело: FileStorageContainer.Permissions.List

Вывод списка столбцов контейнеров

Идентификатор операции:: ListContainerColumns

Список столбцов, определяющих схему контейнера

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Идентификатор контейнера
Filter	$filter		string	Фильтр для применения к результатам

Возвращаемое значение

Тело: FileStorageContainer.Columns.List

Извлечь файл

Идентификатор операции:: CheckOutFile

Эта операция извлекает файл в контейнере SharePoint Embedded, который предотвращает редактирование документа другими пользователями.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор файла	file-id	True	string	Уникальный идентификатор файла

Настройка полей файла

Идентификатор операции:: UpdateFileFields

Эта операция обновляет поля элементов списка (метаданные), связанные с файлом в контейнере SharePoint Embedded. Используйте значения NULL для очистки значений полей.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор файла	file-id	True	string	Уникальный идентификатор файла
			object

Возвращаемое значение

Имя	Путь	Тип	Описание
Etag	@odata.etag	string	Значение ETag для полей

Обновление контейнера

Идентификатор операции:: UpdateContainer

Обновление контейнера

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Идентификатор контейнера
Description	description		string	Описание контейнера
Отображаемое имя	displayName		string	имя контейнера;
OCR включено	isOcrEnabled		boolean	Включена ли функция OCR (оптическое распознавание символов) для контейнера
Ограничение дополнительных версий элемента	itemMinorVersionLimit		integer	Максимальное количество дополнительных версий для хранения элементов в контейнере
Включено управление версиями элементов	isItemVersioningEnabled		boolean	Включена ли версия элементов для контейнера

Возвращаемое значение

Тело: FileStorageContainer

Обновление настраиваемых свойств контейнера

Идентификатор операции:: UpdateContainerCustomProperties

Обновление настраиваемых свойств контейнера

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Идентификатор контейнера
			object

Возвращаемое значение

Тело: FileStorageContainer.CustomProperties

Обновление разрешения контейнера

Идентификатор операции:: UpdatePermission

Обновление разрешения для контейнера

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Идентификатор контейнера
Идентификатор разрешения	permission-id	True	string	Идентификатор разрешения
Роли разрешений	roles	True	array of string	Роли, предоставляемые пользователю

Возвращаемое значение

Тело: FileStorageContainer.Permission

Обновление содержимого файла

Идентификатор операции:: UpdateFileContent

Эта операция обновляет содержимое файла.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор файла	file-id	True	string	Уникальный идентификатор файла
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Содержимое файла (Base64)	body	True	byte	Содержимое файла в кодировке Base64

Возвращаемое значение

Содержимое файла

Содержимое файла: binary

Отменить извлечение

Идентификатор операции:: DiscardCheckOut

Эта операция удаляет извлечение файла в контейнере SharePoint Embedded.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор файла	file-id	True	string	Уникальный идентификатор файла

Отправка приглашения на общий доступ

Идентификатор операции:: SendSharingInvitation

Эта операция отправляет приглашение на общий доступ к файлу в контейнере SharePoint Embedded.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор файла	file-id	True	string	Уникальный идентификатор файла
Требовать вход	requireSignIn	True	boolean	Указывает, требуется ли получатель приглашения для входа в систему для просмотра общего элемента
Роли	roles	True	array of string	Разрешения, предоставленные получателям приглашения на общий доступ
Адрес электронной почты	email		string	Адрес электронной почты получателя
Псевдоним	alias		string	Псевдоним получателя (в случае получателя Microsoft 365)
Код объекта	objectId		string	Уникальный идентификатор получателя в Azure Active Directory
Message	message	True	string	Пользовательское сообщение, отправленное в рамках приглашения на общий доступ
Отправить приглашение	sendInvitation	True	boolean	Если значение true, ссылка на общий доступ отправляется получателям. Если значение false, создается разрешение, но не отправляется сообщение приглашения.

Возвращаемое значение

Представляет список разрешений для файла или папки

Тело: SharingPermissionsList

Переименовать файл

Идентификатор операции:: RenameFile

Эта операция переименовывает файл в контейнере SharePoint Embedded.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор файла	file-id	True	string	Уникальный идентификатор файла
Имя	name		string	Новое имя файла

Возвращаемое значение

Метаданные элемента диска

Тело: DriveItem

Перечисление элементов в контейнере

Идентификатор операции:: ListContainerFiles

Эта операция получает список файлов и вложенных папок в контейнере.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор родительской папки	parentId	True	string	Идентификатор родительской папки для перечисления элементов. Используйте "root", чтобы получить элементы из корневого уровня контейнера или указать определенный идентификатор папки, чтобы получить элементы из этой папки.
Filter	$filter		string	Критерии фильтрации результатов (формат OData): parentReference/id eq '{folderId}}' AND contains(listitem/fields/FileLeafRef, {{user_name_string}})
Выберите	$select		string	Свойства для включения в результаты (разделенные запятыми)
Развернуть	$expand		string	Связанные ресурсы для расширения ответа
Верх	$top		integer	Количество возвращаемых результатов
Заказ по	$orderby		string	Поля и направление сортировки результатов по

Возвращаемое значение

Представляет страницу элементов диска.

Тело: DriveItemCollectionPage

Получение версии файла

Идентификатор операции:: GetFileVersion

Эта операция получает определенную версию файла в контейнере SharePoint Embedded.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор файла	file-id	True	string	Уникальный идентификатор файла
Идентификатор версии	version-id	True	string	Уникальный идентификатор версии

Возвращаемое значение

Представляет версию файла

Тело: FileVersion

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

Идентификатор операции:: GetContainerCustomProperties

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Идентификатор контейнера

Возвращаемое значение

Тело: FileStorageContainer.CustomProperties

Получение разрешения на общий доступ

Идентификатор операции:: GetSharingPermission

Эта операция получает определенное разрешение на общий доступ для файла в контейнере SharePoint Embedded.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор файла	file-id	True	string	Уникальный идентификатор файла
Идентификатор разрешения	permission-id	True	string	Уникальный идентификатор разрешения

Возвращаемое значение

Представляет разрешение для файла или папки

Тело: SharingPermissionResponse

Получение свойств файла

Идентификатор операции:: GetFileProperties

Эта операция получает свойства файла в контейнере SharePoint Embedded.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор файла	file-id	True	string	Уникальный идентификатор файла

Возвращаемое значение

Метаданные элемента диска

Тело: DriveItem

Получение столбца контейнера

Идентификатор операции:: GetContainerColumn

Получение столбца контейнера

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Идентификатор контейнера
Идентификатор столбца	column-id	True	string	Идентификатор столбца

Возвращаемое значение

Тело: FileStorageContainer.Column

Получение эскиза

Идентификатор операции:: GetFileThumbnail

Эта операция получает определенный эскиз файла в контейнере SharePoint Embedded.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор файла	file-id	True	string	Уникальный идентификатор файла
Идентификатор эскиза	thumbnail-id	True	string	Уникальный идентификатор набора эскизов
Size	size	True	string	Размер эскиза для получения

Возвращаемое значение

Представляет один эскиз

Тело: Thumbnail

Получить содержимое файла

Идентификатор операции:: GetFileContent

Эта операция получает содержимое файла.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор файла	file-id	True	string	Уникальный идентификатор файла
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера

Разрешения для общего доступа к элементам списка

Идентификатор операции:: ListSharingPermissions

Эта операция содержит разрешения на общий доступ для элемента в контейнере SharePoint Embedded.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор элемента	file-id	True	string	Уникальный идентификатор элемента

Возвращаемое значение

Представляет список разрешений для файла или папки

Тело: SharingPermissionsList

Создание предварительной версии файла

Идентификатор операции:: CreateFilePreview

Эта операция создает предварительную версию файла в контейнере SharePoint Embedded.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор файла	file-id	True	string	Уникальный идентификатор файла
Страница	page		integer	Указывает номер страницы документа для предварительного просмотра
Уровень масштабирования	zoom		float	Задает уровень масштабирования предварительного просмотра документа (например, 0.5, 1.0, 1.5)

Возвращаемое значение

Имя	Путь	Тип	Описание
Получение URL-адреса	getUrl	string	URL-адрес, который можно использовать для получения предварительной версии с помощью запроса GET
Параметры post	postParameters	string	Параметры, которые можно использовать со свойством postUrl для получения предварительного просмотра с помощью запроса POST
URL-адрес публикации	postUrl	string	URL-адрес, который можно использовать для получения предварительной версии с помощью запроса POST

Создание разрешения контейнера

Идентификатор операции:: CreatePermission

Создание разрешения для контейнера

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Идентификатор контейнера
Роли разрешений	roles	True	array of string	Роли, предоставляемые пользователю
Основное имя пользователя	userPrincipalName	True	string	Имя участника-пользователя удостоверения

Возвращаемое значение

Тело: FileStorageContainer.Permission

Создание ссылки совместного доступа

Идентификатор операции:: CreateSharingLink

Эта операция создает ссылку для общего доступа к файлу в контейнере SharePoint Embedded.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор файла	file-id	True	string	Уникальный идентификатор файла
Тип ссылки	type	True	string	Тип создаваемой ссылки общего доступа.
Область ссылки	scope		string	Область ссылки на общий доступ
Дата окончания срока действия	expirationDateTime		date-time	Дата и время истечения срока действия ссылки (гггг-ММ-ддTHH:мм:ssZ)

Возвращаемое значение

Представляет ссылку для общего доступа к файлу или папке

Тело: SharingLink

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

Идентификатор операции:: CreateContainerColumn

Создание столбца, определяющего схему контейнера

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Идентификатор контейнера
			object

Возвращаемое значение

Тело: FileStorageContainer.Column

Создать папку

Идентификатор операции:: CreateFolder

Эта операция создает новую папку в контейнере SharePoint Embedded на корневом уровне или в другой папке.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор родительской папки	parent-id	True	string	Идентификатор родительской папки, в которой будет создана новая папка. Используйте "root", чтобы создать папку на корневом уровне контейнера или указать определенный идентификатор папки для создания вложенной папки.
Имя папки	name	True	string	Имя создаваемой папки
Поведение конфликтов	@microsoft.graph.conflictBehavior		string	Что делать, если папка с тем же именем уже существует

Возвращаемое значение

Метаданные элемента диска

Тело: DriveItem

Создать файл

Идентификатор операции:: CreateFile

Эта операция создает файл и возвращает метаданные driveItem.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Родительский идентификатор	parent-id	True	string	Идентификатор элемента диска родительской папки или корневой папки
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Имя файла	file-name	True	string	Имя файла
Содержимое файла (Base64)	body	True	byte	Содержимое файла в кодировке Base64

Возвращаемое значение

Метаданные элемента диска

Тело: DriveItem

Список контейнеров

Идентификатор операции:: ListContainers

Список контейнеров

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор типа контейнера	containerType	True	string	Список контейнеров указанного типа контейнера

Возвращаемое значение

Тело: FileStorageContainer.List

Список переработанных элементов

Идентификатор операции:: ListRecycledFiles

Эта операция содержит элементы в корзине контейнера SharePoint Embedded.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера

Возвращаемое значение

Коллекция элементов в корзине

Тело: RecycleBinItemCollection

Список эскизов

Идентификатор операции:: ListFileThumbnails

Эта операция содержит доступные эскизы для файла в контейнере SharePoint Embedded.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор файла	file-id	True	string	Уникальный идентификатор файла

Возвращаемое значение

Представляет коллекцию наборов эскизов

Тело: ThumbnailSets

Удаление версии файла

Идентификатор операции:: DeleteFileVersion

Эта операция удаляет определенную версию файла в контейнере SharePoint Embedded.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор файла	file-id	True	string	Уникальный идентификатор файла
Идентификатор версии	version-id	True	string	Уникальный идентификатор версии для удаления

Удаление корзины контейнера

Идентификатор операции:: DeleteContainer

Окончательное удаление корзины контейнера

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Идентификатор контейнера

Удаление переработанных элементов

Идентификатор операции:: PermanentDeleteRecycledFiles

Эта операция окончательно удаляет один или несколько переработанных элементов из корзины контейнера SharePoint Embedded.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификаторы элементов	ids	True	array of string	Массив идентификаторов переработанных элементов для окончательного удаления

Удаление разрешения контейнера

Идентификатор операции:: DeletePermission

Удаление разрешения для контейнера

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Идентификатор контейнера
Идентификатор разрешения	permission-id	True	string	Идентификатор разрешения

Удаление разрешения на общий доступ

Идентификатор операции:: DeleteSharingPermission

Эта операция удаляет определенное разрешение общего доступа для файла в контейнере SharePoint Embedded.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор файла	file-id	True	string	Уникальный идентификатор файла
Идентификатор разрешения	permission-id	True	string	Уникальный идентификатор разрешения на удаление

Удаление столбца контейнера

Идентификатор операции:: DeleteContainerColumn

Удаление столбца, определяющего схему контейнера

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Идентификатор контейнера
Идентификатор столбца	column-id	True	string	Идентификатор столбца

Удалить контейнер

Идентификатор операции:: RecycleContainer

Удаление контейнера

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Идентификатор контейнера

Удалить файл

Идентификатор операции:: DeleteFile

Эта операция удаляет файл в контейнере SharePoint Embedded.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Уникальный идентификатор контейнера
Идентификатор файла	file-id	True	string	Уникальный идентификатор файла

Триггеры

Мониторинг изменений элементов в контейнере

Триггер при добавлении, изменении или удалении элементов в контейнере SharePoint Embedded

Мониторинг изменений элементов в контейнере

Идентификатор операции:: GetChangesContainer

Триггер при добавлении, изменении или удалении элементов в контейнере SharePoint Embedded

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	container-id	True	string	Идентификатор контейнера для мониторинга
Интервал опроса (секунды)	pollingInterval		integer	Как часто проверять наличие изменений (60–3600 секунд, по умолчанию: 300)

Возвращаемое значение

Имя	Путь	Тип	Описание
value	value	array of DriveItem	Список измененных элементов
@odata.deltaLink	@odata.deltaLink	string	Разностная ссылка для следующего запроса опроса
@odata.context	@odata.context	string	@odata.context

Определения

FileStorageContainer

Имя	Путь	Тип	Описание
Идентификатор контейнера	id	string	Идентификатор контейнера
Идентификатор типа контейнера	containerTypeId	string	Идентификатор типа контейнера, к которому принадлежит этот контейнер
Description	description	string	Описание контейнера
Отображаемое имя	displayName	string	имя контейнера;
Время создания	createdDateTime	date-time	Дата и время создания контейнера
customProperties	customProperties	FileStorageContainer.CustomProperties
permissions	permissions	FileStorageContainer.Permissions
статус	status	string	Состояние контейнера

FileStorageContainer.List

Имя	Путь	Тип	Описание
value	value	array of FileStorageContainer

FileStorageContainer.Permissions

Имя	Путь	Тип	Описание
Товары		FileStorageContainer.Permission

FileStorageContainer.Permission

Имя	Путь	Тип	Описание
Идентификатор разрешения	id	string	Идентификатор разрешения
Роли разрешений	roles	FileStorageContainer.Permission.Roles	Роли, предоставляемые пользователю
Отображаемое имя	grantedToV2.user.displayName	string	Отображаемое имя удостоверения
Адрес электронной почты	grantedToV2.user.email	string	Электронная почта удостоверения
Основное имя пользователя	grantedToV2.user.userPrincipalName	string	Имя участника-пользователя удостоверения

FileStorageContainer.Permission.Role

Роли, предоставляемые пользователю

Имя	Путь	Тип	Описание
Товары		string

FileStorageContainer.Permissions.List

Имя	Путь	Тип	Описание
value	value	FileStorageContainer.Permissions

FileStorageContainer.CustomProperties

FileStorageContainer.Column

Имя	Путь	Тип	Описание
Идентификатор столбца	id	string	Уникальный идентификатор столбца
Имя столбца	name	string	Отображаемое имя столбца
Description	description	string	Описание столбца
Принудительное применение уникальных значений	enforceUniqueValues	boolean	Должен ли значения столбца быть уникальными
Скрытый	hidden	boolean	Отображается ли столбец в пользовательском интерфейсе
Indexed	indexed	boolean	Индексируется ли столбец
Обязательно	required	boolean	Требуется ли столбец
Только для чтения	readOnly	boolean	Можно ли изменить значения столбца
Группа столбцов	columnGroup	string	Группа, к которой принадлежит этот столбец
Отображаемое имя	displayName	string	Отображаемое имя столбца
Является делетируемым	isDeletable	boolean	Указывает, можно ли удалить этот столбец.
Переупорядочение	isReorderable	boolean	Указывает, можно ли изменить порядок этого столбца.
Запечатан	isSealed	boolean	Указывает, можно ли изменить столбец.
Распространение изменений	propagateChanges	boolean	Если значение true, изменения этого столбца будут распространяться в списки, реализующие столбец.
Столбец значений по умолчанию — формула	defaultValue.formula	string	Формула, используемая для вычисления значения по умолчанию для столбца.
Столбец значений по умолчанию — значение	defaultValue.value	string	Прямое значение, используемое в качестве значения по умолчанию для столбца.
Текстовый столбец — максимальная длина	text.maxLength	integer	Максимальная длина текста
Текстовый столбец— разрешение нескольких строк	text.allowMultipleLines	boolean	Разрешить несколько строк текста
Текстовый столбец — добавление изменений	text.appendChangesToExistingText	boolean	Следует ли обновлять этот столбец к существующему тексту
Текстовый столбец — строки для редактирования	text.linesForEditing	integer	Количество строк текста для отображения в элементах управления редактирования
Текстовый столбец — текстовый тип	text.textType	string	Тип хранимого текста
Числовой столбец — десятичные разряды	number.decimalPlaces	string	Сколько десятичных разрядов для отображения
Числовой столбец — отображение как	number.displayAs	string	Отображение номера
Числовой столбец — максимальное значение	number.maximum	number	Максимально допустимое значение
Числовой столбец — минимальный	number.minimum	number	Минимально допустимое значение
булевый	boolean	object	Параметры логических столбцов
Столбец DateTime — отображение как	dateTime.displayAs	string	Отображение даты и времени
Столбец DateTime — формат	dateTime.format	string	Следует ли включать время с датой
Столбец выбора — разрешить запись текста	choice.allowTextEntry	boolean	Можно ли вводить пользовательские значения
Столбец выбора — варианты	choice.choices	array of string	Список вариантов для столбца
Столбец выбора — отображение как	choice.displayAs	string	Отображение вариантов
Столбец подстановки — разрешить несколько значений	lookup.allowMultipleValues	boolean	Можно ли выбрать несколько значений
Столбец подстановки — разрешить неограниченную длину	lookup.allowUnlimitedLength	boolean	Должно ли значение в столбце превышать стандартное ограничение в 255 символов.
Столбец подстановки — идентификатор списка	lookup.listId	string	Идентификатор списка, из который будет получена информация
Столбец подстановки — первичный идентификатор столбца подстановки	lookup.primaryLookupColumnId	string	Идентификатор столбца для получения сведений из
Столбец валюты — языковой стандарт	currency.locale	string	Языковой стандарт для валюты
Столбец PersonOrGroup — разрешить выбор нескольких элементов	personOrGroup.allowMultipleSelection	boolean	Можно ли выбрать нескольких пользователей или групп.
Столбец PersonOrGroup — выбор из типа	personOrGroup.chooseFromType	string	Типы людей или групп, которые можно выбрать
Столбец PersonOrGroup — отображается как	personOrGroup.displayAs	string	Отображение пользователей или групп
Столбец ГиперссылкаOrPicture — изображение	hyperlinkOrPicture.isPicture	boolean	Указывает, является ли гиперссылка рисунком
Вычисляемый столбец — формула	calculated.formula	string	Формула вычисления
Вычисляемый столбец — тип вывода	calculated.outputType	string	Тип выходных данных
Вычисляемый столбец — формат	calculated.format	string	Следует ли включать время с датой
Столбец географического расположения	geolocation	object	Параметры столбцов расположения
Свойства столбца эскиза	thumbnail	object	Параметры для столбцов эскизов
Свойства столбца состояния утверждения содержимого	contentApprovalStatus	object	В этом столбце хранится состояние утверждения содержимого.
Столбец терминов— разрешение нескольких значений	term.allowMultipleValues	boolean	Можно ли выбрать несколько значений
Столбец терминов — отображение полного имени	term.showFullyQualifiedName	boolean	Указывает, следует ли отображать весь путь к термину или только метку термина.
Идентификатор типа контента	sourceContentType.id	string	Идентификатор типа контента.
Имя типа контента	sourceContentType.name	string	Имя типа контента.

FileStorageContainer.Columns.List

Имя	Путь	Тип	Описание
value	value	array of FileStorageContainer.Column

DriveItemCollectionPage

Представляет страницу элементов диска.

Имя	Путь	Тип	Описание
value	value	array of DriveItem	Коллекция элементов диска.
@odata.nextLink	@odata.nextLink	string	URL-адрес, который можно использовать для получения следующей страницы.

DriveItem

Метаданные элемента диска

Имя	Путь	Тип	Описание
URL-адрес скачивания	@microsoft.graph.downloadUrl	string	URL-адрес, который можно использовать для скачивания содержимого этого элемента
URL-адрес скачивания (без проверки подлинности)	@microsoft.graph.downloadUrlNoAuth	string	URL-адрес, который можно использовать для скачивания содержимого этого элемента без проверки подлинности
Идентификатор	id	string	Уникальный идентификатор файла или папки
Имя	name	string	Имя файла или папки
Size	size	integer	Размер файла или папки в байтах
URL-адрес	webUrl	string	URL-адрес, отображающий элемент в браузере
Время создания	createdDateTime	date-time	Дата и время создания файла или папки
время последнего изменения;	lastModifiedDateTime	date-time	Дата и время последнего изменения файла или папки
Etag	eTag	string	Etag файла или папки
CTag	cTag	string	Тег, указывающий, что содержимое изменилось
Тип диска	parentReference.driveType	string	Тип диска, содержащего элемент
Идентификатор диска	parentReference.driveId	string	Идентификатор диска, содержащего элемент
Родительский идентификатор	parentReference.id	string	Идентификатор родительской папки
Родительское имя	parentReference.name	string	Имя родительской папки
Родительский путь	parentReference.path	string	Путь к родительской папке
Идентификатор сайта	parentReference.siteId	string	Идентификатор сайта, содержащего элемент
Идентификатор приложения	createdBy.application.id	string	Идентификатор приложения, создавшего элемент
Имя приложения	createdBy.application.displayName	string	Отображаемое имя приложения, создавшего элемент
Идентификатор пользователя	createdBy.user.id	string	Идентификатор пользователя, создавшего элемент
Имя пользователя	createdBy.user.displayName	string	Отображаемое имя пользователя, создавшего элемент
Идентификатор приложения	lastModifiedBy.application.id	string	Идентификатор приложения, которое последнее изменение элемента
Имя приложения	lastModifiedBy.application.displayName	string	Отображаемое имя приложения, которое последнее изменение элемента
Идентификатор пользователя	lastModifiedBy.user.id	string	Идентификатор пользователя, который последний раз изменил элемент
Имя пользователя	lastModifiedBy.user.displayName	string	Отображаемое имя пользователя, который последний раз изменил элемент
Тип MIME	file.mimeType	string	Тип MIME файла
Хэш quickXor	file.hashes.quickXorHash	string	Хэш quickXor файла
Время создания	fileSystemInfo.createdDateTime	date-time	Дата и время создания файла или папки в файловой системе
время последнего изменения;	fileSystemInfo.lastModifiedDateTime	date-time	Дата и время последнего изменения файла или папки в файловой системе
Число дочерних объектов	folder.childCount	integer	Количество элементов в папке
Область общего доступа	shared.scope	string	Область общего доступа (пользователи, организация или любой пользователь)

SharingLink

Представляет ссылку для общего доступа к файлу или папке

Имя	Путь	Тип	Описание
Идентификатор ссылки	id	string	Уникальный идентификатор ссылки для общего доступа
Тип ссылки	link.type	string	Тип ссылки на общий доступ (просмотр, изменение, внедрение)
Область ссылки	link.scope	string	Область ссылки на общий доступ
URL-адрес	link.webUrl	string	URL-адрес ссылки для общего доступа
отображаемое имя	link.application.displayName	string	Отображаемое имя приложения
id	link.application.id	string	Уникальный идентификатор приложения

SharingPermissionResponse

Представляет разрешение для файла или папки

Имя	Путь	Тип	Описание
Идентификатор разрешения	id	string	Уникальный идентификатор разрешения
Роли	roles	array of string	Роли, предоставленные для этого разрешения
Идентификатор общего ресурса	shareId	string	Уникальный маркер, который можно использовать для доступа к этому общему элементу через API общих папок
Отображаемое имя	grantedTo.user.displayName	string	Отображаемое имя пользователя
Адрес электронной почты	grantedTo.user.email	string	Адрес электронной почты пользователя
Идентификатор пользователя	grantedTo.user.id	string	Уникальный идентификатор пользователя
Область ссылки	link.scope	string	Область ссылки
Тип ссылки	link.type	string	Тип ссылки
URL-адрес	link.webUrl	string	URL-адрес ссылки
Адрес электронной почты	invitation.email	string	Адрес электронной почты, на который было отправлено приглашение
Обязательный вход	invitation.signInRequired	boolean	Требуется ли вход для доступа к общему элементу
Время окончания срока действия	expirationDateTime	date-time	Дата и время истечения срока действия разрешения
Предоставлено удостоверениям	grantedToIdentities	array of object	При указании ограничивает общий доступ только перечисленным пользователям.
Отображаемое имя	grantedToIdentities.user.displayName	string	Отображаемое имя пользователя
Адрес электронной почты	grantedToIdentities.user.email	string	Адрес электронной почты пользователя
Идентификатор пользователя	grantedToIdentities.user.id	string	Уникальный идентификатор пользователя

SharingPermissionsList

Представляет список разрешений для файла или папки

Имя	Путь	Тип	Описание
value	value	array of SharingPermissionResponse

FileVersion

Представляет версию файла

Имя	Путь	Тип	Описание
Идентификатор версии	id	string	Идентификатор версии
Изменено	lastModifiedBy.user.displayName	string	Имя пользователя, изменившего версию
Идентификатор пользователя	lastModifiedBy.user.id	string	Идентификатор пользователя, изменившего версию.
Последнее изменение	lastModifiedDateTime	date-time	Дата и время последнего изменения этой версии
Size	size	integer	Размер версии в байтах
Уровень публикации	publication.level	string	Уровень публикации этой версии (опубликован или извлечен)
Идентификатор версии	publication.versionId	string	Идентификатор опубликованной версии

FileVersions

Представляет коллекцию версий файлов

Имя	Путь	Тип	Описание
value	value	array of FileVersion	Коллекция версий файлов

Эскизы

Представляет набор эскизов для файла

Имя	Путь	Тип	Описание
Идентификатор набора эскизов	id	string	Уникальный идентификатор набора эскизов
большой	large	Thumbnail	Представляет один эскиз
medium	medium	Thumbnail	Представляет один эскиз
маленький	small	Thumbnail	Представляет один эскиз
source	source	Thumbnail	Представляет один эскиз

Эскиз

Представляет один эскиз

Имя	Путь	Тип	Описание
Высота	height	integer	Высота эскиза в пикселях
Ширина	width	integer	Ширина эскиза в пикселях
URL	url	string	URL-адрес эскиза

Эскизы

Представляет коллекцию наборов эскизов

Имя	Путь	Тип	Описание
value	value	array of ThumbnailSet	Коллекция наборов эскизов

RecycleBinItem

Представляет элемент в корзине

Имя	Путь	Тип	Описание
Идентификатор	id	string	Уникальный идентификатор переработанного элемента
Имя	name	string	Имя переработанного элемента
Size	size	integer	Размер элемента в байтах
Deleted Date (Дата удаления);	deletedDateTime	date-time	Дата и время удаления элемента
Удалено из расположения	deletedFromLocation	string	Относительный URL-адрес расположения, которое первоначально содержало элемент
Название	title	string	Заголовок переработанного элемента
Удалено по	deletedBy.user.displayName	string	Отображаемое имя пользователя, который удалил элемент
Адрес электронной почты	deletedBy.user.email	string	Сообщение электронной почты пользователя, который удалил элемент
Идентификатор пользователя	deletedBy.user.id	string	Уникальный идентификатор пользователя, который удалил элемент

RecycleBinItemCollection

Коллекция элементов в корзине

Имя	Путь	Тип	Описание
value	value	array of RecycleBinItem	Коллекция элементов в корзине

бинарный

Это базовый тип данных binary.

Поделиться через

SharePoint Embedded

Начало работы

Предоставление доступа к соединителю SharePoint Embedded

Известные проблемы и ограничения

Действия

Активация контейнера

Параметры

Возврат файла

Параметры

Возьмите контейнер

Параметры

Возвращаемое значение

Восстановление корзины контейнера

Параметры

Возвращаемое значение

Восстановление переработанных элементов

Параметры

Возвращаемое значение

Вывод списка версий файлов

Параметры

Возвращаемое значение

Вывод списка переработанных контейнеров

Параметры

Возвращаемое значение

Вывод списка полей файла

Параметры

Возвращаемое значение

Вывод списка разрешений контейнера

Параметры

Возвращаемое значение

Вывод списка столбцов контейнеров

Параметры

Возвращаемое значение

Извлечь файл

Параметры

Настройка полей файла

Параметры

Возвращаемое значение

Обновление контейнера

Параметры

Возвращаемое значение

Обновление настраиваемых свойств контейнера

Параметры

Возвращаемое значение

Обновление разрешения контейнера

Параметры

Возвращаемое значение

Обновление содержимого файла

Параметры

Возвращаемое значение

Отменить извлечение

Параметры

Отправка приглашения на общий доступ

Параметры

Возвращаемое значение

Переименовать файл

Параметры

Возвращаемое значение

Перечисление элементов в контейнере

Параметры

Возвращаемое значение

Получение версии файла

Параметры

Возвращаемое значение

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

Параметры

Возвращаемое значение

Получение разрешения на общий доступ

Параметры

Возвращаемое значение

Получение свойств файла

Параметры

Возвращаемое значение

Получение столбца контейнера

Параметры

Возвращаемое значение

Получение эскиза

Параметры

Возвращаемое значение