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

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

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

  1. Хост WOPI проверяет, заблокирован ли файл в данный момент или нет.
  2. Если файл в данный момент заблокирован и значение X-WOPI-Lock не соответствует текущей блокировке файла, хост должен вернуть 409 Conflict несоответствие блокировки«) и включить заголовок ответа X-WOPI-Lock, содержащий значение текущей блокировки файла.
  3. Если файл разблокирован, хост должен ответить 200 OK и продолжить переименование.
  4. Если хост не может переименовать файл, поскольку запрошенное имя недопустимо или противоречит существующему файлу, хост должен попытаться сгенерировать другое имя на основе запрошенного имени, которое соответствует требованиям к имени файла.
  5. Если хост не может сгенерировать другое имя, он должен вернуть 400 Bad Request. Ответ должен содержать заголовок X-WOPI-InvalidFileNameError, который описывает, почему имя файла было недействительным.
Параметры
НазваниеОписаниеТип
file_idИдентификатор файла, который должен быть безопасным для URL.строковый
Параметры запроса
НазваниеОписаниеТип
access_tokenМаркер доступа, который хост будет использовать для определения того, авторизован ли запросстроковый
Заголовки запроса
НазваниеОписаниеТипНаличие
X-WOPI-OverrideЗапрошенная операция с сервера WOPI (RENAME_FILE).строковыйобязательно
X-WOPI-LockИдентификатор блокировки, который хост должен использовать для идентификации блокировки файла.строковыйнеобязательно
X-WOPI-RequestedNameИмя файла без расширения файла (в формате UTF-7).строковыйнеобязательно
Заголовки ответа
НазваниеОписаниеТипНаличие
X-WOPI-InvalidFileNameErrorПричина, по которой операция переименования не может быть завершена. Этот заголовок следует включать только в том случае, если код ответа — 400 Bad Request. Это значение должно использоваться только для регистрационных целей.строковыйнеобязательно
X-WOPI-Lock Идентификатор блокировки, идентифицирующий текущую блокировку файла. Этот заголовок всегда должен быть включен при ответе на запрос с 409 Conflict. Его не следует включать при ответе на запрос 200 ОК.строковыйнеобязательно
X-WOPI-LockFailureReasonПричина неудачной блокировки. Этот заголовок может быть включен при ответе на запрос с 409 Conflict. Он должен использоваться только для регистрационных целей.строковыйнеобязательно