开发工具

获取文件元信息-预览文档

GET{endpoint_url}/files/{fileId}

获取基本信息、下载地址，预览文件时会请求此接口。

:::caution 说明
此接口地址与获取文件元信息-协同文档相同，但返回结果不同；可能需要接入方自行区分文件是石墨协同文档还是普通文件。
:::
:::caution 说明

请求下载时接入方无法返回 Content-Type 以及 Content-Disposition 信息用于石墨文档中台识别文件类型，此时通过元信息中返回的 ext 字段告知石墨文档中台此文件的扩展名。例如 docx 识别为 Word 文件。
ext 字段不带 . ，例如文件为 测试文件.docx ，应返回 docx。
出于安全性考虑，2021-12-01 之后开始，预览时获取文件信息需要返回 permissions 信息用于验证当前用户是否具有相应权限。

:::

注：石墨服务器会下载downloadUrl中的文件进行解析。可能需要设置指定的 Header 供石墨来选择以何种方式解析。更多细节可以参考 Header 要求。

请求参数

Path 参数

endpoint_url

string

必需

示例值:

fileId

string

必需

Header 参数

X-Shimo-Token

string

必需

用于接入方对本次请求鉴权

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

string

必需

接入方系统中的文件 ID

name

string

文件标题

必需

type

string

必需

目前使用 file 表示第三方文件类型

permissions

object

必需

请参考文件权限说明

readable

boolean

必需

downloadUrl

string

必需

用于预览 Office 文件时下载文件内容

ext

string

必需

当石墨请求下载地址 (downloadUrl) 返回的 HTTP Response Header 中 Content-Type 或 Content-Disposition 接入方未返回可识别的信息时，此字段用于标识此文件的扩展名。不需要带" ."，若文件为测试文件.docx ，则应传 docx，若返回 .docx 可能识别失败。

{
  "id": "ba13551165cc5066",
  "name": "示例文档.docx",
  "type": "file",
  "permissions": {
    "readable": true
  },
  "downloadUrl": "http://example.com/download/test.docx",
  "ext": "docx"
}

最后修改时间： 1 年前