GET /wopi/files/(file_id)
必须为所有 WOPI 操作实施 CheckFileInfo 操作。此操作返回有关文件的信息、用户对该文件的权限以及有关 WOPI 主机对该文件所具有的功能的一般信息。此外,某些 CheckFileInfo 属性可能会影响 WOPI 客户端的外观和行为。
查询参数
| 名称 | 类型 | 描述 |
|---|
| access_token | string | 访问令牌主机将用它来确定请求是否被授权。 |
请求标头
| 名称 | 类型 | 是否必填 | 描述 |
|---|
| X-WOPI-SessionContext | string | 可选的 | 会话上下文(如果在初始 WOPI 操作 URL 上提供)。 |
必需的响应属性
请注意,任何响应字符串值的默认值都是空字符串。
| 名称 | 类型 | 示例 | 描述 |
|---|
| BaseFileName | string | "Example File Name.docx" | 不带路径的文件名,显示在用户界面 (UI) 中并确定文件扩展名。 |
| OwnerId | string | "uid-1" | 用于唯一标识文件所有者的字符串 。 在大多数情况下,上传或创建文件的用户被视为所有者。 |
| Size | integer | 100 | 文件的大小(以字节为单位,64位有符号整数)。 |
| Version | string | "Khirz6zTPdfd7" | 基于服务器文件版本架构的文件的当前版本。每次编辑和保存文档时,都必须更改版本。给定文件的版本号不得重复。 |
其他杂项属性
| 名称 | 类型 | 示例 | 描述 |
|---|
| ProtectInClient | boolean | true | 指示 WOPI 客户端是否应采取措施防止文件被复制和打印。这旨在帮助强制执行 IRM(信息资源管理)。 |
| DisablePrint | boolean | true | 指定 WOPI 客户端是否应禁用所有打印功能。 |
| LastModifiedTime | string | "2009-06-15T13:45:30.0000000Z" | 上次修改文件的时间。此时间必须始终为 UTC 时间,并且必须采用 ISO 8601 往返格式。 |
| SHA256 | string | | 文件内容的 256 位 SHA-2 编码 [ FIPS 180-2 ] 哈希值,以 Base64 编码字符串的形式呈现。用于 WOPI 客户端的缓存。 |
用户元数据属性
| 名称 | 类型 | 示例 | 描述 |
|---|
| UserFriendlyName | string | "John Smith" | 用户的名称,适合在 UI 中显示。 |
| UserId | string | "uid-1" | 唯一标识当前访问文件的用户的值。 |
用户权限属性
| 名称 | 类型 | 示例 | 描述 |
|---|
| ReadOnly | boolean | true | 指定当前用户是否无法更改文件。 |
| UserCanWrite | boolean | true | 指定用户是否有权更改文件。 |
| RestrictedWebViewOnly | boolean | true | 指示 WOPI 客户端不得允许用户下载文件或在单独的应用程序中打开文件 |