Lock

POST /wopi/files/(file_id)

由请求锁定的online office锁定文件编辑。

此操作的工作原理如下:

  1. WOPI 主机检查文件当前是否被锁定。
  2. 如果文件 未被锁定,主机应该锁定文件并返回 200 OK
  3. 如果文件已经 被锁定 并且 X-WOPI-Lock 值与文件当前的锁定匹配,主机应该刷新锁定计时器并返回 200 OK
  4. 在所有其他情况下,主机必须返回 409 Conflict ("lock mismatch") 并包含 X-WOPI-Lock 响应标头,标头中包含文件当前锁的值。
  5. 在文件被第三方客户端锁定的情况下,主机仍应始终在 X-WOPI-Lock 响应标头中包含当前锁 ID。
参数
名称 描述 类型
file_id 必须是 URL 安全的文件 ID。 string
查询参数
名称 描述 类型
access_token 访问令牌主机将用它确定请求是否被授权。 string
请求标头
名称 描述 类型 出现
X-WOPI-Override 来自 WOPI 服务器的请求操作 (LOCK)。 string 必需的
X-WOPI-Lock 锁ID主机必须用它来标识文件上的锁。 string 必需的
响应标头
名称 描述 类型 出现
X-WOPI-Lock 锁ID标识文件上的当前锁。当使用 409 Conflict响应请求时,必须始终包含此标头。 用 200 OK响应请求时不应包含它。 string 可选的
X-WOPI-LockFailureReason 锁定失败的原因。当使用 409 Conflict响应请求时,可能会包含此标头。它只能用于记录目的。 string 可选的
X-WOPI-ItemVersion 文件版本。 string 可选的