• Post category:WOPI REST API
  • Запись изменена:16.06.2023
POST /wopi/files/(file_id)

Позволяет редактировать файлы.

Эта операция работает следующим образом:

  1. Хост WOPI проверяет, заблокирован ли файл в данный момент или нет.
  2. Если файл разблокирован или если файл в данный момент заблокирован и значение X-WOPI-Lock не соответствует текущей блокировке файла, хост должен вернуть 409 Conflict («несоответствие блокировки») и включить заголовок ответа X-WOPI-Lock, содержащий значение текущей блокировки в файле. В случае, когда файл разблокирован, хост должен установить X-WOPI-Lock в пустую строку.
  3. В случае, когда файл заблокирован сторонним клиентом, хосты все равно должны всегда включать текущий идентификатор блокировки в заголовок ответа X-WOPI-Lock
Параметры
НазваниеОписаниеТип
file_idИдентификатор файла, который должен быть безопасным для URL..строковый
Параметры запроса
НазваниеОписаниеТип
access_tokenМаркер доступа, который хост будет использовать для определения того, авторизован ли запрос.строковый
Заголовки запросов
НазваниеОписаниеТипНаличие
X-WOPI-OverrideЗапрошенная операция с сервера WOPI (UNLOCK).строковыйобязательно
X-WOPI-LockИдентификатор блокировки, который хост должен использовать для идентификации блокировки файла.строковыйобязательно
Заголовки ответов
НазваниеОписаниеТипНаличие
X-WOPI-LockИдентификатор блокировки, идентифицирующий текущую блокировку файла. Этот заголовок всегда должен быть включен при ответе на запрос с 409 Conflict. Его не следует включать при ответе на запрос 200 ОК.строковыйнеобязательно
X-WOPI-LockFailureReasonПричина неуспешной блокировки. Этот заголовок может быть включен при ответе на запрос с 409 Conflict. Он должен использоваться только для регистрационных целей.строковыйнеобязательно
X-WOPI-ItemVersionВерсия файла.строковыйнеобязательно