Skip to content

文件列表

POST/web/v1/files/query/listJWT + Turnstile

返回符合指定筛选条件的分页文件列表。默认按创建时间降序排列。

鉴权

Auth Chain: WEB Chain — 需要 Authorization: Bearer <jwt> 和 Turnstile token。 以下请求头由系统自动注入(前端无需处理): X-PORTAL-ACCESS-CODE (Nginx), X-Request-Id (Gateway)

请求参数

NameTypeRequiredInDescription
institutionBizIdstringYesbody机构业务 ID,用于限定查询范围
workspaceBizIdstringNobody可选的工作区业务 ID 筛选
fileCategoryintegerNobody文件类别代码筛选
fileStatusintegerNobody文件状态代码筛选
pageintegerNoquery页码(从零开始)。默认值:`0`
sizeintegerNoquery每页大小。默认值:`20`
sortstringNoquery排序字段和方向。默认值:`createdAt,desc`

成功响应

成功200
{
  "version": "1.3.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "content": [
      {
        "bizId": "file_abc123",
        "bucket": "default",
        "objectKey": "uploads/2026/03/21/file_abc123.pdf",
        "originalFilename": "invoice.pdf",
        "fileSize": 102400,
        "contentType": "application/pdf",
        "fileCategory": "DOCUMENT",
        "fileStatus": "ACTIVE",
        "etag": "d41d8cd98f00b204e9800998ecf8427e",
        "remark": "Monthly invoice",
        "createdAt": "2026-03-21T00:00:00Z",
        "createdBy": "acc_user123"
      }
    ],
    "totalElements": 1,
    "totalPages": 1,
    "size": 20,
    "number": 0
  }
}

错误响应

Unauthorized401
{
  "success": false,
  "code": "4010",
  "message": "Invalid or expired token"
}
Bad Request400
{
  "success": false,
  "code": "4000",
  "message": "Institution business ID is required"
}

说明

  • institutionBizId 为必填项,所有结果限定在单个机构范围内。
  • 使用 POST 方法以支持请求体中的复杂筛选条件。

内部文档