列出文档空间 #
获取当前项目中所有文档空间信息。
请求 #
url: /project/{projectId}/docSpace?accessToken={accessToken}
参数:
参数名 | 说明 |
---|---|
projectId | 项目ID |
accessToken | 访问令牌 |
响应 #
成功返回200,失败返回500
响应为文档空间信息列表
文档空间信息结构: #
属性 | 类型 | 说明 |
---|---|---|
docSpaceId | string | 文档空间ID |
title | string | 文档空间名称 |
列出文档 #
列出单个文档空间的文档。
请求 #
url: /project/{projectId}/docSpace/{docSpaceId}?accessToken={accessToken}&offset={offset}=&limit={limit}
参数:
参数名 | 说明 |
---|---|
projectId | 项目ID |
docSpaceId | 文档空间ID |
accessToken | 访问令牌 |
offset | 分页偏移 |
limit | 单页记录条数 |
响应 #
成功返回200,失败返回500
响应结构:
属性 | 类型 | 说明 |
---|---|---|
totalCount | int | 文档总数 |
docList | DocInfo[] | 文档信息列表 |
查看文档 #
发送请求给客户端,成功后客户端会进入文档阅读页面。
请求 #
url: /project/{projectId}/docSpace/{docSpaceId}/{docId}/show?accessToken={accessToken}
参数:
参数名 | 说明 |
---|---|
projectId | 项目ID |
docSpaceId | 文档空间ID |
docId | 文档ID |
accessToken | 访问令牌 |
响应 #
成功返回200,失败返回500
通用结构 #
文档信息(DocInfo) #
属性 | 类型 | 说明 |
---|---|---|
docId | string | 文档ID |
docSpaceId | string | 文档空间ID |
title | string | 文档标题 |
createUserId | string | 创建人ID |
createDisplayName | string | 创建人名称 |
createTime | long | 创建时间 |
updateUserId | string | 更新人ID |
updateDisplayName | string | 更新人名称 |
updateTime | long | 更新时间 |