# 文件列表
# 我的空间文件列表
功能：查询我的空间下的文件列表，可查询全部、我拥有的或者与我协作的。
路径：fs/bs/fsFile/list。
请求方法：GET。
请求参数：
| 参数 | 必须 | 类型 | 备注 |
|---|---|---|---|
tab | 是 | number | 0: 全部 1: 我拥有的 2: 与我协作的 |
parentFid | 否 | string | 上级文件夹 ID，如果为顶级则传 "0"。 |
appUserId | 是 | string | 业务用户 ID |
orderBy | 否 | number | 1: 更新时间 2: 创建时间 3: 名称 |
folderUp | 否 | boolean | 文件夹是否置顶 |
请求示例：
点击查看
/**
* 空间文件列表选项卡
*/
export enum FileListTab {
/**
* 全部
*/
'ALL' = 0,
/**
* 我拥有的
*/
'OWN' = 1,
/**
* 与我协作的
*/
'SHARE' = 2,
}
/**
* 查询我的空间下的文件列表，可查询全部、我拥有的或者与我协作的。
* @param tab 文件列表过滤选项卡
* @param uid 用户 ID
* @param parentFid 上级文件夹 ID，如果为顶级则传 0。tab 为 ALL(0) 时无效。
*/
export async function GET(
tab: FileListTab,
appUserId: string,
parentFid?: string
): Promise<ResponseBody<(IflydocsDocument & IflydocsFileSize)[]>> {
const method = 'GET'
const path = '/fs/bs/fsFile/list'
const { nonce, timestamp } = genNonce()
const signature = sign(method, path, nonce, timestamp)
const Authorization = authorization(signature)
const headers = {
Authorization,
nonce,
timestamp,
}
const params = {
tab,
appUserId,
parentFid,
}
// 如果没有传，则移除
if (typeof parentFid === 'undefined') {
delete params.parentFid
}
const resp = await axios.get(path, {
headers,
params,
paramsSerializer: (params) => qs.stringify(params),
})
return resp.data
}响应示例：
点击查看
{
"code": 0,
"message": "success",
"data": [
{
"fid": "10tbS",
"appId": "6da37dd3",
"name": "a",
"parentFid": "0",
"createTime": 1666859283227,
"modifyTime": 1666859283227,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": null,
"type": 1,
"sourceType": null,
"sourceId": null,
"suffix": null,
"fileType": null,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tbW",
"appId": "6da37dd3",
"name": "test-collaborators",
"parentFid": "0",
"createTime": 1666859285106,
"modifyTime": 1666859285106,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tbW",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 2,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tbX",
"appId": "6da37dd3",
"name": "test-collaborators-more",
"parentFid": "0",
"createTime": 1666859286825,
"modifyTime": 1666859286825,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tbX",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 2,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tbY",
"appId": "6da37dd3",
"name": "test-collect",
"parentFid": "0",
"createTime": 1666859288281,
"modifyTime": 1666859288281,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tbY",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tbZ",
"appId": "6da37dd3",
"name": "test-content",
"parentFid": "0",
"createTime": 1666859289482,
"modifyTime": 1666859290323,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tbZ",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tc0",
"appId": "6da37dd3",
"name": "1",
"parentFid": "0",
"createTime": 1666859290943,
"modifyTime": 1666859290943,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": null,
"type": 1,
"sourceType": null,
"sourceId": null,
"suffix": null,
"fileType": null,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tc4",
"appId": "6da37dd3",
"name": "1",
"parentFid": "0",
"createTime": 1666859295264,
"modifyTime": 1666859295264,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": null,
"type": 1,
"sourceType": null,
"sourceId": null,
"suffix": null,
"fileType": null,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tc8",
"appId": "6da37dd3",
"name": "test-doc-create",
"parentFid": "0",
"createTime": 1666859299651,
"modifyTime": 1666859299651,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": null,
"type": 1,
"sourceType": null,
"sourceId": null,
"suffix": null,
"fileType": null,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tc9",
"appId": "6da37dd3",
"name": "note",
"parentFid": "0",
"createTime": 1666859299839,
"modifyTime": 1666859299839,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tc9",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tci",
"appId": "6da37dd3",
"name": "test-offline-upload",
"parentFid": "0",
"createTime": 1666859301954,
"modifyTime": 1666859302309,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tci",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcj",
"appId": "6da37dd3",
"name": "test-offline-upload",
"parentFid": "0",
"createTime": 1666859302518,
"modifyTime": 1666859302876,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tcj",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tck",
"appId": "6da37dd3",
"name": "test-offline-upload",
"parentFid": "0",
"createTime": 1666859303205,
"modifyTime": 1666859303205,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tck",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcl",
"appId": "6da37dd3",
"name": "test-offline-upload",
"parentFid": "0",
"createTime": 1666859303411,
"modifyTime": 1666859303411,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tcl",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcm",
"appId": "6da37dd3",
"name": "test-offline-upload",
"parentFid": "0",
"createTime": 1666859303832,
"modifyTime": 1666859303832,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tcm",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcn",
"appId": "6da37dd3",
"name": "test-offline-upload",
"parentFid": "0",
"createTime": 1666859304054,
"modifyTime": 1666859304408,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tcn",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tco",
"appId": "6da37dd3",
"name": "test-export",
"parentFid": "0",
"createTime": 1666859304761,
"modifyTime": 1666859304761,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tco",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcp",
"appId": "6da37dd3",
"name": "test-doc-export",
"parentFid": "0",
"createTime": 1666859310593,
"modifyTime": 1666859310593,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tcp",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcq",
"appId": "6da37dd3",
"name": "test-sheet-export",
"parentFid": "0",
"createTime": 1666859310796,
"modifyTime": 1666859310796,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "sheet",
"type": 2,
"sourceType": 1,
"sourceId": "10tcq",
"suffix": "sheet",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcr",
"appId": "6da37dd3",
"name": "test-clean-ref",
"parentFid": "0",
"createTime": 1666859318838,
"modifyTime": 1666859318838,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tcr",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcs",
"appId": "6da37dd3",
"name": "test-size-folder",
"parentFid": "0",
"createTime": 1666859319862,
"modifyTime": 1666859319862,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": null,
"type": 1,
"sourceType": null,
"sourceId": null,
"suffix": null,
"fileType": null,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcu",
"appId": "6da37dd3",
"name": "test",
"parentFid": "0",
"createTime": 1666859323070,
"modifyTime": 1666859323070,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": null,
"type": 1,
"sourceType": null,
"sourceId": null,
"suffix": null,
"fileType": null,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcv",
"appId": "6da37dd3",
"name": "test-@{i+1}",
"parentFid": "0",
"createTime": 1666859323250,
"modifyTime": 1666859323250,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": null,
"type": 1,
"sourceType": null,
"sourceId": null,
"suffix": null,
"fileType": null,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcF",
"appId": "6da37dd3",
"name": "a/b",
"parentFid": "0",
"createTime": 1666859325230,
"modifyTime": 1666859325230,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": null,
"type": 1,
"sourceType": null,
"sourceId": null,
"suffix": null,
"fileType": null,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcG",
"appId": "6da37dd3",
"name": "3a=",
"parentFid": "0",
"createTime": 1666859325427,
"modifyTime": 1666859325427,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": null,
"type": 1,
"sourceType": null,
"sourceId": null,
"suffix": null,
"fileType": null,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcH",
"appId": "6da37dd3",
"name": "SELECT * from",
"parentFid": "0",
"createTime": 1666859325620,
"modifyTime": 1666859325620,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": null,
"type": 1,
"sourceType": null,
"sourceId": null,
"suffix": null,
"fileType": null,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcI",
"appId": "6da37dd3",
"name": "干杯",
"parentFid": "0",
"createTime": 1666859325795,
"modifyTime": 1666859325795,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": null,
"type": 1,
"sourceType": null,
"sourceId": null,
"suffix": null,
"fileType": null,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcJ",
"appId": "6da37dd3",
"name": "🍻😁",
"parentFid": "0",
"createTime": 1666859325974,
"modifyTime": 1666859325974,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": null,
"type": 1,
"sourceType": null,
"sourceId": null,
"suffix": null,
"fileType": null,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcK",
"appId": "6da37dd3",
"name": "👨💻❤️",
"parentFid": "0",
"createTime": 1666859326179,
"modifyTime": 1666859326179,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": null,
"type": 1,
"sourceType": null,
"sourceId": null,
"suffix": null,
"fileType": null,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcL",
"appId": "6da37dd3",
"name": "test-fsfile",
"parentFid": "0",
"createTime": 1666859326415,
"modifyTime": 1666859326415,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tcL",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcM",
"appId": "6da37dd3",
"name": "test-fsfile",
"parentFid": "0",
"createTime": 1666859326772,
"modifyTime": 1666859326772,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tcM",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
}
]
}# 父目录列表
功能：
查询文件、文件夹父目录列表，包括自己本身。
如果是协作文件，仅返回有协作权限的上级目录。
路径：fs/bs/ancestors。
请求方法：GET。
请求参数：
| 参数 | 必须 | 类型 | 备注 |
|---|---|---|---|
fid | 是 | string | 文件 ID |
appUserId | 是 | string | 业务用户 ID |
请求示例：
点击查看
type AncestorItem = {
name: string
fid: string
owner: number
ownerAppUserId: string
}
export async function GET(
fid: string,
appUserId: string
): Promise<ResponseBody<AncestorItem[]>> {
const method = 'GET'
const path = '/fs/bs/ancestors'
const { nonce, timestamp } = genNonce()
const signature = sign(method, path, nonce, timestamp)
const Authorization = authorization(signature)
const headers = {
Authorization,
nonce,
timestamp,
}
const params = {
fid,
appUserId,
}
const resp = await axios.get(path, {
params,
paramsSerializer: (params) => qs.stringify(params),
headers,
})
return resp.data
}响应示例：
点击查看
{
"code": 0,
"message": "success",
"data": [
{
"name": "a",
"fid": "10tbS",
"owner": 1657589576821,
"ownerAppUserId": "dev-docs-001"
},
{
"name": "b",
"fid": "10tbT",
"owner": 1657589576821,
"ownerAppUserId": "dev-docs-001"
},
{
"name": "c",
"fid": "10tbU",
"owner": 1657589576821,
"ownerAppUserId": "dev-docs-001"
},
{
"name": "d",
"fid": "10tbV",
"owner": 1657589576821,
"ownerAppUserId": "dev-docs-001"
}
]
}# 已收藏的文件列表
功能：获取已收藏的文件列表。
路径：fs/bs/collect。
请求方法：GET。
请求参数：
| 参数 | 必须 | 类型 | 备注 |
|---|---|---|---|
pageNum | 是 | number | 页码，从 1 开始。 |
pageSize | 是 | number | 每页条数 |
orderBy | 是 | number | 排序方式 1: 创建时间 2: 修改时间 4：收藏时间 |
folderUp | 是 | boolean | 文件夹是否置顶 |
appUserId | 是 | string | 业务用户 ID |
请求示例：
点击查看
/**
* 获取已收藏的文件列表
* @param pageNum 页数，从 1 开始
* @param pageSize 每页条数，最小为 10
* @param orderBy 排序方式
* @param folderUp 文件夹是否置顶
* @param appUserId 业务用户 ID
*/
export async function GET(
pageNum: number,
pageSize: number,
orderBy: FileListOrder,
folderUp: boolean,
appUserId: string
): Promise<ResponseBody<IflydocsFileList>> {
const method = 'GET'
const path = '/fs/bs/collect'
const { nonce, timestamp } = genNonce()
const signature = sign(method, path, nonce, timestamp)
const Authorization = authorization(signature)
const headers = {
Authorization,
nonce,
timestamp,
}
const params = {
pageNum,
pageSize,
orderBy,
folderUp,
appUserId,
}
const resp = await axios.get(path, {
params,
paramsSerializer: (params) => qs.stringify(params),
headers,
})
return resp.data
}响应示例：
点击查看
{
"code": 0,
"message": "success",
"data": {
"total": 1,
"pageCount": 1,
"count": 1,
"results": [
{
"status": 1,
"fid": "10tbY",
"appId": "6da37dd3",
"name": "test-collect",
"parentFid": "0",
"createTime": 1666859288281,
"modifyTime": 1666859288281,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tbY",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": true,
"top": false,
"size": 0
}
]
}
}# 用户创建的文件列表
功能：
获取用户创建的文件（文件夹）列表。
返回包含所有文件的扁平数组，不包含层级关系。
路径：fs/bs/create。
请求方法：GET。
请求参数：
| 参数 | 必须 | 类型 | 备注 |
|---|---|---|---|
pageNum | 是 | number | 页码，从 1 开始。 |
pageSize | 是 | number | 每页条数 |
orderBy | 是 | number | 排序方式 1: 创建时间 2: 修改时间 |
folderUp | 是 | boolean | 文件夹是否置顶 |
appUserId | 是 | string | 业务用户 ID |
请求示例：
点击查看
/**
* 文件列表排序规则
*/
export enum FileListOrder {
/**
* 创建时间
*/
CreateTime = 1,
/**
* 修改时间
*/
ModifyTime = 2,
}
/**
* 获取用户创建的文件（文件夹）列表
* 返回包含所有文件的扁平数组，不包含层级关系。
* @param pageNum 页数，从 1 开始
* @param pageSize 每页条数，只支持 10、20、50
* @param orderBy 排序规则
* @param folderUp 文件夹是否置顶
* @param uid 用户 ID
*/
export async function GET(
pageNum: number,
pageSize: number,
orderBy: FileListOrder,
folderUp: boolean,
appUserId: string
): Promise<
ResponseBody<IflydocsFileList<IflydocsDocument & IflydocsFileSize>>
> {
const method = 'GET'
const path = '/fs/bs/create'
const { nonce, timestamp } = genNonce()
const signature = sign(method, path, nonce, timestamp)
const Authorization = authorization(signature)
const headers = {
Authorization,
nonce,
timestamp,
}
const params = {
pageNum,
pageSize,
orderBy,
folderUp,
appUserId,
}
const resp = await axios.get(path, {
params,
paramsSerializer: (params) => qs.stringify(params),
headers,
})
return resp.data
}响应示例：
点击查看
{
"code": 0,
"message": "success",
"data": {
"total": 15,
"pageCount": 1,
"count": 15,
"results": [
{
"fid": "10tc5",
"appId": "6da37dd3",
"name": "2",
"parentFid": "10tc4",
"createTime": 1666859295639,
"modifyTime": 1666859295639,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": null,
"type": 1,
"sourceType": null,
"sourceId": null,
"suffix": null,
"fileType": null,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tc4",
"appId": "6da37dd3",
"name": "1",
"parentFid": "0",
"createTime": 1666859295264,
"modifyTime": 1666859295264,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": null,
"type": 1,
"sourceType": null,
"sourceId": null,
"suffix": null,
"fileType": null,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tc1",
"appId": "6da37dd3",
"name": "2",
"parentFid": "10tc0",
"createTime": 1666859291174,
"modifyTime": 1666859291174,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": null,
"type": 1,
"sourceType": null,
"sourceId": null,
"suffix": null,
"fileType": null,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tc0",
"appId": "6da37dd3",
"name": "1",
"parentFid": "0",
"createTime": 1666859290943,
"modifyTime": 1666859290943,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": null,
"type": 1,
"sourceType": null,
"sourceId": null,
"suffix": null,
"fileType": null,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tbU",
"appId": "6da37dd3",
"name": "c",
"parentFid": "10tbT",
"createTime": 1666859283739,
"modifyTime": 1666859283739,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": null,
"type": 1,
"sourceType": null,
"sourceId": null,
"suffix": null,
"fileType": null,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tbT",
"appId": "6da37dd3",
"name": "b",
"parentFid": "10tbS",
"createTime": 1666859283547,
"modifyTime": 1666859283547,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": null,
"type": 1,
"sourceType": null,
"sourceId": null,
"suffix": null,
"fileType": null,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tbS",
"appId": "6da37dd3",
"name": "a",
"parentFid": "0",
"createTime": 1666859283227,
"modifyTime": 1666859283227,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": null,
"type": 1,
"sourceType": null,
"sourceId": null,
"suffix": null,
"fileType": null,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tc6",
"appId": "6da37dd3",
"name": "2",
"parentFid": "10tc4",
"createTime": 1666859296221,
"modifyTime": 1666859296221,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tc6",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tc3",
"appId": "6da37dd3",
"name": "3",
"parentFid": "10tc1",
"createTime": 1666859291824,
"modifyTime": 1666859291824,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tc3",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tc2",
"appId": "6da37dd3",
"name": "2",
"parentFid": "10tc0",
"createTime": 1666859291508,
"modifyTime": 1666859291508,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tc2",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tbZ",
"appId": "6da37dd3",
"name": "test-content",
"parentFid": "0",
"createTime": 1666859289482,
"modifyTime": 1666859290323,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tbZ",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tbY",
"appId": "6da37dd3",
"name": "test-collect",
"parentFid": "0",
"createTime": 1666859288281,
"modifyTime": 1666859288281,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tbY",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tbX",
"appId": "6da37dd3",
"name": "test-collaborators-more",
"parentFid": "0",
"createTime": 1666859286825,
"modifyTime": 1666859286825,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tbX",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 2,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tbW",
"appId": "6da37dd3",
"name": "test-collaborators",
"parentFid": "0",
"createTime": 1666859285106,
"modifyTime": 1666859285106,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tbW",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 2,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tbV",
"appId": "6da37dd3",
"name": "d",
"parentFid": "10tbU",
"createTime": 1666859284172,
"modifyTime": 1666859284172,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tbV",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
}
]
}
}# 最近操作的文件列表
功能：获取用户桌面的文件列表（最近操作的文件列表）
路径：fs/bs/desktop。
请求方法：GET。
请求参数：
| 参数 | 必须 | 类型 | 备注 |
|---|---|---|---|
scope | 否 | string | all（默认）: 全部mine: 我操作的 |
appUserId | 是 | string | 业务用户 ID |
请求示例：
点击查看
/**
* 桌面（最近操作）文件的筛选范围
*/
export enum DesktopScope {
/**
* 全部（包括指定用户有协作权限但由其他人操作的）
*/
ALL = 'all',
/**
* 指定用户操作的
*/
MINE = 'mine',
}
/**
* 获取用户桌面的文件列表（最近操作的文件列表）
* @param scope 筛选范围
* @param uid 用户 ID
*/
export async function GET(
scope: DesktopScope,
appUserId: string
): Promise<ResponseBody<IflydocsDocument[]>> {
const method = 'GET'
const path = '/fs/bs/desktop'
const { nonce, timestamp } = genNonce()
const signature = sign(method, path, nonce, timestamp)
const Authorization = authorization(signature)
const headers = {
Authorization,
nonce,
timestamp,
}
const params = {
scope,
appUserId,
}
const resp = await axios.get(path, {
params,
paramsSerializer: (params) => qs.stringify(params),
headers,
})
return resp.data
}响应示例：
点击查看
{
"code": 0,
"message": "success",
"data": [
{
"fid": "10tbZ",
"appId": "6da37dd3",
"name": "test-content",
"parentFid": "0",
"operateTime": 1666859290316,
"operatorName": "我",
"operator": 1657589576821,
"operate": "更新",
"createTime": 1666859289482,
"modifyTime": 1666859290323,
"creator": 1657589576821,
"creatorName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tbZ",
"suffix": "note",
"fileType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"size": 0,
"highLightName": null
}
]
}# 桌面文件列表
同 最近操作的文件列表。
# 自定义桌面文件列表
功能：桌面文件列表查询，支持业务方根据参数自定义。
路径：fs/bs/v2/desktop。
请求方法：GET。
请求参数：
| 参数 | 必须 | 类型 | 备注 |
|---|---|---|---|
iRead | 否, iRead、iEdit、othersRead、othersEdit 至少需要一个为 true | boolean | 当前用户查看的。 |
iEdit | 否 | boolean | 当前用户编辑的。 |
othersRead | 否 | boolean | 其他用户查看的。 |
othersEdit | 否 | boolean | 其他用户编辑。 |
appUserId | 是 | string | 业务用户 ID |
请求示例：
点击查看
/**
* 自定义查询桌面列表。
* @param iRead 当前用户查看的。
* @param iEdit 当前用户编辑的。
* @param othersRead 其他用户查看的。
* @param othersEdit 其他用户编辑。
* @param appUserId 业务用户 ID
*/
export async function GET(
iRead: boolean,
iEdit: boolean,
othersRead: boolean,
othersEdit: boolean,
appUserId: string
): Promise<ResponseBody<IflydocsDocument[]>> {
const method = 'GET'
const path = '/fs/bs/v2/desktop'
const { nonce, timestamp } = genNonce()
const signature = sign(method, path, nonce, timestamp)
const Authorization = authorization(signature)
const headers = {
Authorization,
nonce,
timestamp,
}
const params = {
iRead,
iEdit,
othersRead,
othersEdit,
appUserId,
}
const resp = await axios.get(path, {
headers,
params,
paramsSerializer: (params) => qs.stringify(params),
})
return resp.data
}响应示例：
点击查看
{
"code": 0,
"message": "success",
"data": [
{
"fid": "10tcn",
"appId": "6da37dd3",
"name": "test-offline-upload",
"parentFid": "0",
"operateTime": 1666859304400,
"operatorName": "我",
"operator": 1657589576821,
"operate": "更新",
"createTime": 1666859304054,
"modifyTime": 1666859304408,
"creator": 1657589576821,
"creatorName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tcn",
"suffix": "note",
"fileType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"size": 0,
"highLightName": null
},
{
"fid": "10tcj",
"appId": "6da37dd3",
"name": "test-offline-upload",
"parentFid": "0",
"operateTime": 1666859302870,
"operatorName": "我",
"operator": 1657589576821,
"operate": "更新",
"createTime": 1666859302518,
"modifyTime": 1666859302876,
"creator": 1657589576821,
"creatorName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tcj",
"suffix": "note",
"fileType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"size": 0,
"highLightName": null
},
{
"fid": "10tci",
"appId": "6da37dd3",
"name": "test-offline-upload",
"parentFid": "0",
"operateTime": 1666859302301,
"operatorName": "我",
"operator": 1657589576821,
"operate": "更新",
"createTime": 1666859301954,
"modifyTime": 1666859302309,
"creator": 1657589576821,
"creatorName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tci",
"suffix": "note",
"fileType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"size": 0,
"highLightName": null
},
{
"fid": "10tbZ",
"appId": "6da37dd3",
"name": "test-content",
"parentFid": "0",
"operateTime": 1666859290316,
"operatorName": "我",
"operator": 1657589576821,
"operate": "更新",
"createTime": 1666859289482,
"modifyTime": 1666859290323,
"creator": 1657589576821,
"creatorName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tbZ",
"suffix": "note",
"fileType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"size": 0,
"highLightName": null
}
]
}# 指定文件名的文件列表
功能：
查询指定文件夹下与指定文件名匹配的文件。
提示
可用来判断文件是否重名。
路径：fs/bs/fsFileList/name。
请求方法：GET。
请求参数：
| 参数 | 必须 | 类型 | 备注 |
|---|---|---|---|
name | 是 | string | 文件名称 |
parentFid | 是 | string | 上级文件夹 ID |
appUserId | 是 | string | 业务用户 ID |
请求示例：
点击查看
/**
* 查询指定文件夹下与指定文件名匹配的文件。
* @param name 文件名称
* @param parentFid 上级文件夹 ID
* @param appUserId 业务用户 ID
* @returns 匹配的文件列表
*/
export async function GET(
name: string,
parentFid: string,
appUserId: string
): Promise<ResponseBody<IflydocsDocument[]>> {
const method = 'GET'
const path = '/fs/bs/fsFileList/name'
const { nonce, timestamp } = genNonce()
const signature = sign(method, path, nonce, timestamp)
const Authorization = authorization(signature)
const headers = {
Authorization,
nonce,
timestamp,
}
const params = {
name,
parentFid,
appUserId,
}
const resp = await axios.get(path, {
headers,
params,
paramsSerializer: (params) => qs.stringify(params),
})
return resp.data
}响应示例：
点击查看
{
"code": 0,
"message": "success",
"data": [
{
"fid": "10tcO",
"appId": "6da37dd3",
"name": "a",
"parentFid": "10tcN",
"createTime": 1666859328086,
"modifyTime": 1666859328086,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tcO",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcP",
"appId": "6da37dd3",
"name": "ab",
"parentFid": "10tcN",
"createTime": 1666859328311,
"modifyTime": 1666859328311,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tcP",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcQ",
"appId": "6da37dd3",
"name": "abc",
"parentFid": "10tcN",
"createTime": 1666859328552,
"modifyTime": 1666859328552,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tcQ",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcR",
"appId": "6da37dd3",
"name": "aa",
"parentFid": "10tcN",
"createTime": 1666859328762,
"modifyTime": 1666859328762,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tcR",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
},
{
"fid": "10tcS",
"appId": "6da37dd3",
"name": "aaa",
"parentFid": "10tcN",
"createTime": 1666859328974,
"modifyTime": 1666859328974,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tcS",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 1,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0
}
]
}# 限定修改时间的文件列表
功能：
查询某个时间点之前修改的文件，如果结果包含嵌套关系则只返回最上级文件夹。
提示
用于查询超过 N 天没有修改的文件，然后删除等需求。
路径：fs/bs/fileList/modifyTime。
请求方法：GET。
请求参数：
| 参数 | 必须 | 类型 | 备注 |
|---|---|---|---|
beforeTime | 是 | number | 时间戳，单位毫秒 |
limit | 是 | number | 限定返回的条数 |
appUserId | 是 | string | 业务用户 ID |
请求示例：
点击查看
/**
* 查询某个时间点之前修改的文件，如果结果包含嵌套关系则只返回最上级文件夹。
* 用于查询超过 N 天没有修改的文件，然后删除等需求。
* @param beforeTime 时间戳，单位毫秒
* @param limit 限定返回的调数
* @param appUserId 业务用户 ID
*/
export async function GET(
beforeTime: number,
limit: number,
appUserId: string
): Promise<ResponseBody<(IflydocsDocument & IflydocsFileSize)[]>> {
const method = 'GET'
const path = '/fs/bs/fileList/modifyTime'
const { nonce, timestamp } = genNonce()
const signature = sign(method, path, nonce, timestamp)
const Authorization = authorization(signature)
const headers = {
Authorization,
nonce,
timestamp,
}
const params = {
beforeTime,
limit,
appUserId,
}
const resp = await axios.get(path, {
headers,
params,
paramsSerializer: (params) => qs.stringify(params),
})
return resp.data
}响应示例：
点击查看
{
"code": 0,
"message": "success",
"data": []
}# 协作给其他用户的文件列表
功能：
查询当前用户协作给他人的、且文件所有者是当前用户的文件列表。
提示
用于查询我协作给他人的文件列表需求。
路径：/fs/bs/invite。
请求方法：GET。
请求参数：
| 参数 | 必须 | 类型 | 备注 |
|---|---|---|---|
orderBy | 否 | number | 1: 更新时间 2: 创建时间 3: 名称 |
folderUp | 否 | boolean | 文件夹是否置顶 |
spread | 否 | boolean | 是否隐藏子孙节点文件，默认 false |
appUserId | 是 | string | 业务用户 ID |
请求示例：
点击查看
/**
* 查询当前用户协作给他人的、且文件所有者是当前用户的文件列表。
* @param orderBy 文件列表排序方式
* @param folderUp 是否文件夹置顶
* @param appUserId 业务用户 ID
* @param spread 是否隐藏子孙文件
*/
export async function GET(
orderBy: FileListOrder,
folderUp: boolean,
appUserId: string,
spread: boolean
): Promise<ResponseBody<(IflydocsDocument & IflydocsFileSize)[]>> {
const method = 'GET'
const path = '/fs/bs/invite'
const { nonce, timestamp } = genNonce()
const signature = sign(method, path, nonce, timestamp)
const Authorization = authorization(signature)
const headers = {
Authorization,
nonce,
timestamp,
}
const params = {
orderBy,
folderUp,
appUserId,
spread,
}
const resp = await axios.get(path, {
headers,
params,
paramsSerializer: (params) => qs.stringify(params),
})
return resp.data
}响应示例：
点击查看
{
"code": 0,
"message": "success",
"data": [
{
"fid": "10tbX",
"appId": "6da37dd3",
"name": "test-collaborators-more",
"parentFid": "0",
"createTime": 1666859286825,
"modifyTime": 1666859286825,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tbX",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 2,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0,
"collaborateTime": 1666859287243
},
{
"fid": "10tbW",
"appId": "6da37dd3",
"name": "test-collaborators",
"parentFid": "0",
"createTime": 1666859285106,
"modifyTime": 1666859285106,
"creator": 1657589576821,
"creatorName": "我",
"modifier": 1657589576821,
"modifierName": "我",
"owner": 1657589576821,
"ownerName": "我",
"docType": "note",
"type": 2,
"sourceType": 1,
"sourceId": "10tbW",
"suffix": "note",
"fileType": 1,
"spaceType": 1,
"collaborativeStatus": 2,
"role": "owner",
"permissions": {
"read": true,
"edit": true,
"annotate": true,
"comment": true,
"create": true,
"delete": true,
"share": true,
"export": true,
"move": true,
"copy": true,
"updateCollaborator": true,
"updateAdmin": true,
"transferSpace": true
},
"collection": false,
"top": false,
"size": 0,
"collaborateTime": 1666859285322
}
]
}