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

Обновляет блокировку файла, устанавливая таймер автоматического истечения срока действия на 30 минут. Эта блокировка истечет автоматически через 30 минут, если она не будет изменена с помощью операции Unlock или другой операции RefreshLock.

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

  1. Хост WOPI проверяет, заблокирован ли файл в данный момент или нет.
  2. Если файл разблокирован или если файл в настоящее время заблокирован, а значение X-WOPI-Lock не соответствует текущей блокировке файла, хост должен вернуть 409 Conflict («несоответствие блокировки») и включить X-WOPI-Lock. Заголовок ответа блокировки, содержащий значение текущей блокировки файла. В случае, когда файл разблокирован, хост должен установить X-WOPI-Lock на пустую строку.
  3. В случае, когда файл заблокирован сторонним клиентом, хосты должны всегда включать текущий идентификатор блокировки в заголовок ответа X-WOPI-Lock.
Параметры
НазваниеОписаниеТип
file_idИдентификатор файла, который должен быть безопасным для URL.строковый
Query parameters
НазваниеОписаниеТип
access_tokenМаркер доступа, который хост будет использовать для определения того, авторизован ли запрос.строковый
Request headers
НазваниеОписаниеТипНаличие
X-WOPI-OverrideЗапрошенная операция с сервера WOPI (REFRESH_LOCK).строковыйобязательно
X-WOPI-LockИдентификатор блокировки, который хост должен использовать для идентификации блокировки файла.строковыйобязательно
Response headers
НазваниеОписаниеТипНаличие
X-WOPI-LockИдентификатор блокировки, идентифицирующий текущую блокировку файла. Этот заголовок всегда должен быть включен при ответе на запрос с 409 Conflict. Его не следует включать при ответе на запрос 200 ОК.строковыйнеобязательно
X-WOPI-LockFailureReasonThe cause of the lock failure. This header may be included when responding to the request with 409 Conflict. It must only be used for logging purposes. Причина неудачной блокировки. Этот заголовок может быть включен при ответе на запрос с 409 Conflict. Он должен использоваться только для регистрационных целей.строковыйнеобязательно