获取文件元信息-协同文档

GET

{endpoint_url}/files/{fileId}

获取文件的基本信息、权限等，创建、导入、编辑文件时会请求此接口。

说明

manageable 权限说明：建议至少给文件的创建者指定 manageable: true 权限，若接入方允许有其他人拥有管理权限，则可自行设计实现。

使用到 manageable 权限的场景如下：

调用石墨文档中台删除文件接口时，需要 manageable 为 true

进行表格锁定操作时，若当前用户具有 manageable 权限为 true 时，则会展示为管理者

更新 或 删除 他人创建的版本时，当前用户对于此文件的权限需要 manageable 为 true 时，才允许操作，否则会被拒绝

表格导出时，若当前用户对于此文件权限满足 manageable 为 true 时，导出的文件中会包含表格锁定的内容，否则导出文件内容不包含锁定内容。

请求参数

Path 参数

endpoint_url

string

必需

示例值:

fileId

string

必需

Header 参数

X-Shimo-Token

string

必需

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

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

string

必需

接入方系统中的文档 ID

name

string

文档标题

必需

type

string

必需

文档类型列表请参考创建文档

permissions

object

必需

请参考文件权限说明

commentable

boolean

必需

用户是否可以评论文档

editable

boolean

必需

用户是否可以编辑文档

readable

boolean

必需

用户是否可以访问文档

copyable

boolean

必需

用户是否可以复制文档内容。当 editable 值域为 true 时，copyable 一定为 true

exportable

boolean

必需

用户是否可以导出文件

manageable

boolean

必需

用户是否可以管理文档，例如删除、移动等操作

copyablePasteClipboard

boolean

必需

该用户是否可以外部粘贴文档内容
只有当 copyable 字段为 true 时，copyablePasteClipboard 才可能为 true

attachmentCopyable

boolean

必需

用户是否可以复制附件内容

cutable

boolean

必需

用户是否可以剪切文档内容

attachmentPreviewable

boolean

必需

用户是否可以预览附件

attachmentDownloadable

boolean

必需

用户是否可以下载附件

imageDownloadable

boolean

必需

用户是否可以下载图片

views

number

必需

接入方统计的文件阅读次数，用于在文档信息中展示阅读次数。若接入方未返回，则默认显示为 1

creatorId

string

必需

接入方文件的创建者用户 ID

createdAt

string

必需

接入方记录的文件创建时间，UTC 时间（0 时区），格式为 2022-01-01T09:00:01Z

updatedAt

string

必需

接入方记录的文件最后更新时间，UTC 时间（0 时区），格式为 2022-01-01T09:00:01Z

teamGuid

string

必需

接入方文件所属团队 ID，非必需。若返回此字段，则 user.teamGuid 字段也应实现并返回

示例

{
  "id": "ba13551165cc5066",
  "name": "示例文档",
  "type": "document",
  "permissions": {
    "commentable": true,
    "editable": true,
    "readable": true,
    "copyable": true,
    "exportable": true,
    "manageable": true,
    "copyablePasteClipboard": true,
    "attachmentCopyable": true,
    "cutable": true,
    "attachmentPreviewable": true,
    "attachmentDownloadable": true,
    "imageDownloadable": true
  },
  "views": 100,
  "creatorId": "1",
  "createdAt": "2021-08-01T00:00:00Z",
  "updatedAt": "2021-08-02T00:00:00Z",
  "teamGuid": "123"
}

修改于 2025-01-14 06:04:49

替换传统文档书签内容

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