Share via

RenameFile for CSPP Plus

  • Article

Desktop

If a document is held by one or more Coauth or CoauthExclusive lock references, a valid Coauth lock reference must be provided for the call to succeed.

For a full description of the RenameFile API, see the existing API contract:

Request headers

  • X-WOPI-CoauthLockId (string) – Optional. A string provided by the client that the host must use to identify the Coauth lock on the file. Size limit: 1,024 ASCII characters.

Status codes

  • 400 Bad Request
    • The specified name is illegal.
    • Occurs when both X-WOPI-Lock and X-WOPI-CoauthLockId are provided. Only one of the headers should be set.
    • The header size wasn't within the acceptable range.
  • 409 Conflict
    • Lock mismatch - The file is locked but the supplied lock type (X-WOPI-Lock, X-WOPI-CoauthLockId) or value doesn't match the actual lock on the file.
    • The file is locked, but the client did not supply any lock (X-WOPI-Lock or X-WOPI-CoauthLockId)
    • Locked by another interface.

Next steps

Learn about changes in these methods for WOPI coauthoring extensions: