GET /wopi/files/(file_id)
Возвращает информацию о свойствах файла, правах доступа и настройках редактора.
Параметры
| Название | Описание | Тип |
| file_id | Идентификатор файла, который должен быть безопасным для URL. | строковый |
Параметры запроса
| Название | Описание | Тип |
| access_token | Маркер доступа, который хост будет использовать для определения того, авторизован ли запрос | строковый |
Заголовки запросов
| Название | Описание | Тип | Наличие |
| X-WOPI-SessionContext | Контекст сеанса, если он указан в исходном URL-адресе действия WOPI. | строковый | необязательный |
Обязательные свойства ответа
| Название | Описание | Тип | Пример |
| BaseFileName | Имя файла без пути, отображаемое в пользовательском интерфейсе (UI) и определяющее расширение файла. | строковый | «Example File Name.docx» |
| Version | Текущая версия файла, основанная на схеме версии файла сервера. Каждый раз, когда документ редактируется и сохраняется, версия должна быть изменена. Значения версии никогда не должны повторяться для данного файла. | строковый | «Khirz6zTPdfd7» |
Breadcrumb свойства
| Название | Описание | Тип | Пример |
| BreadcrumbBrandName | Имя, которое клиент WOPI отображает пользователю для обозначения фирменного наименования сервера WOPI. | строковый | «Example Brand Name» |
| BreadcrumbBrandUrl | URL-адрес веб-страницы, на которую переходит клиент WOPI, когда пользователь щелкает UI, отображающий BreadcrumbBrandName. | строковый | «https://example.com/url-to-breadcrumb-brand-page.com» |
| BreadcrumbDocName | Имя файла, которое клиент WOPI отображает пользователю. Если этот параметр не указан, используется параметр BaseFileName | строковый | «Example Breadcrumb File Name.docx» |
| BreadcrumbFolderName | Имя, которое клиент WOPI отображает пользователю, которое указывает имя папки, содержащей файл. | строковый | «Example Folder Name» |
| BreadcrumbFolderUrl | URL-адрес веб-страницы, на которую переходит клиент WOPI, когда пользователь щелкает UI, отображающий BreadcrumbFolderName | строковый | «https://example.com/url-to-breadcrumb-brand-folder» |
Свойства PostMessage
| Название | Описание | Тип | Пример |
| ClosePostMessage | Указывает, должен ли клиент WOPI уведомлять сервер WOPI, если пользователь закрывает клиент рендеринга или редактирования, использующий в данный момент этот файл. Хост ожидает получить UI_Close PostMessage, Close UI в онлайн-офисе активирован. | логический | true |
| EditModePostMessage | Указывает, должен ли клиент WOPI уведомлять сервер WOPI в случае, в случае если пользователь пытается отредактировать файл. Хост ожидает получить сообщение UI_Edit PostMessage при активации пользовательского интерфейса редактирования в онлайн-офисе. | логический | true |
| EditNotificationPostMessage | Указывает, должен ли клиент WOPI уведомлять сервер WOPI в случае, если пользователь пытается отредактировать файл. Хост ожидает получить Edit_NotificationPostMessage. | логический | true |
| FileSharingPostMessage | Указывает, должен ли клиент WOPI уведомлять сервер WOPI, если пользователь пытается поделиться файлом. Хост ожидает получить UI_SharingPostMessage при активации Share UI в онлайн-офисе. | логический | true |
| FileVersionPostMessage | Указывает, будет ли клиент WOPI уведомлять сервер WOPI, если пользователь попытается перейти к предыдущей версии файла. Хост ожидает получить UI_FileVersions PostMessage при активации пользовательского интерфейса предыдущих версий в онлайн-офисе. | логический | true |
| PostMessageOrigin | Домен, который клиент WOPI должен использовать в качестве параметра targetOrigin при отправке сообщений, как описано в [W3C-HTML5WEBMSG] | строковый | «https://exampledomain.com» |
Свойства URL-адреса файла
| Название | Описание | Тип | Пример |
| CloseUrl | URL-адрес веб-страницы, которую разработчик сочтет полезной для пользователя на случай, если пользователь закроет клиент рендеринга или редактирования, использующий в данный момент этот файл. | строковый | «https://example.com/url-to-close-page.com» |
| FileSharingUrl | URL-адрес расположения, позволяющего пользователю поделиться файлом. | строковый | «https://example.com/url-to-sharing-page.com» |
| FileVersionUrl | URL-адрес расположения, которое позволяет пользователю просматривать предыдущую версию файла. | строковый | «https://example.com/url-to-previous-version-page.com» |
| HostEditUrl | URL-адрес веб-страницы, на которой файл можно редактировать с помощью клиента WOPI. | строковый | «https://example.com/url-to-host-page.com» |
Другие разнообразные свойства
| Название | Описание | Тип | Пример |
| DisablePrint | Указывает, должен ли клиент WOPI отключать любые функции печати, находящиеся под его контролем. | логический | true |
| FileExtension | Расширение файла, которое должно начинаться с «.» | строковый | «.docx» |
| FileNameMaxLength | Максимальная длина имени файла, включая расширение файла, поддерживаемая сервером WOPI. | целое число | 20 |
| LastModifiedTime | Время последнего изменения файла. Это время всегда должно быть временем в формате UTC и должно быть отформатировано в двустороннем формате ISO 8601. Это свойство можно указать в качестве альтернативы свойству Version. | строковый | «2009-06-15T13:45:30.0000000Z» |
Свойства метаданных пользователя
| Название | Описание | Тип | Пример |
| IsAnonymousUser | Указывает, является ли пользователь анонимным. | логический | true |
| UserFriendlyName | Имя пользователя. Если оно не определено, клиент WOPI может быть настроен на использование строки-заполнителя в некоторых сценариях или вообще на отсутствие имени. | строковый | «John Smith» |
| UserId | Уникальный идентификатор пользователя, указанный сервером WOPI. | строковый | «uid-1» |
Свойства разрешений пользователя
| Название | Описание | Тип | Пример |
| ReadOnly | Указывает, не может ли файл быть изменен текущим пользователем. | логический | true |
| UserCanRename | Указывает, есть ли у пользователя разрешения на переименование файла. | логический | true |
| UserCanReview | Указывает, есть ли у пользователя разрешения на просмотр файла. | логический | true |
| UserCanWrite | Указывает, есть ли у пользователя разрешения на редактирование файла. | логический | true |
Свойства возможностей хоста WOPI
| Название | Описание | Тип | Пример |
| SupportsRename | Указывает, поддерживает ли сервер WOPI разрешение на переименование. | логический | true |
| SupportsReviewing | Указывает, поддерживает ли сервер WOPI разрешение на просмотр. | логический | true |
Свойства Nextcloud/Collabora/Seafile
| Название | Описание | Тип | Пример |
| HidePrintOption | Указывает, скрывает ли сервер WOPI параметр печати в строке меню файла в пользовательском интерфейсе. |