获取文件元信息-协同文档自动任务
开发中GET
{endpoint_url}/admin/files/{fileId}自动任务获取基本信息(目前只有跨表格引用任务)时会请求此接口。
:::caution 说明
接口由石墨 SDK 主动发起,出于安全考虑,建议对此接口传递的 HTTP Header X-Shimo-Signature
进行校验,签名算法与接入方生成签名的方法一致。
:::
请求参数
Path 参数
endpoint_url
string
必需
示例值:
{{ endpoint_url}}
fileId
string
必需
Header 参数
X-Shimo-Credential-Type
string
必需
无法提供 token 的 回调凭证类型
X-Shimo-Signature
string
必需
石墨根据服务商的 AppId 以及 Secret 信息签名的Signature,payload 中包含 fileId
,若与请求参数中不一致说明非合法请求
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
id
string
必需
接入方系统中的文档 ID
name
string
文档标题
type
string
必需
文档类型列表参考 创建文档
permissions
object
必需
请参考 文件权限说明,readable
需为 true
commentable
boolean
必需
editable
boolean
必需
readable
boolean
必需
copyable
boolean
必需
exportable
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
示例
{
"id": "ba13551165cc5066",
"name": "无标题表格",
"type": "spreadsheet",
"permissions": {
"commentable": true,
"editable": true,
"readable": true,
"copyable": true,
"exportable": true
},
"views": 100,
"creatorId": "1",
"createdAt": "2021-08-01T00:00:00Z", // UTC 时间,0 时区,在北京时间基础上减 8 小时
"updatedAt": "2021-08-02T00:00:00Z" // UTC 时间,0 时区,在北京时间基础上减 8 小时
}
最后修改时间: 1 年前