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