RenameFile - Центр поддержки Р7

Запись опубликована:15.10.2022
Post category:WOPI REST API
Запись изменена:18.11.2025

POST /wopi/files/(file_id)

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

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

Хост WOPI проверяет, заблокирован ли файл в данный момент или нет.
Если файл в данный момент заблокирован и значение X-WOPI-Lock не соответствует текущей блокировке файла, хост должен вернуть 409 Conflict («несоответствие блокировки«) и включить заголовок ответа X-WOPI-Lock, содержащий значение текущей блокировки файла.
Если файл разблокирован, хост должен ответить 200 OK и продолжить переименование.
Если хост не может переименовать файл, поскольку запрошенное имя недопустимо или противоречит существующему файлу, хост должен попытаться сгенерировать другое имя на основе запрошенного имени, которое соответствует требованиям к имени файла.
Если хост не может сгенерировать другое имя, он должен вернуть 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. Он должен использоваться только для регистрационных целей.	строковый	необязательно

Была ли полезна статья?

Спасибо, что помогаете нам стать лучше