跳到主要内容

悦库网盘 API 文档

OpenAPI 定义由 API 源代码维护。

Base URLs:

Authentication

  • HTTP Authentication, scheme: bearer

File

POST 创建文件​

POST /File/Create

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-DirIdheaderstring是目录 ID。
X-YFS-Nameheaderstring是文件或目录名称。URL 编码的值会在服务端校验前自动解码。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": "string",
    "parentId": "string",
    "storeId": 0,
    "pathId": 0,
    "path": "string",
    "grade": 0,
    "name": "string",
    "type": "string",
    "size": 0,
    "createdBy": 0,
    "accessedBy": 0,
    "editedBy": 0,
    "modifiedBy": 0,
    "createdTime": 0,
    "accessedTime": 0,
    "editedTime": 0,
    "modifiedTime": 0,
    "clientId": "string",
    "cluster": "string",
    "offset": 0,
    "state": 0,
    "taskId": 0,
    "taskState": "string",
    "version": 0,
    "isFavorite": true,
    "isLock": true,
    "modificator": "string"
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK创建的文件元数据。FileInfoResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

POST 创建文件夹​

POST /File/CreateDir

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-DirIdheaderstring是目录 ID。
X-YFS-Nameheaderstring是文件或目录名称。URL 编码的值会在服务端校验前自动解码。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": "string",
    "parentId": "string",
    "storeId": 0,
    "pathId": 0,
    "path": "string",
    "grade": 0,
    "name": "string",
    "type": "string",
    "size": 0,
    "createdBy": 0,
    "accessedBy": 0,
    "editedBy": 0,
    "modifiedBy": 0,
    "createdTime": 0,
    "accessedTime": 0,
    "editedTime": 0,
    "modifiedTime": 0,
    "clientId": "string",
    "cluster": "string",
    "offset": 0,
    "state": 0,
    "taskId": 0,
    "taskState": "string",
    "version": 0,
    "isFavorite": true,
    "isLock": true,
    "modificator": "string"
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK创建的目录元数据。FileInfoResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取文件信息列表​

GET /File/List

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-DirIdheaderstring是目录 ID。
X-YFS-SortFieldheaderstring否排序字段。
X-YFS-SortOrderheaderstring否排序方向。
X-YFS-PageSizeheaderinteger否分页大小。分页接口的有效范围为 1-2000。
X-YFS-PageNumberheaderinteger否页码，从 1 开始。
X-YFS-FetchTaskheaderstring否是否在文件列表项中附带传输任务状态。

枚举值​

属性值
X-YFS-SortOrderASC
X-YFS-SortOrderDESC
X-YFS-FetchTasktrue
X-YFS-FetchTaskfalse
X-YFS-FetchTask1
X-YFS-FetchTask0

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "total": 0,
    "pageSize": 0,
    "pageNumber": 0,
    "list": [
      {
        "id": "string",
        "parentId": "string",
        "storeId": 0,
        "pathId": 0,
        "path": "string",
        "grade": 0,
        "name": "string",
        "type": "string",
        "size": 0,
        "createdBy": 0,
        "accessedBy": 0,
        "editedBy": 0,
        "modifiedBy": 0,
        "createdTime": 0,
        "accessedTime": 0,
        "editedTime": 0,
        "modifiedTime": 0,
        "clientId": "string",
        "cluster": "string",
        "offset": 0,
        "state": 0,
        "taskId": 0,
        "taskState": "string",
        "version": 0,
        "isFavorite": true,
        "isLock": true,
        "modificator": "string"
      }
    ]
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK分页文件列表。FileListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取文件摘要信息列表​

GET /File/BriefList

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-DirIdheaderstring是目录 ID。
X-YFS-SortFieldheaderstring否排序字段。
X-YFS-SortOrderheaderstring否排序方向。
X-YFS-Optionsheaderstring否逗号分隔的摘要列表选项，如 detectDescendant 或 detectDescendantFile。

枚举值​

属性值
X-YFS-SortOrderASC
X-YFS-SortOrderDESC

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": "string",
      "parentId": "string",
      "storeId": 0,
      "name": "string",
      "size": 0,
      "type": "string",
      "editedTime": 0,
      "descendantFile": true,
      "descendant": true
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK文件摘要列表。FileBriefInfoListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取子目录列表​

GET /File/SubDir

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-DirIdheaderstring是目录 ID。
X-YFS-SortFieldheaderstring否排序字段。
X-YFS-SortOrderheaderstring否排序方向。

枚举值​

属性值
X-YFS-SortOrderASC
X-YFS-SortOrderDESC

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": "string",
      "parentId": "string",
      "storeId": 0,
      "pathId": 0,
      "path": "string",
      "grade": 0,
      "name": "string",
      "type": "string",
      "size": 0,
      "createdBy": 0,
      "accessedBy": 0,
      "editedBy": 0,
      "modifiedBy": 0,
      "createdTime": 0,
      "accessedTime": 0,
      "editedTime": 0,
      "modifiedTime": 0,
      "clientId": "string",
      "cluster": "string",
      "offset": 0,
      "state": 0,
      "taskId": 0,
      "taskState": "string",
      "version": 0,
      "isFavorite": true,
      "isLock": true,
      "modificator": "string"
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK子目录列表。FileInfoListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取子目录树列表​

GET /File/SubTree

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-DirIdheaderstring是目录 ID。
X-YFS-SortFieldheaderstring否排序字段。
X-YFS-SortOrderheaderstring否排序方向。

枚举值​

属性值
X-YFS-SortOrderASC
X-YFS-SortOrderDESC

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": "string",
      "storeId": 0,
      "parentId": "string",
      "pathId": 0,
      "path": "string",
      "name": "string",
      "size": 0,
      "type": 0,
      "grade": 0,
      "editedTime": "string"
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK子目录树。FileTreeNodeListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 根据文件名或内容搜索文件​

GET /File/Search

请求参数​

名称位置类型必选说明
X-YFS-SearchTypeheaderstring否搜索策略。常用值为 name（按名称）或 content（按内容）。
X-YFS-SearchKeyheaderstring否搜索关键词。
X-YFS-StoreTypeheaderstring否空间类型过滤。
X-YFS-StoreIdheaderinteger否可选的空间 ID。
X-YFS-DirIdheaderstring否可选的目录 ID。
X-YFS-FileTypeheaderstring否搜索时使用的文件类型过滤。常用值为 file（文件）或 dir（目录）。
X-YFS-PageNumberheaderinteger否页码，从 1 开始。
X-YFS-PageSizeheaderinteger否搜索结果的分页大小。接受任意正整数，无上限。
X-YFS-SortFieldheaderstring否排序字段。
X-YFS-SortOrderheaderstring否排序方向。

枚举值​

属性值
X-YFS-FileTypefile
X-YFS-FileTypedir
X-YFS-SortOrderASC
X-YFS-SortOrderDESC

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "total": 0,
    "pageSize": 0,
    "pageNumber": 0,
    "list": [
      {
        "id": "string",
        "storeId": 0,
        "pathId": 0,
        "path": "string",
        "name": "string",
        "type": "string",
        "size": 0,
        "editedTime": 0,
        "editedBy": 0,
        "storeName": "string",
        "editor": "string",
        "isFavorite": true,
        "isLock": true,
        "content": [
          "string"
        ]
      }
    ]
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK搜索结果。FileSearchResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取文件信息​

GET /File/Info

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-FileIdheaderstring是文件 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": "string",
    "parentId": "string",
    "storeId": 0,
    "pathId": 0,
    "path": "string",
    "grade": 0,
    "name": "string",
    "type": "string",
    "size": 0,
    "createdBy": 0,
    "accessedBy": 0,
    "editedBy": 0,
    "modifiedBy": 0,
    "createdTime": 0,
    "accessedTime": 0,
    "editedTime": 0,
    "modifiedTime": 0,
    "clientId": "string",
    "cluster": "string",
    "offset": 0,
    "state": 0,
    "taskId": 0,
    "taskState": "string",
    "version": 0,
    "isFavorite": true,
    "isLock": true,
    "modificator": "string"
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK文件元数据。FileInfoResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取文件或文件夹大小​

GET /File/Size

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-FileIdheaderstring是文件 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": 0
}

返回结果​

状态码状态码含义说明数据模型
200OK文件或目录大小。IntegerResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

POST 批量获取文件路径名称​

POST /File/GetPathNameById

Body 请求参数

{
  "fileIds": [
    "string"
  ]
}

请求参数​

名称位置类型必选说明
bodybodyFileIdListRequest是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "property1": "string",
    "property2": "string"
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK以文件 ID 为键的文件路径名称。StringMapResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

DELETE 删除文件至回收站​

DELETE /File/Remove

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-Idsheaderstring是逗号分隔的文件 ID 列表。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK文件已移入回收站。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

DELETE 彻底删除文件​

DELETE /File/Delete

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-Idsheaderstring是逗号分隔的文件 ID 列表。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK文件已彻底删除。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

PUT 重命名文件​

PUT /File/Rename

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-FileIdheaderstring是文件 ID。
X-YFS-Nameheaderstring是文件或目录名称。URL 编码的值会在服务端校验前自动解码。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK重命名成功。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取文件绝对路径​

GET /File/Path

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-FileIdheaderstring是文件 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": "string"
}

返回结果​

状态码状态码含义说明数据模型
200OK绝对路径字符串。StringResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

POST 开始文件操作​

POST /File/Opt/Start

Body 请求参数

{
  "property1": 0,
  "property2": 0
}

请求参数​

名称位置类型必选说明
X-YFS-Operateheaderstring是文件操作类型，如 move、copy、save、replace 或 skip。
X-YFS-DestStoreIdheaderinteger否文件操作的目标空间 ID。
X-YFS-DestDirIdheaderstring否文件操作的目标目录 ID。
bodybodyFileStoreMapRequest是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "taskId": 1
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK文件操作已启动。FileOptStartResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取文件操作状态​

GET /File/Opt/State

请求参数​

名称位置类型必选说明
X-YFS-Idheaderstring是通用资源 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "state": "count",
    "operate": "move",
    "info": "string",
    "message": "string"
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK文件操作状态。FileOptStateResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

PUT 解决文件操作冲突​

PUT /File/Opt/Resovle

请求参数​

名称位置类型必选说明
X-YFS-Idheaderstring是通用资源 ID。
X-YFS-Operateheaderstring是文件操作类型，如 move、copy、save、replace 或 skip。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK文件操作冲突已解决。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

DELETE 取消文件操作​

DELETE /File/Opt/Cancel

请求参数​

名称位置类型必选说明
X-YFS-Idheaderstring是通用资源 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK文件操作已取消。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取操作目标文件列表​

GET /File/Opt/Files

请求参数​

名称位置类型必选说明
X-YFS-Idheaderstring是通用资源 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": "string",
      "parentId": "string",
      "storeId": 0,
      "pathId": 0,
      "path": "string",
      "grade": 0,
      "name": "string",
      "type": "string",
      "size": 0,
      "createdBy": 0,
      "accessedBy": 0,
      "editedBy": 0,
      "modifiedBy": 0,
      "createdTime": 0,
      "accessedTime": 0,
      "editedTime": 0,
      "modifiedTime": 0,
      "clientId": "string",
      "cluster": "string",
      "offset": 0,
      "state": 0,
      "taskId": 0,
      "taskState": "string",
      "version": 0,
      "isFavorite": true,
      "isLock": true,
      "modificator": "string"
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK操作影响的文件列表。FileInfoListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

PUT 在线解压 zip 文件​

PUT /File/Unzip

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-FileIdheaderstring是文件 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK解压已启动。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取文件缩略图​

GET /File/Thumb

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-FileIdheaderstring是文件 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": "string"
}

返回结果​

状态码状态码含义说明数据模型
200OK文件缩略图。StringResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

POST 批量获取缩略图​

POST /File/Thumbs

Body 请求参数

{
  "property1": 0,
  "property2": 0
}

请求参数​

名称位置类型必选说明
bodybodyFileStoreMapRequest是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "property1": "string",
    "property2": "string"
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK以文件 ID 为键的缩略图。StringMapResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取文件概要信息​

GET /File/Summary

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-FileIdheaderstring是文件 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "name": "string",
    "type": "string",
    "size": 0,
    "path": "string",
    "createdBy": "string",
    "editedBy": "string",
    "createdTime": 0,
    "editedTime": 0
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK文件概要信息。FileSummaryResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取文件详情信息​

GET /File/Detail

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-FileIdheaderstring是文件 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "dirCount": 0,
    "fileCount": 0,
    "size": 0,
    "editedBy": "string",
    "editedTime": 0,
    "rights": [
      "string"
    ]
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK文件详情。FileDetailResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取文件操作日志​

GET /File/Logs

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-FileIdheaderstring是文件 ID。
X-YFS-PageSizeheaderinteger否分页大小。分页接口的有效范围为 1-2000。
X-YFS-PageNumberheaderinteger否页码，从 1 开始。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "total": 0,
    "pageSize": 0,
    "pageNumber": 0,
    "list": [
      {
        "fileId": "string",
        "type": "string",
        "fileType": "string",
        "filePath": "string",
        "version": 0,
        "createdTime": "string",
        "detail": "string",
        "username": "string"
      }
    ]
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK文件操作日志条目。FileOperationLogListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取当前用户对文件的权限​

GET /File/Permission

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-FileIdheaderstring是文件 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    "string"
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK当前用户的文件权限映射。UserRightListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

POST 通过 form-data 上传文件​

POST /File/Upload

Body 请求参数

{}

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-DirIdheaderstring是目录 ID。
bodybodyobject是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": "string",
      "parentId": "string",
      "storeId": 0,
      "pathId": 0,
      "path": "string",
      "grade": 0,
      "name": "string",
      "type": "string",
      "size": 0,
      "createdBy": 0,
      "accessedBy": 0,
      "editedBy": 0,
      "modifiedBy": 0,
      "createdTime": 0,
      "accessedTime": 0,
      "editedTime": 0,
      "modifiedTime": 0,
      "clientId": "string",
      "cluster": "string",
      "offset": 0,
      "state": 0,
      "taskId": 0,
      "taskState": "string",
      "version": 0,
      "isFavorite": true,
      "isLock": true,
      "modificator": "string"
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK上传结果。FileInfoListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取指定类型的文件列表​

GET /File/List/ByType

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-DirIdheaderstring是目录 ID。
X-YFS-Typeheaderstring是业务文件类型。
X-YFS-SortFieldheaderstring否排序字段。
X-YFS-SortOrderheaderstring否排序方向。

枚举值​

属性值
X-YFS-SortOrderASC
X-YFS-SortOrderDESC

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": "string",
      "parentId": "string",
      "storeId": 0,
      "name": "string",
      "size": 0,
      "type": "string",
      "editedTime": 0,
      "descendantFile": true,
      "descendant": true
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK按类型过滤的文件列表。FileBriefInfoListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 下载文件​

GET /File/Download

请求参数​

名称位置类型必选说明
tokenquerystring是下载令牌。
storeIdqueryinteger是空间 ID。
fileIdquerystring是文件 ID。
namequerystring否可选的下载文件名。

返回结果​

状态码状态码含义说明数据模型
200OK二进制流响应。None
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 下载文件图标​

GET /File/Icon

请求参数​

名称位置类型必选说明
tokenquerystring是下载令牌。
storeIdqueryinteger是空间 ID。
fileIdquerystring是文件 ID。

返回结果​

状态码状态码含义说明数据模型
200OK二进制流响应。None
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 下载系统日志归档​

GET /Download/Log/{token}

请求参数​

名称位置类型必选说明
tokenpathstring是一次性访问令牌。

返回结果​

状态码状态码含义说明数据模型
200OK二进制流响应。None
401Unauthorized需要认证或 Token 无效。None
500Internal Server Error服务器内部错误。None

GET 打开文件​

GET /File/Open/{token}/{storeId}/{fileId}

请求参数​

名称位置类型必选说明
tokenpathstring是一次性访问令牌。
storeIdpathinteger是空间 ID。
fileIdpathstring是文件 ID。

返回结果​

状态码状态码含义说明数据模型
200OK二进制流响应。None
302Found重定向到协作预览或下载端点。None
401Unauthorized需要认证或 Token 无效。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 打开文件历史版本​

GET /File/Open/Version/{token}/{storeId}/{fileId}/{version}

请求参数​

名称位置类型必选说明
tokenpathstring是一次性访问令牌。
storeIdpathinteger是空间 ID。
fileIdpathstring是文件 ID。
versionpathinteger是版本号。

返回结果​

状态码状态码含义说明数据模型
200OK二进制流响应。None
302Found重定向到协作预览或下载端点。None
401Unauthorized需要认证或 Token 无效。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 打开回收站文件​

GET /File/Open/Recycle/{token}/{storeId}/{fileId}

请求参数​

名称位置类型必选说明
tokenpathstring是一次性访问令牌。
storeIdpathinteger是空间 ID。
fileIdpathstring是文件 ID。

返回结果​

状态码状态码含义说明数据模型
200OK二进制流响应。None
302Found重定向到协作预览或下载端点。None
401Unauthorized需要认证或 Token 无效。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 打开消息附件​

GET /File/Open/Message/{token}/{messageId}

请求参数​

名称位置类型必选说明
tokenpathstring是一次性访问令牌。
messageIdpathinteger是消息 ID。

返回结果​

状态码状态码含义说明数据模型
200OK二进制流响应。None
302Found重定向到协作预览或下载端点。None
401Unauthorized需要认证或 Token 无效。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 打开分享文件​

GET /File/Open/Share

请求参数​

名称位置类型必选说明
codequerystring是分享码。
passwordquerystring否可选的分享密码或密码哈希。
tokenquerystring否可选的身份验证令牌，用于授权分享。

返回结果​

状态码状态码含义说明数据模型
200OK二进制流响应。None
302Found重定向到协作预览或下载端点。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 连通性测试​

GET /Test

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK连通性测试结果。SuccessEnvelope

POST 连通性测试​

POST /Test

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK连通性测试结果。SuccessEnvelope

User

POST 获取用户日志列表​

POST /User/GetLogs

Body 请求参数

{
  "begin": "2024-01-01",
  "end": "2024-01-31",
  "types": [
    "string"
  ],
  "userIds": [
    1
  ],
  "pageNumber": 1,
  "pageSize": 1
}

请求参数​

名称位置类型必选说明
bodybodyUserLogQuery是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "total": 0,
    "pageSize": 1,
    "pageNumber": 1,
    "list": [
      {
        "id": 1,
        "account": "string",
        "username": "string",
        "type": "store",
        "recordId": 1,
        "recordType": "string",
        "ip": "string",
        "platform": "string",
        "createdTime": "string",
        "object": "string",
        "path": "string",
        "detail": "string"
      }
    ]
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK用户日志。UserLogListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

PUT 注销​

PUT /User/Logout

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK用户已注销。SuccessEnvelope
401Unauthorized需要认证或 Token 无效。None
500Internal Server Error服务器内部错误。None

GET 获取登录信息​

GET /User/Login/Info

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "userInfo": {
      "id": 1,
      "account": "string",
      "name": "string",
      "type": "common",
      "quota": 0
    },
    "service": {
      "standalone": true,
      "web": {
        "url": "string"
      },
      "api": {
        "url": "string"
      },
      "doc": {
        "url": "string"
      },
      "oss": {
        "scheme": "http",
        "url": "string",
        "type": "string",
        "ssl": true,
        "endpoint": "string",
        "pathStyle": true,
        "region": "string",
        "bucket": "string",
        "credential": {}
      },
      "yserver": {
        "url": "string"
      }
    }
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK当前用户登录上下文。UserLoginInfoResponseEnvelope
401Unauthorized需要认证或 Token 无效。None
500Internal Server Error服务器内部错误。None

POST 创建用户​

POST /User/Create

Body 请求参数

[
  {
    "account": "string",
    "password": "string",
    "name": "string",
    "quota": 0,
    "gender": "m",
    "email": "string",
    "mobile": "string",
    "state": "string",
    "extranet": "true",
    "parentInfos": [
      {
        "parentId": 1,
        "inherit": "true"
      }
    ],
    "roleInfos": [
      {
        "roleId": 1,
        "objId": 0
      }
    ]
  }
]

请求参数​

名称位置类型必选说明
bodybodyUserCreateBatchRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已创建的用户。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取用户详情​

GET /User/Info

请求参数​

名称位置类型必选说明
X-YFS-UserIdheaderstring是用户 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": 1,
    "account": "string",
    "name": "string",
    "type": "string",
    "quota": 0,
    "gender": "string",
    "email": "string",
    "mobile": "string",
    "sn": "string",
    "state": "string",
    "used": 0,
    "extranet": "true",
    "path": [
      {
        "parentId": 1,
        "parentRelPathName": "string",
        "parentName": "string",
        "unitId": 1,
        "relPath": "string",
        "relPathName": "string",
        "inherit": "true"
      }
    ],
    "roles": [
      {
        "roleId": 1,
        "roleName": "string",
        "objInfos": [
          {
            "objId": null,
            "objType": null,
            "objRelPathName": null,
            "objName": null
          }
        ]
      }
    ],
    "sso": [
      {}
    ]
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK用户详情。UserDetailResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

PUT 更新用户​

PUT /User/Update

Body 请求参数

[
  {
    "id": 1,
    "account": "string",
    "name": "string",
    "sn": "string",
    "state": "string",
    "password": "string",
    "quota": 0,
    "gender": "m",
    "email": "string",
    "mobile": "string",
    "joinTime": "2024-01-01",
    "successor": 1,
    "extranet": "true",
    "parentInfos": [
      {
        "parentId": 1,
        "inherit": "true"
      }
    ],
    "roleInfos": {
      "add": [
        {
          "roleId": 1,
          "objId": 0
        }
      ],
      "delete": [
        {
          "roleId": 1,
          "objId": 0
        }
      ]
    }
  }
]

请求参数​

名称位置类型必选说明
bodybodyUserUpdateBatchRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已更新的用户。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

DELETE 删除用户​

DELETE /User/Delete

请求参数​

名称位置类型必选说明
X-YFS-UserIdsheaderstring是逗号分隔的用户 ID。
X-YFS-Successorheaderstring是删除操作时使用的后续组织或用户 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已删除的用户。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

PUT 向组织添加现有用户​

PUT /User/AddUser

请求参数​

名称位置类型必选说明
X-YFS-OrgIdheaderstring是组织 ID。
X-YFS-UserIdsheaderstring是逗号分隔的用户 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK用户已添加到组织。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取用户的文件权限​

GET /User/GetFileRights

请求参数​

名称位置类型必选说明
X-YFS-UserIdheaderstring是用户 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "subId": 1,
      "subName": "string",
      "objId": "string",
      "objType": "string",
      "objPathName": "string",
      "sourceType": "string",
      "source": "string"
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK用户的文件权限。UserFilePolicyListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取用户的职能权限​

GET /User/GetPositionRights

请求参数​

名称位置类型必选说明
X-YFS-UserIdheaderstring是用户 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "subId": 1,
      "subName": "string",
      "objId": 0,
      "objPathName": "string",
      "sourceType": "string",
      "source": "string"
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK用户的职能权限。UserPositionPolicyListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取用户角色列表​

GET /User/GetRoles

请求参数​

名称位置类型必选说明
X-YFS-UserIdheaderstring是用户 ID。
X-YFS-SortFieldheaderstring否排序字段。
X-YFS-SortOrderheaderstring否排序方向。

枚举值​

属性值
X-YFS-SortOrderASC
X-YFS-SortOrderDESC

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "name": "string",
      "owner": 0,
      "level": "string",
      "subId": 1,
      "roleId": 1,
      "objId": 0,
      "objPathName": "string",
      "source": "string"
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK用户角色列表。UserRoleListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取用户视图权限​

GET /User/GetViewRights

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "property1": true,
    "property2": true
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK用户视图权限。UserPermissionMapResponseEnvelope
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 登录​

GET /User/Login

请求参数​

名称位置类型必选说明
X-YFS-Accountheaderstring是用户账号名称。
X-YFS-Passwordheaderstring是URL 解码后的 SHA-256 密码摘要。
X-YFS-ClientIdheaderstring否可选的客户端标识符。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "userInfo": {
      "id": 1,
      "account": "string",
      "name": "string",
      "type": "common",
      "quota": 0
    },
    "userRights": {
      "property1": true,
      "property2": true
    },
    "service": {
      "standalone": true,
      "web": {
        "url": "string"
      },
      "api": {
        "url": "string"
      },
      "doc": {
        "url": "string"
      },
      "oss": {
        "scheme": "http",
        "url": "string",
        "type": "string",
        "ssl": true,
        "endpoint": "string",
        "pathStyle": true,
        "region": "string",
        "bucket": "string",
        "credential": {}
      },
      "yserver": {
        "url": "string"
      }
    },
    "token": "string"
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK包含 Token 和服务配置的登录上下文。UserLoginResponseEnvelope
400Bad Request请求无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

Message

GET 获取消息附加数据​

GET /Message/Info

请求参数​

名称位置类型必选说明
X-YFS-MessageIdheaderinteger是消息 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": 1,
    "type": "shareFile",
    "status": "string",
    "userId": 1,
    "dataId": 1,
    "data": {
      "id": "string",
      "parentId": "string",
      "storeId": 0,
      "pathId": 0,
      "path": "string",
      "grade": 0,
      "name": "string",
      "type": "string",
      "size": 0,
      "createdBy": 0,
      "accessedBy": 0,
      "editedBy": 0,
      "modifiedBy": 0,
      "createdTime": 0,
      "accessedTime": 0,
      "editedTime": 0,
      "modifiedTime": 0,
      "clientId": "string",
      "cluster": "string",
      "offset": 0,
      "state": 0,
      "taskId": 0,
      "taskState": "string",
      "version": 0,
      "isFavorite": true,
      "isLock": true,
      "modificator": "string"
    },
    "topic": "string",
    "structuredTopic": {},
    "createdTime": "string"
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK消息附加信息。MessageInfoResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 下载消息附件​

GET /Download/MessageFile/{token}/{messageId}

请求参数​

名称位置类型必选说明
tokenpathstring是一次性访问令牌。
messageIdpathinteger是消息 ID。

返回结果​

状态码状态码含义说明数据模型
200OK二进制流响应。None
401Unauthorized需要认证或 Token 无效。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 下载指定名称的消息附件​

GET /Download/MessageFile/{token}/{messageId}/{name}

请求参数​

名称位置类型必选说明
tokenpathstring是一次性访问令牌。
messageIdpathinteger是消息 ID。
namepathstring是下载文件名。

返回结果​

状态码状态码含义说明数据模型
200OK二进制流响应。None
401Unauthorized需要认证或 Token 无效。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取消息图标​

GET /Message/Icon/{token}/{messageId}

请求参数​

名称位置类型必选说明
tokenpathstring是一次性访问令牌。
messageIdpathinteger是消息 ID。

返回结果​

状态码状态码含义说明数据模型
200OK二进制流响应。None
401Unauthorized需要认证或 Token 无效。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

Organization

GET 获取组织树​

GET /Organization/GetOrgStructure

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "parentId": 0,
      "unitId": 1,
      "name": "string",
      "type": "unit",
      "children": [
        {
          "id": 1,
          "parentId": 0,
          "unitId": 1,
          "name": "string",
          "type": "unit",
          "children": [
            {}
          ],
          "userIds": [
            1
          ]
        }
      ],
      "userIds": [
        1
      ]
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK组织树。OrganizationTreeResponseEnvelope
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取组织的子节点​

GET /Organization/Children

请求参数​

名称位置类型必选说明
X-YFS-OrgIdheaderstring是组织 ID。
X-YFS-Typesheaderstring否逗号分隔的组织节点类型。
X-YFS-IncludeBridgeheaderstring否是否包含桥接组织。

枚举值​

属性值
X-YFS-IncludeBridgetrue
X-YFS-IncludeBridgefalse
X-YFS-IncludeBridge1
X-YFS-IncludeBridge0

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "name": "string",
      "type": "unit",
      "account": "string",
      "email": "string",
      "mobile": "string",
      "state": "string",
      "path": [
        {
          "parentId": 0,
          "parentName": "string",
          "unitId": 1,
          "unitName": "string",
          "relPath": "string",
          "absPath": "string",
          "relPathName": "string"
        }
      ],
      "managers": [
        {
          "managerId": 1,
          "managerName": "string",
          "managerRelPathName": "string",
          "roleInfos": [
            {}
          ]
        }
      ],
      "roles": [
        {
          "roleId": 1,
          "roleName": "string",
          "objInfos": [
            {}
          ]
        }
      ]
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK子组织节点。OrganizationNodeListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取组织的子孙节点​

GET /Organization/Descendants

请求参数​

名称位置类型必选说明
X-YFS-OrgIdheaderstring是组织 ID。
X-YFS-UnitIdheaderstring否可选的组织单元 ID。
X-YFS-Typesheaderstring否逗号分隔的组织节点类型。
X-YFS-IncludeBridgeheaderstring否是否包含桥接组织。
X-YFS-IncludeLeaveheaderstring否是否包含已离职用户。

枚举值​

属性值
X-YFS-IncludeBridgetrue
X-YFS-IncludeBridgefalse
X-YFS-IncludeBridge1
X-YFS-IncludeBridge0
X-YFS-IncludeLeavetrue
X-YFS-IncludeLeavefalse
X-YFS-IncludeLeave1
X-YFS-IncludeLeave0

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "name": "string",
      "type": "unit",
      "account": "string",
      "email": "string",
      "mobile": "string",
      "state": "string",
      "path": [
        {
          "parentId": 0,
          "parentName": "string",
          "unitId": 1,
          "unitName": "string",
          "relPath": "string",
          "absPath": "string",
          "relPathName": "string"
        }
      ],
      "managers": [
        {
          "managerId": 1,
          "managerName": "string",
          "managerRelPathName": "string",
          "roleInfos": [
            {}
          ]
        }
      ],
      "roles": [
        {
          "roleId": 1,
          "roleName": "string",
          "objInfos": [
            {}
          ]
        }
      ]
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK子孙组织节点。OrganizationNodeListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 根据关键字搜索组织节点​

GET /Organization/Search

请求参数​

名称位置类型必选说明
X-YFS-OrgIdheaderstring是组织 ID。
X-YFS-UnitIdheaderstring否可选的组织单元 ID。
X-YFS-Typesheaderstring否逗号分隔的组织节点类型。
X-YFS-SearchKeyheaderstring否搜索关键词。
X-YFS-SearchTypeheaderstring否搜索策略。常用值为 name（按名称）或 content（按内容）。
X-YFS-LeaveAbleheaderstring否搜索结果是否允许包含已离职用户。

枚举值​

属性值
X-YFS-LeaveAbletrue
X-YFS-LeaveAblefalse
X-YFS-LeaveAble1
X-YFS-LeaveAble0

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "name": "string",
      "type": "unit",
      "account": "string",
      "email": "string",
      "mobile": "string",
      "state": "string",
      "path": [
        {
          "parentId": 0,
          "parentName": "string",
          "unitId": 1,
          "unitName": "string",
          "relPath": "string",
          "absPath": "string",
          "relPathName": "string"
        }
      ],
      "managers": [
        {
          "managerId": 1,
          "managerName": "string",
          "managerRelPathName": "string",
          "roleInfos": [
            {}
          ]
        }
      ],
      "roles": [
        {
          "roleId": 1,
          "roleName": "string",
          "objInfos": [
            {}
          ]
        }
      ]
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK匹配的组织节点。OrganizationNodeListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取组织详情​

GET /Organization/Info

请求参数​

名称位置类型必选说明
X-YFS-Idheaderstring是通用资源 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": 1,
    "name": "string",
    "type": "unit",
    "quota": 0,
    "path": [
      {
        "parentId": 0,
        "parentName": "string",
        "parentRelPathName": "string",
        "unitId": 1,
        "unitName": "string",
        "unitRelPathName": "string",
        "relPath": "string",
        "relPathName": "string",
        "inherit": "true"
      }
    ],
    "managers": [
      {
        "managerId": 1,
        "managerName": "string",
        "managerRelPathName": "string",
        "roleInfos": [
          {
            "id": null,
            "name": null
          }
        ]
      }
    ],
    "roles": [
      {
        "roleId": 1,
        "roleName": "string",
        "objInfos": [
          {
            "objId": null,
            "objType": null,
            "objRelPathName": null,
            "objName": null
          }
        ]
      }
    ],
    "used": 0,
    "sso": [
      {}
    ]
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK组织详情。OrganizationDetailResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

POST 创建组织​

POST /Organization/Create

Body 请求参数

[
  {
    "parentInfos": [
      {
        "id": 1,
        "inherit": "true"
      }
    ],
    "type": "unit",
    "name": "string",
    "managerInfos": [
      {
        "subId": 1,
        "roleId": 1
      }
    ],
    "roleInfos": [
      {
        "roleId": 1,
        "objId": 0
      }
    ]
  }
]

请求参数​

名称位置类型必选说明
bodybodyOrganizationCreateBatchRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已创建的组织。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

PUT 更新组织​

PUT /Organization/Update

Body 请求参数

[
  {
    "id": 1,
    "parentInfos": [
      {
        "parentId": 1,
        "inherit": "true"
      }
    ],
    "type": "unit",
    "name": "string",
    "quota": 0,
    "managerInfos": {
      "add": [
        {
          "subId": 1,
          "roleId": 1,
          "objId": 0
        }
      ],
      "delete": [
        {
          "subId": 1,
          "roleId": 1,
          "objId": 0
        }
      ]
    },
    "roleInfos": {
      "add": [
        {
          "subId": 1,
          "roleId": 1,
          "objId": 0
        }
      ],
      "delete": [
        {
          "subId": 1,
          "roleId": 1,
          "objId": 0
        }
      ]
    }
  }
]

请求参数​

名称位置类型必选说明
bodybodyOrganizationUpdateBatchRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已更新的组织。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

DELETE 批量删除组织​

DELETE /Organization/BatchDelete

请求参数​

名称位置类型必选说明
X-YFS-Idsheaderstring是逗号分隔的文件 ID 列表。
X-YFS-Successorheaderstring是删除操作时使用的后续组织或用户 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已删除的组织。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

POST 从组织中移除节点​

POST /Organization/Remove

Body 请求参数

{
  "parentId": 1,
  "id": 1,
  "isRevokeRole": true
}

请求参数​

名称位置类型必选说明
bodybodyOrganizationRemoveInput是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已移除的组织节点。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 批量获取组织扩展信息​

GET /Organization/BatchGetExtras

请求参数​

名称位置类型必选说明
X-YFS-OrgIdsheaderstring是逗号分隔的组织 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "quota": 0,
      "managers": [
        {
          "managerId": 1,
          "managerName": "string",
          "managerRelPathName": "string",
          "roleInfos": [
            {}
          ]
        }
      ],
      "roles": [
        {
          "roleId": 1,
          "roleName": "string",
          "objInfos": [
            {}
          ]
        }
      ],
      "used": 0
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK组织扩展信息列表。OrganizationExtraListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

PUT 添加现有组织​

PUT /Organization/Add

请求参数​

名称位置类型必选说明
X-YFS-ParentIdheaderstring是父组织或目录 ID。
X-YFS-OrgIdsheaderstring是逗号分隔的组织 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已添加的组织。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

Path

GET 获取路径信息​

GET /Path/Info

请求参数​

名称位置类型必选说明
X-YFS-Pathheaderstring是绝对路径字符串。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "type": "root",
    "storeGroupId": "",
    "storeId": 0,
    "fileId": "string"
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK路径位置。PathLocationResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

POST 创建路径​

POST /Path/Create

请求参数​

名称位置类型必选说明
X-YFS-Pathheaderstring是绝对路径字符串。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": "string",
    "parentId": "string",
    "storeId": 0,
    "pathId": 0,
    "path": "string",
    "grade": 0,
    "name": "string",
    "type": "string",
    "size": 0,
    "createdBy": 0,
    "accessedBy": 0,
    "editedBy": 0,
    "modifiedBy": 0,
    "createdTime": 0,
    "accessedTime": 0,
    "editedTime": 0,
    "modifiedTime": 0,
    "clientId": "string",
    "cluster": "string",
    "offset": 0,
    "state": 0,
    "taskId": 0,
    "taskState": "string",
    "version": 0,
    "isFavorite": true,
    "isLock": true,
    "modificator": "string"
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK已创建的路径叶子目录。FileInfoResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

Permission

GET 获取访问行为组信息​

GET /Permission/ActGroup/Info

请求参数​

名称位置类型必选说明
X-YFS-ActGroupIdheaderstring是行为组 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": 1,
    "name": "string",
    "acts": [
      "string"
    ]
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK行为组详情。PermissionActGroupResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取访问行为组列表​

GET /Permission/ActGroup/List

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "name": "string",
      "acts": [
        "string"
      ]
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK行为组列表。PermissionActGroupListResponseEnvelope
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

POST 添加访问行为组​

POST /Permission/ActGroup/add

Body 请求参数

{
  "name": "string",
  "acts": [
    "string"
  ]
}

请求参数​

名称位置类型必选说明
bodybodyPermissionActGroupCreateInput是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已创建的行为组。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

POST 检查文件访问规则是否存在​

POST /AC/File/Rule/IsExist

Body 请求参数

[
  {
    "subId": 1,
    "objId": 0,
    "eft": "allow"
  }
]

请求参数​

名称位置类型必选说明
bodybodyPermissionFileRuleExistCheckRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "subId": 1,
      "objId": 0,
      "eft": "allow",
      "subName": "string",
      "IsExistSameName": true
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK匹配的访问规则是否存在。PermissionFileRuleExistCheckListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

POST 检查是否存在作用相反的访问规则​

POST /AC/File/Rule/IsExistOpposite

请求参数​

名称位置类型必选说明
X-YFS-RuleIdsheaderstring是逗号分隔的规则 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "property1": true,
    "property2": true
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK是否存在作用相反的规则。PermissionBooleanMapResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

POST 添加文件访问规则​

POST /AC/File/Rule/Add

Body 请求参数

[
  {
    "subId": 1,
    "objId": 0,
    "objType": "store",
    "eft": "allow",
    "replace": true,
    "acts": [
      "string"
    ]
  }
]

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
bodybodyPermissionFileRuleCreateListRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已添加的访问规则。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

PUT 更新文件访问规则​

PUT /AC/File/Rule/Update

Body 请求参数

{
  "storeId": 1,
  "ruleId": 1,
  "eft": "allow",
  "replace": true,
  "acts": [
    "string"
  ]
}

请求参数​

名称位置类型必选说明
bodybodyPermissionFileRuleUpdateInput是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已更新的访问规则。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

PUT 批量更新文件访问规则​

PUT /AC/File/Rule/BatchUpdate

Body 请求参数

{
  "storeId": 1,
  "ruleIds": [
    1
  ],
  "eft": "allow",
  "operateType": "add",
  "acts": [
    "string"
  ]
}

请求参数​

名称位置类型必选说明
bodybodyPermissionFileRuleBatchUpdateInput是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已批量更新的访问规则。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

DELETE 删除文件访问规则​

DELETE /AC/File/Rule/Delete

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-RuleIdsheaderstring是逗号分隔的规则 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已删除的访问规则。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取文件访问规则详情​

GET /AC/File/Rule/Info

请求参数​

名称位置类型必选说明
X-YFS-RuleIdsheaderstring是逗号分隔的规则 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "ruleId": 1,
      "subId": 1,
      "objId": 0,
      "eft": "allow",
      "acts": [
        "string"
      ]
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK访问规则详情。PermissionFileRuleListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取文件的访问规则列表​

GET /AC/File/Rule/ByFile

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-ObjIdheaderstring是对象 ID。
X-YFS-ObjTypeheaderstring是对象类型。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "ruleId": 1,
      "subId": 1,
      "subName": "string",
      "subPathName": "string",
      "eft": "allow",
      "acts": [
        "string"
      ]
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK文件访问规则列表。PermissionFileRuleByFileListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

POST 检查职能访问权限是否存在​

POST /AC/Position/Right/IsExist

Body 请求参数

[
  {
    "subId": 1,
    "objId": 1,
    "eft": "allow"
  }
]

请求参数​

名称位置类型必选说明
bodybodyPermissionPositionRightExistCheckRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "subId": 1,
      "objId": 1,
      "eft": "allow",
      "subName": "string",
      "objName": "string",
      "IsExistSameName": true
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK匹配的职能权限是否存在。PermissionPositionRightExistCheckListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

POST 检查是否存在作用相反的职能权限​

POST /AC/Position/Right/IsExistOpposite

请求参数​

名称位置类型必选说明
X-YFS-RightIdsheaderstring是逗号分隔的权限 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "property1": true,
    "property2": true
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK是否存在作用相反的职能权限。PermissionBooleanMapResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

POST 添加职能访问权限​

POST /AC/Position/Right/Add

Body 请求参数

[
  {
    "subId": 1,
    "objId": 1,
    "eft": "allow",
    "replace": true,
    "acts": [
      "string"
    ]
  }
]

请求参数​

名称位置类型必选说明
bodybodyPermissionPositionRightCreateListRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已添加的职能权限。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

PUT 更新职能访问权限​

PUT /AC/Position/Right/Update

Body 请求参数

{
  "rightId": 1,
  "eft": "allow",
  "replace": true,
  "acts": [
    "string"
  ]
}

请求参数​

名称位置类型必选说明
bodybodyPermissionPositionRightUpdateInput是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已更新的职能权限。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

PUT 批量更新职能访问权限​

PUT /AC/Position/Right/BatchUpdate

Body 请求参数

{
  "rightIds": [
    1
  ],
  "eft": "allow",
  "operateType": "add",
  "acts": [
    "string"
  ]
}

请求参数​

名称位置类型必选说明
bodybodyPermissionPositionRightBatchUpdateInput是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已批量更新的职能权限。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

DELETE 删除职能访问权限​

DELETE /AC/Position/Right/Delete

请求参数​

名称位置类型必选说明
X-YFS-RightIdsheaderstring是逗号分隔的权限 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已删除的职能权限。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取职能访问权限详情​

GET /AC/Position/Right/Info

请求参数​

名称位置类型必选说明
X-YFS-RightIdsheaderstring是逗号分隔的权限 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "rightId": 1,
      "subId": 1,
      "objId": 1,
      "eft": "allow",
      "acts": [
        "string"
      ]
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK职能权限详情。PermissionPositionRightListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取组织的职能访问权限列表​

GET /AC/Position/Right/ByOrg

请求参数​

名称位置类型必选说明
X-YFS-SubIdheaderstring是主体 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "rightId": 1,
      "objId": 1,
      "objName": "string",
      "objPathName": "string",
      "eft": "allow",
      "acts": [
        "string"
      ]
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK组织的职能权限列表。PermissionPositionRightByOrgListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

DELETE 批量移除职能权限​

DELETE /AC/Position/Right/BatchDelete

Body 请求参数

[
  {
    "subId": 1,
    "objId": 1,
    "eft": "allow",
    "replace": true,
    "acts": [
      "string"
    ]
  }
]

请求参数​

名称位置类型必选说明
bodybodyPermissionPositionRightCreateListRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已批量移除的职能权限。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

POST 添加文件访问权限​

POST /AC/File/Right/Add

Body 请求参数

[
  {
    "subId": 1,
    "storeId": 1,
    "objId": 0,
    "objType": "store",
    "eft": "allow",
    "replace": true,
    "acts": [
      "string"
    ]
  }
]

请求参数​

名称位置类型必选说明
bodybodyPermissionFileRightCreateListRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已添加的文件权限。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

DELETE 删除文件访问权限​

DELETE /AC/File/Right/Delete

请求参数​

名称位置类型必选说明
X-YFS-RightIdsheaderstring是逗号分隔的权限 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已删除的文件权限。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

POST 检查文件权限是否存在​

POST /AC/File/Right/IsExist

Body 请求参数

[
  {
    "subId": 1,
    "objId": 0,
    "objType": "store",
    "eft": "allow"
  }
]

请求参数​

名称位置类型必选说明
bodybodyPermissionFileRightExistCheckRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "subId": 1,
      "objId": 0,
      "objType": "store",
      "eft": "allow",
      "IsExistSameName": true
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK匹配的文件权限是否存在。PermissionFileRightExistCheckListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取组织或人员的文件权限列表​

GET /AC/File/Right/ByOrg

请求参数​

名称位置类型必选说明
X-YFS-SubIdheaderstring是主体 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "rightId": 1,
      "objId": 0,
      "objType": "store",
      "storeId": 1,
      "objPathName": "string",
      "objName": "string",
      "eft": "allow",
      "acts": [
        "string"
      ]
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK组织或用户的文件权限列表。PermissionFileRightByOrgListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

PUT 更新文件访问权限​

PUT /AC/File/Right/Update

Body 请求参数

{
  "rightId": 1,
  "objId": 0,
  "objType": "store",
  "eft": "allow",
  "replace": true,
  "acts": [
    "string"
  ]
}

请求参数​

名称位置类型必选说明
bodybodyPermissionFileRightUpdateInput是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已更新的文件权限。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

PUT 批量更新文件访问权限​

PUT /AC/File/Right/BatchUpdate

Body 请求参数

{
  "rightIds": [
    1
  ],
  "eft": "allow",
  "operateType": "add",
  "acts": [
    "string"
  ]
}

请求参数​

名称位置类型必选说明
bodybodyPermissionFileRightBatchUpdateInput是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已批量更新的文件权限。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取文件访问权限详情​

GET /AC/File/Right/Info

请求参数​

名称位置类型必选说明
X-YFS-RightIdsheaderstring是逗号分隔的权限 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "rightId": 1,
      "subId": 1,
      "objId": 0,
      "objType": "store",
      "storeId": 1,
      "objPathName": "string",
      "objName": "string",
      "eft": "allow",
      "acts": [
        "string"
      ]
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK文件权限详情。PermissionFileRightListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

DELETE 批量移除文件权限​

DELETE /AC/File/Right/BatchDelete

Body 请求参数

[
  {
    "subId": 1,
    "storeId": 1,
    "objId": 0,
    "objType": "store",
    "eft": "allow",
    "replace": true,
    "acts": [
      "string"
    ]
  }
]

请求参数​

名称位置类型必选说明
bodybodyPermissionFileRightCreateListRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已批量移除的文件权限。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

DELETE 清理权限数据​

DELETE /Permission/Clear

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK权限数据已清理。SuccessEnvelope
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

POST 检查文件权限预授权​

POST /Permission/Check/PreAuthorization

Body 请求参数

{
  "orgIds": [
    1
  ],
  "files": [
    {
      "storeId": 1,
      "type": "store",
      "fileId": "string"
    }
  ],
  "fileActs": [
    "string"
  ]
}

请求参数​

名称位置类型必选说明
bodybodyPermissionPreAuthorizationInput是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": true
}

返回结果​

状态码状态码含义说明数据模型
200OK预授权检查结果。PermissionPreAuthorizationResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

POST 检查文件权限组预授权​

POST /Permission/Check/GroupPreAuthorization

Body 请求参数

{
  "orgIds": [
    1
  ],
  "groupIds": [
    1
  ]
}

请求参数​

名称位置类型必选说明
bodybodyPermissionGroupPreAuthorizationInput是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": true
}

返回结果​

状态码状态码含义说明数据模型
200OK权限组预授权检查结果。PermissionPreAuthorizationResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

POST 检查当前用户的文件权限​

POST /AC/File/Check

Body 请求参数

{
  "objIds": "string",
  "acts": "string"
}

请求参数​

名称位置类型必选说明
bodybodyPermissionFileCheckInput是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": true
}

返回结果​

状态码状态码含义说明数据模型
200OK文件权限检查结果。PermissionFileCheckResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 检查职能权限​

GET /Permission/Check/RoleAct

请求参数​

名称位置类型必选说明
X-YFS-ObjIdheaderstring是对象 ID。
X-YFS-Actsheaderstring是逗号分隔的操作标识符。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "property1": true,
    "property2": true
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK角色操作检查结果。PermissionBooleanMapResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取文件权限组分类详情​

GET /AC/File/RightGroupCategory/Info

请求参数​

名称位置类型必选说明
X-YFS-Idheaderstring是通用资源 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": 1,
    "name": "string",
    "count": 0
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK文件权限组分类详情。PermissionFileRightGroupCategoryResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

POST 创建文件权限组分类​

POST /AC/File/RightGroupCategory/Create

请求参数​

名称位置类型必选说明
X-YFS-Nameheaderstring是文件或目录名称。URL 编码的值会在服务端校验前自动解码。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已创建的文件权限组分类。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取文件权限组分类列表​

GET /AC/File/RightGroupCategory/List

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "name": "string",
      "count": 0
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK文件权限组分类列表。PermissionFileRightGroupCategoryListResponseEnvelope
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

PUT 更新文件权限组分类​

PUT /AC/File/RightGroupCategory/Update

请求参数​

名称位置类型必选说明
X-YFS-Idheaderstring是通用资源 ID。
X-YFS-Nameheaderstring是文件或目录名称。URL 编码的值会在服务端校验前自动解码。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已更新的文件权限组分类。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

DELETE 删除文件权限组分类​

DELETE /AC/File/RightGroupCategory/Delete

请求参数​

名称位置类型必选说明
X-YFS-Idheaderstring是通用资源 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已删除的文件权限组分类。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

POST 创建文件权限组​

POST /AC/File/RightGroup/Create

Body 请求参数

{
  "name": "string",
  "categoryId": 1,
  "owner": 0,
  "items": [
    {
      "objId": 0,
      "objType": "store",
      "eft": "allow",
      "acts": [
        "string"
      ]
    }
  ]
}

请求参数​

名称位置类型必选说明
bodybodyPermissionFileRightGroupCreateInput是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已创建的文件权限组。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取文件权限组列表​

GET /AC/File/RightGroup/ListByCategory

请求参数​

名称位置类型必选说明
X-YFS-CategoryIdheaderstring否权限组分类 ID。省略时返回所有权限组。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "name": "string",
      "authorizedOrgs": [
        {
          "subId": 1,
          "subName": "string",
          "subType": "dept",
          "operator": 1,
          "operatorName": "string"
        }
      ],
      "items": [
        {
          "itemId": 1,
          "objId": {},
          "objType": "store",
          "objName": "string",
          "eft": "allow",
          "acts": [
            "string"
          ]
        }
      ]
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK文件权限组列表。PermissionFileRightGroupSummaryListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取文件权限组详情​

GET /AC/File/RightGroup/Info

请求参数​

名称位置类型必选说明
X-YFS-GroupIdheaderstring是权限组 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": 1,
    "name": "string",
    "categoryId": 1,
    "owner": 0,
    "items": [
      {
        "id": 1,
        "groupId": 1,
        "objId": 0,
        "objType": "store",
        "eft": "allow",
        "objPathName": "string",
        "acts": [
          "string"
        ]
      }
    ]
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK文件权限组详情。PermissionFileRightGroupDetailResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

PUT 更新文件权限组​

PUT /AC/File/RightGroup/Update

Body 请求参数

{
  "id": 1,
  "name": "string",
  "categoryId": 1,
  "owner": 0,
  "items": [
    {
      "objId": 0,
      "objType": "store",
      "eft": "allow",
      "acts": [
        "string"
      ]
    }
  ]
}

请求参数​

名称位置类型必选说明
bodybodyPermissionFileRightGroupUpdateInput是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已更新的文件权限组。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

DELETE 删除文件权限组​

DELETE /AC/File/RightGroup/Delete

请求参数​

名称位置类型必选说明
X-YFS-GroupIdsheaderstring是逗号分隔的权限组 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已删除的文件权限组。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

POST 授权文件权限组​

POST /AC/File/RightGroup/Authorize

Body 请求参数

[
  {
    "groupId": 1,
    "subId": 1
  }
]

请求参数​

名称位置类型必选说明
bodybodyPermissionFileRightGroupAuthorizeListRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已授权的文件权限组。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

DELETE 移除文件权限组授权​

DELETE /AC/File/RightGroup/Deauthorize

Body 请求参数

[
  {
    "groupId": 1,
    "subId": 1
  }
]

请求参数​

名称位置类型必选说明
bodybodyPermissionFileRightGroupAuthorizeListRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已取消授权的文件权限组。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取文件权限组已授权对象列表​

GET /AC/File/RightGroup/AuthorizedOrgList

请求参数​

名称位置类型必选说明
X-YFS-GroupIdheaderstring是权限组 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "groupId": 1,
      "subId": 1,
      "operator": 1,
      "subName": "string",
      "subPathName": "string",
      "operatorName": "string",
      "operatorPathName": "string"
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK已授权对象列表。PermissionAuthorizedOrgDetailListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 根据已授权组织获取文件权限组列表​

GET /AC/File/RightGroup/ListByAuthorizedOrg

请求参数​

名称位置类型必选说明
X-YFS-OrgIdheaderstring是组织 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "name": "string",
      "authorizedOrgs": [
        {
          "subId": 1,
          "subName": "string",
          "subType": "dept",
          "operator": 1,
          "operatorName": "string"
        }
      ],
      "items": [
        {
          "itemId": 1,
          "objId": {},
          "objType": "store",
          "objName": "string",
          "eft": "allow",
          "acts": [
            "string"
          ]
        }
      ]
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK已授权组织的文件权限组列表。PermissionFileRightGroupSummaryListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

POST 检查指定用户的文件权限​

POST /Permission/Check/FileActByUser

Body 请求参数

{
  "objIds": "string",
  "acts": "string",
  "userId": 1
}

请求参数​

名称位置类型必选说明
bodybodyPermissionFileCheckByUserInput是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": true
}

返回结果​

状态码状态码含义说明数据模型
200OK指定用户的文件权限检查结果。PermissionFileCheckResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

Recent

GET 获取最近访问列表​

GET /Recent/List

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "recentId": 1,
      "storeId": 1,
      "id": "string",
      "filePath": "string",
      "type": 0,
      "size": 0,
      "accessedBy": 1,
      "accessedTime": "string",
      "name": "string",
      "storeType": "private",
      "tags": [
        {
          "id": 1,
          "name": "string",
          "color": "string"
        }
      ],
      "isFavorite": true,
      "isLock": true
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK最近访问记录。RecentFileListResponseEnvelope
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

DELETE 删除最近访问记录​

DELETE /Recent/Delete

请求参数​

名称位置类型必选说明
X-YFS-FileIdsheaderstring是逗号分隔的文件 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK最近访问记录已删除。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

Recycle

GET 获取回收站文件列表​

GET /Recycle/FileList

请求参数​

名称位置类型必选说明
X-YFS-StoreTypeheaderstring否空间类型过滤。
X-YFS-PageSizeheaderinteger否分页大小。分页接口的有效范围为 1-2000。
X-YFS-PageNumberheaderinteger否页码，从 1 开始。
X-YFS-SortFieldheaderstring否排序字段。
X-YFS-SortOrderheaderstring否排序方向。

枚举值​

属性值
X-YFS-SortOrderASC
X-YFS-SortOrderDESC

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "total": 0,
    "pageSize": 1,
    "pageNumber": 1,
    "list": [
      {
        "id": 1,
        "storeId": 1,
        "fileId": "string",
        "parentId": "string",
        "pathId": 0,
        "path": "string",
        "grade": 0,
        "name": "string",
        "type": 0,
        "size": 0,
        "storeType": "private",
        "filePath": "string",
        "createdBy": 1,
        "deletedBy": 1,
        "createdTime": 0,
        "deletedTime": 0,
        "clientId": "string",
        "cluster": "string",
        "offset": 0
      }
    ]
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK回收站文件列表。RecycleFileListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 在回收站中搜索文件​

GET /Recycle/Search

请求参数​

名称位置类型必选说明
X-YFS-SearchKeyheaderstring否搜索关键词。
X-YFS-StoreTypeheaderstring否空间类型过滤。
X-YFS-SortFieldheaderstring否排序字段。
X-YFS-SortOrderheaderstring否排序方向。
X-YFS-PageSizeheaderinteger否分页大小。分页接口的有效范围为 1-2000。
X-YFS-PageNumberheaderinteger否页码，从 1 开始。

枚举值​

属性值
X-YFS-SortOrderASC
X-YFS-SortOrderDESC

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "total": 0,
    "pageSize": 1,
    "pageNumber": 1,
    "list": [
      {
        "id": 1,
        "storeId": 1,
        "fileId": "string",
        "parentId": "string",
        "pathId": 0,
        "path": "string",
        "grade": 0,
        "name": "string",
        "type": 0,
        "size": 0,
        "storeType": "private",
        "filePath": "string",
        "createdBy": 1,
        "deletedBy": 1,
        "createdTime": 0,
        "deletedTime": 0,
        "clientId": "string",
        "cluster": "string",
        "offset": 0
      }
    ]
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK回收站搜索结果。RecycleFileListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

PUT 恢复回收站文件​

PUT /Recycle/Restore

Body 请求参数

[
  "string"
]

请求参数​

名称位置类型必选说明
bodybodyRecycleFileIdListRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已恢复的回收站文件。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

DELETE 删除回收站文件​

DELETE /Recycle/Delete

Body 请求参数

[
  "string"
]

请求参数​

名称位置类型必选说明
bodybodyRecycleFileIdListRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已删除的回收站文件。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

DELETE 清空回收站​

DELETE /Recycle/Empty

请求参数​

名称位置类型必选说明
X-YFS-StoreTypeheaderstring否空间类型过滤。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK回收站已清空。SuccessEnvelope
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

DELETE 清理回收站​

DELETE /Recycle/Clear

请求参数​

名称位置类型必选说明
X-YFS-ClearAllheaderstring是是否清空所有可回收项。

枚举值​

属性值
X-YFS-ClearAlltrue
X-YFS-ClearAllfalse
X-YFS-ClearAll1
X-YFS-ClearAll0

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK回收站已清理。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取回收站文件信息​

GET /Recycle/File

请求参数​

名称位置类型必选说明
X-YFS-FileIdheaderstring是文件 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": 1,
    "storeId": 1,
    "fileId": "string",
    "parentId": "string",
    "pathId": 0,
    "path": "string",
    "grade": 0,
    "name": "string",
    "type": 0,
    "size": 0,
    "storeType": "private",
    "filePath": "string",
    "createdBy": 1,
    "deletedBy": 1,
    "createdTime": 0,
    "deletedTime": 0,
    "clientId": "string",
    "cluster": "string",
    "offset": 0
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK回收站文件信息。RecycleFileResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 判断指定文件是否可恢复​

GET /Recycle/Restorable

请求参数​

名称位置类型必选说明
X-YFS-FileIdheaderstring是文件 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": true
}

返回结果​

状态码状态码含义说明数据模型
200OK文件是否可恢复。BooleanResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取系统回收站文件列表​

GET /SystemRecycle/FileList

请求参数​

名称位置类型必选说明
X-YFS-StoreTypeheaderstring否空间类型过滤。
X-YFS-PageSizeheaderinteger否分页大小。分页接口的有效范围为 1-2000。
X-YFS-PageNumberheaderinteger否页码，从 1 开始。
X-YFS-SortFieldheaderstring否排序字段。
X-YFS-SortOrderheaderstring否排序方向。

枚举值​

属性值
X-YFS-SortOrderASC
X-YFS-SortOrderDESC

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "total": 0,
    "pageSize": 1,
    "pageNumber": 1,
    "list": [
      {
        "id": 1,
        "storeId": 1,
        "fileId": "string",
        "parentId": "string",
        "pathId": 0,
        "path": "string",
        "grade": 0,
        "name": "string",
        "type": 0,
        "size": 0,
        "storeType": "private",
        "filePath": "string",
        "createdBy": 1,
        "deletedBy": 1,
        "createdTime": 0,
        "deletedTime": 0,
        "clientId": "string",
        "cluster": "string",
        "offset": 0
      }
    ]
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK系统回收站文件列表。RecycleFileListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 在系统回收站中搜索文件​

GET /SystemRecycle/Search

请求参数​

名称位置类型必选说明
X-YFS-SearchKeyheaderstring否搜索关键词。
X-YFS-StoreTypeheaderstring否空间类型过滤。
X-YFS-SortFieldheaderstring否排序字段。
X-YFS-SortOrderheaderstring否排序方向。
X-YFS-PageSizeheaderinteger否分页大小。分页接口的有效范围为 1-2000。
X-YFS-PageNumberheaderinteger否页码，从 1 开始。

枚举值​

属性值
X-YFS-SortOrderASC
X-YFS-SortOrderDESC

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "total": 0,
    "pageSize": 1,
    "pageNumber": 1,
    "list": [
      {
        "id": 1,
        "storeId": 1,
        "fileId": "string",
        "parentId": "string",
        "pathId": 0,
        "path": "string",
        "grade": 0,
        "name": "string",
        "type": 0,
        "size": 0,
        "storeType": "private",
        "filePath": "string",
        "createdBy": 1,
        "deletedBy": 1,
        "createdTime": 0,
        "deletedTime": 0,
        "clientId": "string",
        "cluster": "string",
        "offset": 0
      }
    ]
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK系统回收站搜索结果。RecycleFileListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

PUT 恢复系统回收站文件​

PUT /SystemRecycle/Restore

Body 请求参数

[
  "string"
]

请求参数​

名称位置类型必选说明
bodybodyRecycleFileIdListRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已恢复的系统回收站文件。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

DELETE 清理系统回收站​

DELETE /SystemRecycle/Clear

请求参数​

名称位置类型必选说明
X-YFS-ClearAllheaderstring是是否清空所有可回收项。

枚举值​

属性值
X-YFS-ClearAlltrue
X-YFS-ClearAllfalse
X-YFS-ClearAll1
X-YFS-ClearAll0

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK系统回收站已清理。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

Role

POST 创建角色​

POST /Role/Create

Body 请求参数

{
  "name": "string",
  "owner": 0,
  "level": "administrator",
  "type": "custom",
  "desc": "string",
  "actions": [
    "string"
  ]
}

请求参数​

名称位置类型必选说明
bodybodyRoleCreateInput是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK角色已创建。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取角色详情​

GET /Role/Info

请求参数​

名称位置类型必选说明
X-YFS-RoleIdheaderstring是角色 ID。
X-YFS-OrgIdheaderstring是组织 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": 1,
    "name": "string",
    "owner": 0,
    "level": "administrator",
    "type": "string",
    "limit": "public",
    "desc": "string",
    "creator": "string",
    "editor": "string",
    "ownername": "string",
    "actions": [
      "string"
    ],
    "assigns": [
      {
        "subId": 1,
        "objId": 0
      }
    ],
    "subInfos": [
      {
        "id": 1,
        "name": "string",
        "type": "dept"
      }
    ],
    "orgRoles": {
      "subId": 1,
      "subName": "string",
      "subType": "dept",
      "subRelPathName": "string",
      "objInfos": [
        {
          "id": 0,
          "name": "string",
          "relPathName": "string"
        }
      ]
    }
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK角色详情。RoleDetailResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

PUT 更新角色​

PUT /Role/Update

Body 请求参数

{
  "id": 1,
  "name": "string",
  "owner": 0,
  "level": "administrator",
  "type": "string",
  "desc": "string",
  "actions": [
    "string"
  ]
}

请求参数​

名称位置类型必选说明
bodybodyRoleUpdateInput是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已更新的角色。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

DELETE 删除角色​

DELETE /Role/Delete

请求参数​

名称位置类型必选说明
X-YFS-RoleIdheaderstring是角色 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已删除的角色。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取角色列表​

GET /Role/GetList

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "name": "string",
      "owner": 0,
      "level": "administrator",
      "type": "string",
      "desc": "string",
      "ownername": "string",
      "levelName": "string",
      "actions": [
        "string"
      ],
      "subInfos": [
        {
          "id": 1,
          "name": "string",
          "type": "dept"
        }
      ]
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK角色列表。RoleListResponseEnvelope
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取指定对象承担的角色​

GET /Role/Assumed

请求参数​

名称位置类型必选说明
X-YFS-Idheaderstring是通用资源 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "objId": 0,
      "objPathName": "string",
      "roleInfos": [
        {
          "id": 1,
          "name": "string"
        }
      ]
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK承担的角色列表。RoleAssumedListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取主管角色人员列表​

GET /Role/GetManagerList

请求参数​

名称位置类型必选说明
X-YFS-OrgIdheaderstring是组织 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "managerId": 1,
      "managerName": "string",
      "managerRelPathName": "string",
      "roleInfos": [
        {
          "id": 1,
          "name": "string"
        }
      ]
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK主管角色人员列表。RoleManagerListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取角色包含的组织和人员列表​

GET /Role/GetAssignsByRoleId

请求参数​

名称位置类型必选说明
X-YFS-RoleIdheaderstring是角色 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "subId": 1,
      "subName": "string",
      "subType": "string",
      "objInfos": [
        {
          "id": 0,
          "name": "string",
          "relPathName": "string"
        }
      ]
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK角色包含的组织和人员列表。RoleAssignmentGroupListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取组织可见角色列表​

GET /Role/GetListByOrg

请求参数​

名称位置类型必选说明
X-YFS-OrgIdheaderstring是组织 ID。
X-YFS-Levelheaderstring否逗号分隔的角色级别。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "property1": {
      "name": "string",
      "level": "administrator"
    },
    "property2": {
      "name": "string",
      "level": "administrator"
    }
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK组织可见的角色列表。RoleVisibleMapResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

POST 为对象指派角色​

POST /Role/AssignRole

Body 请求参数

[
  {
    "subId": 1,
    "roleId": 1,
    "objId": 0
  }
]

请求参数​

名称位置类型必选说明
bodybodyRoleAssignBatchRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已指派的角色。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

DELETE 解除对象角色​

DELETE /Role/RevokeRole

Body 请求参数

[
  {
    "subId": 1,
    "roleId": 1,
    "objId": 0
  }
]

请求参数​

名称位置类型必选说明
bodybodyRoleAssignBatchRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已解除的角色。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

PUT 更新对象角色分配​

PUT /Role/UpdateAssignedRole

Body 请求参数

{
  "assigns": [
    {
      "subId": 1,
      "roleId": 1,
      "objId": 0
    }
  ],
  "revokes": [
    {
      "subId": 1,
      "roleId": 1,
      "objId": 0
    }
  ]
}

请求参数​

名称位置类型必选说明
bodybodyRoleUpdateAssignedInput是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已更新的角色分配。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

Store

POST 创建空间​

POST /Store/Create

Body 请求参数

{
  "name": "string",
  "type": "private",
  "owner": 1,
  "manager": 1,
  "quota": 0,
  "fileLifecycle": {
    "policy": "cycle",
    "clearCycle": "0 0 * * *",
    "keepGrade": 0
  }
}

请求参数​

名称位置类型必选说明
bodybodyStoreCreateInput是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": 0
}

返回结果​

状态码状态码含义说明数据模型
200OK已创建的空间 ID。IntegerResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

DELETE 删除空间​

DELETE /Store/Delete

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-Passwordheaderstring是URL 解码后的 SHA-256 密码摘要。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已删除的空间。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取空间信息​

GET /Store/Info

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": 1,
    "name": "string",
    "type": "private",
    "size": 0,
    "used": 0,
    "fileNum": 0,
    "dirNum": 0,
    "owner": 1,
    "manager": 1,
    "createdBy": 1,
    "modifiedBy": 1,
    "createdTime": 0,
    "modifiedTime": 0,
    "fileLifecycle": {
      "policy": "cycle",
      "clearCycle": "0 0 * * *",
      "keepGrade": 0
    },
    "isFavorite": true
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK空间信息。StoreInfoResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取空间列表​

GET /Store/List

请求参数​

名称位置类型必选说明
X-YFS-Typeheaderstring否可选的业务类型过滤。
X-YFS-SortFieldheaderstring否排序字段。
X-YFS-SortOrderheaderstring否排序方向。

枚举值​

属性值
X-YFS-SortOrderASC
X-YFS-SortOrderDESC

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "name": "string",
      "type": "private",
      "size": 0,
      "used": 0,
      "fileNum": 0,
      "dirNum": 0,
      "owner": 1,
      "manager": 1,
      "createdBy": 1,
      "modifiedBy": 1,
      "createdTime": 0,
      "modifiedTime": 0,
      "fileLifecycle": {
        "policy": "cycle",
        "clearCycle": "0 0 * * *",
        "keepGrade": 0
      },
      "isFavorite": true
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK空间列表。StoreListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

PUT 更新空间​

PUT /Store/Update

Body 请求参数

{
  "name": "string",
  "type": "private",
  "owner": 1,
  "manager": 1,
  "quota": 0,
  "fileLifecycle": {
    "policy": "cycle",
    "clearCycle": "0 0 * * *",
    "keepGrade": 0
  }
}

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
bodybodyStoreUpdateInput是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已更新的空间。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取空间概要信息​

GET /Store/Summary

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "name": "string",
    "type": "private",
    "size": 0,
    "manager": "string",
    "managerId": 1,
    "createdBy": "string",
    "createdTime": 0,
    "path": "string",
    "manageable": true,
    "fileLifecycle": {
      "policy": "cycle",
      "clearCycle": "0 0 * * *",
      "keepGrade": 0
    },
    "ownerPathname": "string"
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK空间概要信息。StoreSummaryResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取空间详细信息​

GET /Store/Detail

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "dirCount": 0,
    "fileCount": 0,
    "used": 0,
    "editedBy": "string",
    "editedTime": 0,
    "rights": [
      "string"
    ]
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK空间详细信息。StoreDetailResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取空间操作日志​

GET /Store/Logs

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-PageSizeheaderinteger否分页大小。分页接口的有效范围为 1-2000。
X-YFS-PageNumberheaderinteger否页码，从 1 开始。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": {
    "total": 0,
    "pageSize": 0,
    "pageNumber": 0,
    "list": [
      {
        "fileId": "string",
        "type": "string",
        "fileType": "string",
        "filePath": "string",
        "version": 0,
        "createdTime": "string",
        "detail": "string",
        "username": "string"
      }
    ]
  }
}

返回结果​

状态码状态码含义说明数据模型
200OK空间操作日志条目。FileOperationLogListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取空间权限​

GET /Store/Permission

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    "string"
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK当前用户的空间权限映射。UserRightListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

Tag

POST 添加标签​

POST /Tag/Add

Body 请求参数

[
  {
    "name": "string",
    "color": "string"
  }
]

请求参数​

名称位置类型必选说明
bodybodyTagCreateRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "name": "string",
      "color": "string",
      "createdBy": 1,
      "createdTime": "string",
      "creator": "string",
      "usedTime": "string"
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK已添加的标签。TagListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

DELETE 删除标签​

DELETE /Tag/Delete

请求参数​

名称位置类型必选说明
X-YFS-Idsheaderstring是逗号分隔的文件 ID 列表。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已删除的标签。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取标签列表​

GET /Tag/List

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "name": "string",
      "color": "string",
      "createdBy": 1,
      "createdTime": "string",
      "creator": "string",
      "usedTime": "string"
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK标签列表。TagListResponseEnvelope
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

PUT 修改标签​

PUT /Tag/Update

Body 请求参数

[
  {
    "id": 1,
    "name": "string",
    "color": "string"
  }
]

请求参数​

名称位置类型必选说明
bodybodyTagUpdateRequestBody是none

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK已更新的标签。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

PUT 为文件设置标签​

PUT /Tag/File/Set

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-FileIdheaderstring是文件 ID。
X-YFS-TagIdsheaderstring是逗号分隔的标签 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK文件标签已设置。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

GET 获取文件标签​

GET /Tag/File/Get

请求参数​

名称位置类型必选说明
X-YFS-StoreIdheaderinteger是空间 ID。
X-YFS-FileIdheaderstring是文件 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "name": "string",
      "color": "string",
      "createdBy": 1,
      "createdTime": "string",
      "creator": "string",
      "usedTime": "string"
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK文件标签。TagListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
404Not Found资源未找到。None
500Internal Server Error服务器内部错误。None

PUT 为文件添加标签​

PUT /Tag/File/Add

请求参数​

名称位置类型必选说明
X-YFS-FileIdsheaderstring是逗号分隔的文件 ID。
X-YFS-TagIdsheaderstring是逗号分隔的标签 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK文件标签已添加。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

DELETE 为文件删除标签​

DELETE /Tag/File/Delete

请求参数​

名称位置类型必选说明
X-YFS-FileIdsheaderstring是逗号分隔的文件 ID。
X-YFS-TagIdsheaderstring是逗号分隔的标签 ID。

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": null
}

返回结果​

状态码状态码含义说明数据模型
200OK文件标签已删除。SuccessEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 根据标签获取文件​

GET /Tag/File/List

请求参数​

名称位置类型必选说明
X-YFS-TagIdsheaderstring是逗号分隔的标签 ID。
X-YFS-SortFieldheaderstring否排序字段。
X-YFS-SortOrderheaderstring否排序方向。

枚举值​

属性值
X-YFS-SortOrderASC
X-YFS-SortOrderDESC

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": "string",
      "parentId": "string",
      "storeId": 0,
      "pathId": 0,
      "path": "string",
      "grade": 0,
      "name": "string",
      "type": "string",
      "size": 0,
      "createdBy": 0,
      "accessedBy": 0,
      "editedBy": 0,
      "modifiedBy": 0,
      "createdTime": 0,
      "accessedTime": 0,
      "editedTime": 0,
      "modifiedTime": 0,
      "clientId": "string",
      "cluster": "string",
      "offset": 0,
      "state": 0,
      "taskId": 0,
      "taskState": "string",
      "version": 0,
      "isFavorite": true,
      "isLock": true,
      "modificator": "string"
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK匹配标签的文件列表。FileInfoListResponseEnvelope
400Bad Request请求无效。None
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

GET 获取最近使用的标签​

GET /Tag/Recent

返回示例

200 Response

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "name": "string",
      "color": "string",
      "createdBy": 1,
      "createdTime": "string",
      "creator": "string",
      "usedTime": "string"
    }
  ]
}

返回结果​

状态码状态码含义说明数据模型
200OK最近使用的标签。TagListResponseEnvelope
401Unauthorized需要认证或 Token 无效。None
403Forbidden权限不足。None
500Internal Server Error服务器内部错误。None

数据模型

UserCreateBatchRequestBody

[
  {
    "account": "string",
    "password": "string",
    "name": "string",
    "quota": 0,
    "gender": "m",
    "email": "string",
    "mobile": "string",
    "state": "string",
    "extranet": "true",
    "parentInfos": [
      {
        "parentId": 1,
        "inherit": "true"
      }
    ],
    "roleInfos": [
      {
        "roleId": 1,
        "objId": 0
      }
    ]
  }
]

属性​

名称类型必选约束中文名说明
anonymous[UserCreateInput]falsenonenone

UserUpdateBatchRequestBody

[
  {
    "id": 1,
    "account": "string",
    "name": "string",
    "sn": "string",
    "state": "string",
    "password": "string",
    "quota": 0,
    "gender": "m",
    "email": "string",
    "mobile": "string",
    "joinTime": "2024-01-01",
    "successor": 1,
    "extranet": "true",
    "parentInfos": [
      {
        "parentId": 1,
        "inherit": "true"
      }
    ],
    "roleInfos": {
      "add": [
        {
          "roleId": 1,
          "objId": 0
        }
      ],
      "delete": [
        {
          "roleId": 1,
          "objId": 0
        }
      ]
    }
  }
]

属性​

名称类型必选约束中文名说明
anonymous[UserUpdateInput]falsenonenone

OrganizationCreateBatchRequestBody

[
  {
    "parentInfos": [
      {
        "id": 1,
        "inherit": "true"
      }
    ],
    "type": "unit",
    "name": "string",
    "managerInfos": [
      {
        "subId": 1,
        "roleId": 1
      }
    ],
    "roleInfos": [
      {
        "roleId": 1,
        "objId": 0
      }
    ]
  }
]

属性​

名称类型必选约束中文名说明
anonymous[OrganizationCreateInput]falsenonenone

OrganizationUpdateBatchRequestBody

[
  {
    "id": 1,
    "parentInfos": [
      {
        "parentId": 1,
        "inherit": "true"
      }
    ],
    "type": "unit",
    "name": "string",
    "quota": 0,
    "managerInfos": {
      "add": [
        {
          "subId": 1,
          "roleId": 1,
          "objId": 0
        }
      ],
      "delete": [
        {
          "subId": 1,
          "roleId": 1,
          "objId": 0
        }
      ]
    },
    "roleInfos": {
      "add": [
        {
          "subId": 1,
          "roleId": 1,
          "objId": 0
        }
      ],
      "delete": [
        {
          "subId": 1,
          "roleId": 1,
          "objId": 0
        }
      ]
    }
  }
]

属性​

名称类型必选约束中文名说明
anonymous[OrganizationUpdateInput]falsenonenone

PermissionFileRuleExistCheckRequestBody

[
  {
    "subId": 1,
    "objId": 0,
    "eft": "allow"
  }
]

属性​

名称类型必选约束中文名说明
anonymous[PermissionFileRuleExistCheckInput]falsenonenone

PermissionFileRuleCreateListRequestBody

[
  {
    "subId": 1,
    "objId": 0,
    "objType": "store",
    "eft": "allow",
    "replace": true,
    "acts": [
      "string"
    ]
  }
]

属性​

名称类型必选约束中文名说明
anonymous[PermissionFileRuleInput]falsenonenone

PermissionPositionRightExistCheckRequestBody

[
  {
    "subId": 1,
    "objId": 1,
    "eft": "allow"
  }
]

属性​

名称类型必选约束中文名说明
anonymous[PermissionPositionRightExistCheckInput]falsenonenone

PermissionPositionRightCreateListRequestBody

[
  {
    "subId": 1,
    "objId": 1,
    "eft": "allow",
    "replace": true,
    "acts": [
      "string"
    ]
  }
]

属性​

名称类型必选约束中文名说明
anonymous[PermissionPositionRightInput]falsenonenone

PermissionFileRightExistCheckRequestBody

[
  {
    "subId": 1,
    "objId": 0,
    "objType": "store",
    "eft": "allow"
  }
]

属性​

名称类型必选约束中文名说明
anonymous[PermissionFileRightExistCheckInput]falsenonenone

PermissionFileRightCreateListRequestBody

[
  {
    "subId": 1,
    "storeId": 1,
    "objId": 0,
    "objType": "store",
    "eft": "allow",
    "replace": true,
    "acts": [
      "string"
    ]
  }
]

属性​

名称类型必选约束中文名说明
anonymous[PermissionFileRightInput]falsenonenone

PermissionFileRightGroupAuthorizeListRequestBody

[
  {
    "groupId": 1,
    "subId": 1
  }
]

属性​

名称类型必选约束中文名说明
anonymous[PermissionFileRightGroupAuthorizeInput]falsenonenone

RecycleFileIdListRequestBody

[
  "string"
]

属性​

None

RoleAssignBatchRequestBody

[
  {
    "subId": 1,
    "roleId": 1,
    "objId": 0
  }
]

属性​

名称类型必选约束中文名说明
anonymous[RoleAssignInput]falsenonenone

GenericArrayRequestBody

[
  {}
]

属性​

名称类型必选约束中文名说明
anonymous[GenericObject]falsenonenone

TagCreateRequestBody

[
  {
    "name": "string",
    "color": "string"
  }
]

属性​

名称类型必选约束中文名说明
anonymous[TagCreateInput]falsenonenone

TagUpdateRequestBody

[
  {
    "id": 1,
    "name": "string",
    "color": "string"
  }
]

属性​

名称类型必选约束中文名说明
anonymous[TagUpdateInput]falsenonenone

ErrorResponse

{
  "code": "InvalidArgument",
  "message": "Request failed.",
  "data": null
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
datanullfalsenonenone

SuccessEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": null
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
datanullfalsenone操作返回额外数据时存在。

StringResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": "string"
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
datastringtruenonenone

IntegerResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": 0
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataintegertruenonenone

StringMap

{
  "property1": "string",
  "property2": "string"
}

属性​

名称类型必选约束中文名说明
additionalPropertiesstringfalsenonenone

StringMapResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "property1": "string",
    "property2": "string"
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataStringMaptruenonenone

UserRightList

[
  "string"
]

属性​

None

UserRightListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataUserRightListtruenonenone

FileInfo

{
  "id": "string",
  "parentId": "string",
  "storeId": 0,
  "pathId": 0,
  "path": "string",
  "grade": 0,
  "name": "string",
  "type": "string",
  "size": 0,
  "createdBy": 0,
  "accessedBy": 0,
  "editedBy": 0,
  "modifiedBy": 0,
  "createdTime": 0,
  "accessedTime": 0,
  "editedTime": 0,
  "modifiedTime": 0,
  "clientId": "string",
  "cluster": "string",
  "offset": 0,
  "state": 0,
  "taskId": 0,
  "taskState": "string",
  "version": 0,
  "isFavorite": true,
  "isLock": true,
  "modificator": "string"
}

属性​

名称类型必选约束中文名说明
idstringfalsenonenone
parentIdstringfalsenonenone
storeIdintegerfalsenonenone
pathIdintegerfalsenonenone
pathstringfalsenonenone
gradeintegerfalsenonenone
namestringfalsenonenone
typestringfalsenonenone
sizeintegerfalsenonenone
createdByintegerfalsenonenone
accessedByintegerfalsenonenone
editedByintegerfalsenonenone
modifiedByintegerfalsenonenone
createdTimeintegerfalsenonenone
accessedTimeintegerfalsenonenone
editedTimeintegerfalsenonenone
modifiedTimeintegerfalsenonenone
clientIdstringfalsenonenone
clusterstringfalsenonenone
offsetintegerfalsenonenone
stateintegerfalsenonenone
taskIdintegerfalsenonenone
taskStatestringfalsenonenone
versionintegerfalsenonenone
isFavoritebooleanfalsenonenone
isLockbooleanfalsenonenone
modificatorstringfalsenonenone

FileBriefInfo

{
  "id": "string",
  "parentId": "string",
  "storeId": 0,
  "name": "string",
  "size": 0,
  "type": "string",
  "editedTime": 0,
  "descendantFile": true,
  "descendant": true
}

属性​

名称类型必选约束中文名说明
idstringfalsenonenone
parentIdstringfalsenonenone
storeIdintegerfalsenonenone
namestringfalsenonenone
sizeintegerfalsenonenone
typestringfalsenonenone
editedTimeintegerfalsenonenone
descendantFilebooleanfalsenonenone
descendantbooleanfalsenonenone

FileTreeNode

{
  "id": "string",
  "storeId": 0,
  "parentId": "string",
  "pathId": 0,
  "path": "string",
  "name": "string",
  "size": 0,
  "type": 0,
  "grade": 0,
  "editedTime": "string"
}

属性​

名称类型必选约束中文名说明
idstringfalsenonenone
storeIdintegerfalsenonenone
parentIdstringfalsenonenone
pathIdintegerfalsenonenone
pathstringfalsenonenone
namestringfalsenonenone
sizeintegerfalsenonenone
typeintegerfalsenonenone
gradeintegerfalsenonenone
editedTimestringfalsenonenone

FileSummary

{
  "name": "string",
  "type": "string",
  "size": 0,
  "path": "string",
  "createdBy": "string",
  "editedBy": "string",
  "createdTime": 0,
  "editedTime": 0
}

属性​

名称类型必选约束中文名说明
namestringfalsenonenone
typestringfalsenonenone
sizeintegerfalsenonenone
pathstringfalsenonenone
createdBystringfalsenonenone
editedBystringfalsenonenone
createdTimeintegerfalsenonenone
editedTimeintegerfalsenonenone

FileDetail

{
  "dirCount": 0,
  "fileCount": 0,
  "size": 0,
  "editedBy": "string",
  "editedTime": 0,
  "rights": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
dirCountintegerfalsenonenone
fileCountintegerfalsenonenone
sizeintegerfalsenonenone
editedBystringfalsenonenone
editedTimeintegerfalsenonenone
rightsUserRightListfalsenonenone

DirectoryDetail

{
  "id": "string",
  "parentId": "string",
  "storeId": 1,
  "name": "string",
  "fullPath": "string",
  "size": 0,
  "dirNum": 0,
  "fileNum": 0,
  "createdBy": 1,
  "createdTime": 0
}

属性​

名称类型必选约束中文名说明
idstringtruenonenone
parentIdstringtruenonenone
storeIdintegertruenonenone
namestringtruenonenone
fullPathstringtruenonenone
sizeintegertruenonenone
dirNumintegertruenonenone
fileNumintegertruenonenone
createdByintegertruenonenone
createdTimeintegertruenonenone

FileListResult

{
  "total": 0,
  "pageSize": 0,
  "pageNumber": 0,
  "list": [
    {
      "id": "string",
      "parentId": "string",
      "storeId": 0,
      "pathId": 0,
      "path": "string",
      "grade": 0,
      "name": "string",
      "type": "string",
      "size": 0,
      "createdBy": 0,
      "accessedBy": 0,
      "editedBy": 0,
      "modifiedBy": 0,
      "createdTime": 0,
      "accessedTime": 0,
      "editedTime": 0,
      "modifiedTime": 0,
      "clientId": "string",
      "cluster": "string",
      "offset": 0,
      "state": 0,
      "taskId": 0,
      "taskState": "string",
      "version": 0,
      "isFavorite": true,
      "isLock": true,
      "modificator": "string"
    }
  ]
}

属性​

名称类型必选约束中文名说明
totalintegerfalsenonenone
pageSizeintegerfalsenonenone
pageNumberintegerfalsenonenone
list[FileInfo]falsenonenone

FileSearchItem

{
  "id": "string",
  "storeId": 0,
  "pathId": 0,
  "path": "string",
  "name": "string",
  "type": "string",
  "size": 0,
  "editedTime": 0,
  "editedBy": 0,
  "storeName": "string",
  "editor": "string",
  "isFavorite": true,
  "isLock": true,
  "content": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
idstringfalsenonenone
storeIdintegerfalsenonenone
pathIdintegerfalsenonenone
pathstringfalsenonenone
namestringfalsenonenone
typestringfalsenonenone
sizeintegerfalsenonenone
editedTimeintegerfalsenonenone
editedByintegerfalsenonenone
storeNamestringfalsenonenone
editorstringfalsenonenone
isFavoritebooleanfalsenonenone
isLockbooleanfalsenonenone
content[string]falsenonenone

FileSearchResult

{
  "total": 0,
  "pageSize": 0,
  "pageNumber": 0,
  "list": [
    {
      "id": "string",
      "storeId": 0,
      "pathId": 0,
      "path": "string",
      "name": "string",
      "type": "string",
      "size": 0,
      "editedTime": 0,
      "editedBy": 0,
      "storeName": "string",
      "editor": "string",
      "isFavorite": true,
      "isLock": true,
      "content": [
        "string"
      ]
    }
  ]
}

属性​

名称类型必选约束中文名说明
totalintegerfalsenonenone
pageSizeintegerfalsenonenone
pageNumberintegerfalsenonenone
list[FileSearchItem]falsenonenone

FileOperationLogEntry

{
  "fileId": "string",
  "type": "string",
  "fileType": "string",
  "filePath": "string",
  "version": 0,
  "createdTime": "string",
  "detail": "string",
  "username": "string"
}

属性​

名称类型必选约束中文名说明
fileIdstringfalsenonenone
typestringfalsenonenone
fileTypestringfalsenonenone
filePathstringfalsenonenone
versionintegerfalsenonenone
createdTimestringfalsenonenone
detailstringfalsenonenone
usernamestringfalsenonenone

FileOperationLogListResult

{
  "total": 0,
  "pageSize": 0,
  "pageNumber": 0,
  "list": [
    {
      "fileId": "string",
      "type": "string",
      "fileType": "string",
      "filePath": "string",
      "version": 0,
      "createdTime": "string",
      "detail": "string",
      "username": "string"
    }
  ]
}

属性​

名称类型必选约束中文名说明
totalintegerfalsenonenone
pageSizeintegerfalsenonenone
pageNumberintegerfalsenonenone
list[FileOperationLogEntry]falsenonenone

FileOptTaskData

{
  "taskId": 1
}

属性​

名称类型必选约束中文名说明
taskIdintegertruenonenone

FileOptStartResult

{
  "taskId": 1
}

属性​

oneOf

名称类型必选约束中文名说明
anonymousFileOptTaskDatafalsenonenone

xor

名称类型必选约束中文名说明
anonymous[FileInfo]falsenonenone

FileOptState

{
  "state": "count",
  "operate": "move",
  "info": "string",
  "message": "string"
}

属性​

名称类型必选约束中文名说明
statestringtruenonenone
operatestringtruenonenone
infostringtruenonenone
messagestringtruenonenone

枚举值​

属性值
statecount
stateconflict
statesave
statedone
statecancel
stateerror
operatemove
operatecopy
operatesave

FileIdListRequest

{
  "fileIds": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
fileIds[string]truenonenone

FileStoreMapRequest

{
  "property1": 0,
  "property2": 0
}

属性​

名称类型必选约束中文名说明
additionalPropertiesintegerfalsenonenone

FileUploadRequest

{
  "property1": "string",
  "property2": "string"
}

属性​

名称类型必选约束中文名说明
additionalPropertiesstring(binary)falsenonenone

FileInfoResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": "string",
    "parentId": "string",
    "storeId": 0,
    "pathId": 0,
    "path": "string",
    "grade": 0,
    "name": "string",
    "type": "string",
    "size": 0,
    "createdBy": 0,
    "accessedBy": 0,
    "editedBy": 0,
    "modifiedBy": 0,
    "createdTime": 0,
    "accessedTime": 0,
    "editedTime": 0,
    "modifiedTime": 0,
    "clientId": "string",
    "cluster": "string",
    "offset": 0,
    "state": 0,
    "taskId": 0,
    "taskState": "string",
    "version": 0,
    "isFavorite": true,
    "isLock": true,
    "modificator": "string"
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataFileInfotruenonenone

FileInfoListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": "string",
      "parentId": "string",
      "storeId": 0,
      "pathId": 0,
      "path": "string",
      "grade": 0,
      "name": "string",
      "type": "string",
      "size": 0,
      "createdBy": 0,
      "accessedBy": 0,
      "editedBy": 0,
      "modifiedBy": 0,
      "createdTime": 0,
      "accessedTime": 0,
      "editedTime": 0,
      "modifiedTime": 0,
      "clientId": "string",
      "cluster": "string",
      "offset": 0,
      "state": 0,
      "taskId": 0,
      "taskState": "string",
      "version": 0,
      "isFavorite": true,
      "isLock": true,
      "modificator": "string"
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[FileInfo]truenonenone

FileBriefInfoListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": "string",
      "parentId": "string",
      "storeId": 0,
      "name": "string",
      "size": 0,
      "type": "string",
      "editedTime": 0,
      "descendantFile": true,
      "descendant": true
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[FileBriefInfo]truenonenone

FileTreeNodeListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": "string",
      "storeId": 0,
      "parentId": "string",
      "pathId": 0,
      "path": "string",
      "name": "string",
      "size": 0,
      "type": 0,
      "grade": 0,
      "editedTime": "string"
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[FileTreeNode]truenonenone

FileListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "total": 0,
    "pageSize": 0,
    "pageNumber": 0,
    "list": [
      {
        "id": "string",
        "parentId": "string",
        "storeId": 0,
        "pathId": 0,
        "path": "string",
        "grade": 0,
        "name": "string",
        "type": "string",
        "size": 0,
        "createdBy": 0,
        "accessedBy": 0,
        "editedBy": 0,
        "modifiedBy": 0,
        "createdTime": 0,
        "accessedTime": 0,
        "editedTime": 0,
        "modifiedTime": 0,
        "clientId": "string",
        "cluster": "string",
        "offset": 0,
        "state": 0,
        "taskId": 0,
        "taskState": "string",
        "version": 0,
        "isFavorite": true,
        "isLock": true,
        "modificator": "string"
      }
    ]
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataFileListResulttruenonenone

FileSearchResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "total": 0,
    "pageSize": 0,
    "pageNumber": 0,
    "list": [
      {
        "id": "string",
        "storeId": 0,
        "pathId": 0,
        "path": "string",
        "name": "string",
        "type": "string",
        "size": 0,
        "editedTime": 0,
        "editedBy": 0,
        "storeName": "string",
        "editor": "string",
        "isFavorite": true,
        "isLock": true,
        "content": [
          "string"
        ]
      }
    ]
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataFileSearchResulttruenonenone

FileSummaryResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "name": "string",
    "type": "string",
    "size": 0,
    "path": "string",
    "createdBy": "string",
    "editedBy": "string",
    "createdTime": 0,
    "editedTime": 0
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataFileSummarytruenonenone

FileDetailResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "dirCount": 0,
    "fileCount": 0,
    "size": 0,
    "editedBy": "string",
    "editedTime": 0,
    "rights": [
      "string"
    ]
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataFileDetailtruenonenone

DirectoryDetailResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": "string",
    "parentId": "string",
    "storeId": 1,
    "name": "string",
    "fullPath": "string",
    "size": 0,
    "dirNum": 0,
    "fileNum": 0,
    "createdBy": 1,
    "createdTime": 0
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataDirectoryDetailtruenonenone

FileOperationLogListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "total": 0,
    "pageSize": 0,
    "pageNumber": 0,
    "list": [
      {
        "fileId": "string",
        "type": "string",
        "fileType": "string",
        "filePath": "string",
        "version": 0,
        "createdTime": "string",
        "detail": "string",
        "username": "string"
      }
    ]
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataFileOperationLogListResulttruenonenone

FileOptStartResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "taskId": 1
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataFileOptStartResulttruenonenone

FileOptStateResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "state": "count",
    "operate": "move",
    "info": "string",
    "message": "string"
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataFileOptStatetruenonenone

UserBasicInfo

{
  "id": 1,
  "account": "string",
  "name": "string",
  "type": "common",
  "quota": 0
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
accountstringtruenonenone
namestringtruenonenone
typestringtruenonenone
quotainteger(int64)truenonenone

UserPermissionMap

{
  "property1": true,
  "property2": true
}

权限检查结果，以操作名称为键。

属性​

名称类型必选约束中文名说明
additionalPropertiesbooleanfalsenonenone

UserServiceEndpoint

{
  "url": "string"
}

属性​

名称类型必选约束中文名说明
urlstringtruenonenone

UserOssServiceConfig

{
  "scheme": "http",
  "url": "string",
  "type": "string",
  "ssl": true,
  "endpoint": "string",
  "pathStyle": true,
  "region": "string",
  "bucket": "string",
  "credential": {}
}

属性​

名称类型必选约束中文名说明
schemestringtruenonenone
urlstringtruenonenone
typestringtruenonenone
sslbooleantruenonenone
endpointstringtruenonenone
pathStylebooleantruenonenone
regionstringtruenonenone
bucketstringtruenonenone
credentialGenericObjecttruenonenone

枚举值​

属性值
schemehttp
schemehttps

UserServiceConfig

{
  "standalone": true,
  "web": {
    "url": "string"
  },
  "api": {
    "url": "string"
  },
  "doc": {
    "url": "string"
  },
  "oss": {
    "scheme": "http",
    "url": "string",
    "type": "string",
    "ssl": true,
    "endpoint": "string",
    "pathStyle": true,
    "region": "string",
    "bucket": "string",
    "credential": {}
  },
  "yserver": {
    "url": "string"
  }
}

属性​

名称类型必选约束中文名说明
standalonebooleantruenonenone
webUserServiceEndpointtruenonenone
apiUserServiceEndpointtruenonenone
docUserServiceEndpointtruenonenone
ossUserOssServiceConfigtruenonenone
yserverUserServiceEndpointtruenonenone

UserLoginInfoData

{
  "userInfo": {
    "id": 1,
    "account": "string",
    "name": "string",
    "type": "common",
    "quota": 0
  },
  "service": {
    "standalone": true,
    "web": {
      "url": "string"
    },
    "api": {
      "url": "string"
    },
    "doc": {
      "url": "string"
    },
    "oss": {
      "scheme": "http",
      "url": "string",
      "type": "string",
      "ssl": true,
      "endpoint": "string",
      "pathStyle": true,
      "region": "string",
      "bucket": "string",
      "credential": {}
    },
    "yserver": {
      "url": "string"
    }
  }
}

属性​

名称类型必选约束中文名说明
userInfoUserBasicInfotruenonenone
serviceUserServiceConfigtruenonenone

UserLoginData

{
  "userInfo": {
    "id": 1,
    "account": "string",
    "name": "string",
    "type": "common",
    "quota": 0
  },
  "userRights": {
    "property1": true,
    "property2": true
  },
  "service": {
    "standalone": true,
    "web": {
      "url": "string"
    },
    "api": {
      "url": "string"
    },
    "doc": {
      "url": "string"
    },
    "oss": {
      "scheme": "http",
      "url": "string",
      "type": "string",
      "ssl": true,
      "endpoint": "string",
      "pathStyle": true,
      "region": "string",
      "bucket": "string",
      "credential": {}
    },
    "yserver": {
      "url": "string"
    }
  },
  "token": "string"
}

属性​

名称类型必选约束中文名说明
userInfoUserBasicInfotruenonenone
userRightsUserPermissionMaptruenone权限检查结果，以操作名称为键。
serviceUserServiceConfigtruenonenone
tokenstringtruenonenone

UserPathInfo

{
  "parentId": 1,
  "parentRelPathName": "string",
  "parentName": "string",
  "unitId": 1,
  "relPath": "string",
  "relPathName": "string",
  "inherit": "true"
}

属性​

名称类型必选约束中文名说明
parentIdintegertruenonenone
parentRelPathNamestringtruenonenone
parentNamestringtruenonenone
unitIdintegertruenonenone
relPathstringtruenonenone
relPathNamestringtruenonenone
inheritstringtruenonenone

枚举值​

属性值
inherittrue
inheritfalse

UserRoleScope

{
  "objId": 0,
  "objType": "dept",
  "objRelPathName": "string",
  "objName": "string"
}

属性​

名称类型必选约束中文名说明
objIdintegertruenonenone
objTypestringtruenonenone
objRelPathNamestringtruenonenone
objNamestringtruenonenone

UserAssignedRole

{
  "roleId": 1,
  "roleName": "string",
  "objInfos": [
    {
      "objId": 0,
      "objType": "dept",
      "objRelPathName": "string",
      "objName": "string"
    }
  ]
}

属性​

名称类型必选约束中文名说明
roleIdintegertruenonenone
roleNamestringtruenonenone
objInfos[UserRoleScope]truenonenone

UserDetail

{
  "id": 1,
  "account": "string",
  "name": "string",
  "type": "string",
  "quota": 0,
  "gender": "string",
  "email": "string",
  "mobile": "string",
  "sn": "string",
  "state": "string",
  "used": 0,
  "extranet": "true",
  "path": [
    {
      "parentId": 1,
      "parentRelPathName": "string",
      "parentName": "string",
      "unitId": 1,
      "relPath": "string",
      "relPathName": "string",
      "inherit": "true"
    }
  ],
  "roles": [
    {
      "roleId": 1,
      "roleName": "string",
      "objInfos": [
        {
          "objId": 0,
          "objType": "dept",
          "objRelPathName": "string",
          "objName": "string"
        }
      ]
    }
  ],
  "sso": [
    {}
  ]
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
accountstringtruenonenone
namestringtruenonenone
typestringfalsenonenone
quotainteger(int64)falsenonenone
genderstringfalsenonenone
emailstringfalsenonenone
mobilestringfalsenonenone
snstringfalsenonenone
statestringfalsenonenone
usedinteger(int64)falsenonenone
extranetstringfalsenonenone
path[UserPathInfo]falsenonenone
roles[UserAssignedRole]falsenonenone
ssoGenericObjectListfalsenonenone

枚举值​

属性值
extranettrue
extranetfalse

UserParentInfoInput

{
  "parentId": 1,
  "inherit": "true"
}

属性​

名称类型必选约束中文名说明
parentIdintegertruenonenone
inheritstringtruenonenone

枚举值​

属性值
inherittrue
inheritfalse

UserRoleAssignInput

{
  "roleId": 1,
  "objId": 0
}

属性​

名称类型必选约束中文名说明
roleIdintegertruenonenone
objIdintegertruenonenone

UserCreateInput

{
  "account": "string",
  "password": "string",
  "name": "string",
  "quota": 0,
  "gender": "m",
  "email": "string",
  "mobile": "string",
  "state": "string",
  "extranet": "true",
  "parentInfos": [
    {
      "parentId": 1,
      "inherit": "true"
    }
  ],
  "roleInfos": [
    {
      "roleId": 1,
      "objId": 0
    }
  ]
}

属性​

名称类型必选约束中文名说明
accountstringtruenonenone
passwordstringtruenone当前 API 实现接受的密码 SHA-256 摘要。
namestringtruenonenone
quotaintegerfalsenone当前创建用户实现接受的配额值。
genderstringfalsenonenone
emailstringfalsenonenone
mobilestringfalsenonenone
statestringfalsenonenone
extranetstringfalsenonenone
parentInfos[UserParentInfoInput]truenonenone
roleInfos[UserRoleAssignInput]falsenonenone

枚举值​

属性值
genderm
genderf
extranettrue
extranetfalse

UserUpdateRoleDelta

{
  "add": [
    {
      "roleId": 1,
      "objId": 0
    }
  ],
  "delete": [
    {
      "roleId": 1,
      "objId": 0
    }
  ]
}

属性​

名称类型必选约束中文名说明
add[UserRoleAssignInput]falsenonenone
delete[UserRoleAssignInput]falsenonenone

UserUpdateInput

{
  "id": 1,
  "account": "string",
  "name": "string",
  "sn": "string",
  "state": "string",
  "password": "string",
  "quota": 0,
  "gender": "m",
  "email": "string",
  "mobile": "string",
  "joinTime": "2024-01-01",
  "successor": 1,
  "extranet": "true",
  "parentInfos": [
    {
      "parentId": 1,
      "inherit": "true"
    }
  ],
  "roleInfos": {
    "add": [
      {
        "roleId": 1,
        "objId": 0
      }
    ],
    "delete": [
      {
        "roleId": 1,
        "objId": 0
      }
    ]
  }
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
accountstringtruenonenone
namestringtruenonenone
snstringtruenonenone
statestringtruenonenone
passwordstringfalsenone可选的替换密码摘要。
quotaintegerfalsenone当前更新用户实现的配额值，单位为 GiB。
genderstringfalsenonenone
emailstringfalsenonenone
mobilestringfalsenonenone
joinTimestringfalsenonenone
successorintegerfalsenonenone
extranetstringfalsenonenone
parentInfos[UserParentInfoInput]falsenonenone
roleInfosUserUpdateRoleDeltafalsenonenone

枚举值​

属性值
genderm
genderf
extranettrue
extranetfalse

UserFilePolicy

{
  "subId": 1,
  "subName": "string",
  "objId": "string",
  "objType": "string",
  "objPathName": "string",
  "sourceType": "string",
  "source": "string"
}

属性​

名称类型必选约束中文名说明
subIdintegerfalsenonenone
subNamestringfalsenonenone
objIdstringfalsenonenone
objTypestringfalsenonenone
objPathNamestringfalsenonenone
sourceTypestringfalsenonenone
sourcestringfalsenonenone

UserPositionPolicy

{
  "subId": 1,
  "subName": "string",
  "objId": 0,
  "objPathName": "string",
  "sourceType": "string",
  "source": "string"
}

属性​

名称类型必选约束中文名说明
subIdintegerfalsenonenone
subNamestringfalsenonenone
objIdintegerfalsenonenone
objPathNamestringfalsenonenone
sourceTypestringfalsenonenone
sourcestringfalsenonenone

UserRoleListItem

{
  "name": "string",
  "owner": 0,
  "level": "string",
  "subId": 1,
  "roleId": 1,
  "objId": 0,
  "objPathName": "string",
  "source": "string"
}

属性​

名称类型必选约束中文名说明
namestringtruenonenone
ownerintegertruenonenone
levelstringtruenonenone
subIdintegertruenonenone
roleIdintegertruenonenone
objIdintegertruenonenone
objPathNamestringtruenonenone
sourcestringtruenonenone

UserLogQuery

{
  "begin": "2024-01-01",
  "end": "2024-01-31",
  "types": [
    "string"
  ],
  "userIds": [
    1
  ],
  "pageNumber": 1,
  "pageSize": 1
}

属性​

名称类型必选约束中文名说明
beginstringtruenonenone
endstringtruenonenone
types[string]falsenonenone
userIds[integer]falsenonenone
pageNumberintegerfalsenonenone
pageSizeintegerfalsenonenone

UserLogEntry

{
  "id": 1,
  "account": "string",
  "username": "string",
  "type": "store",
  "recordId": 1,
  "recordType": "string",
  "ip": "string",
  "platform": "string",
  "createdTime": "string",
  "object": "string",
  "path": "string",
  "detail": "string"
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
accountstringtruenonenone
usernamestringtruenonenone
typestringtruenonenone
recordIdintegertruenonenone
recordTypestringtruenonenone
ipstringtruenonenone
platformstringtruenonenone
createdTimestringtruenonenone
objectstring¦nullfalsenonenone
pathstring¦nullfalsenonenone
detailstring¦nullfalsenonenone

枚举值​

属性值
typestore
typefile
typeorganization
typesystem

UserLogResult

{
  "total": 0,
  "pageSize": 1,
  "pageNumber": 1,
  "list": [
    {
      "id": 1,
      "account": "string",
      "username": "string",
      "type": "store",
      "recordId": 1,
      "recordType": "string",
      "ip": "string",
      "platform": "string",
      "createdTime": "string",
      "object": "string",
      "path": "string",
      "detail": "string"
    }
  ]
}

属性​

名称类型必选约束中文名说明
totalintegertruenonenone
pageSizeintegertruenonenone
pageNumberintegertruenonenone
list[UserLogEntry]truenonenone

UserBasicInfoResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": 1,
    "account": "string",
    "name": "string",
    "type": "common",
    "quota": 0
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataUserBasicInfotruenonenone

UserDetailResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": 1,
    "account": "string",
    "name": "string",
    "type": "string",
    "quota": 0,
    "gender": "string",
    "email": "string",
    "mobile": "string",
    "sn": "string",
    "state": "string",
    "used": 0,
    "extranet": "true",
    "path": [
      {
        "parentId": 1,
        "parentRelPathName": "string",
        "parentName": "string",
        "unitId": 1,
        "relPath": "string",
        "relPathName": "string",
        "inherit": "true"
      }
    ],
    "roles": [
      {
        "roleId": 1,
        "roleName": "string",
        "objInfos": [
          {
            "objId": null,
            "objType": null,
            "objRelPathName": null,
            "objName": null
          }
        ]
      }
    ],
    "sso": [
      {}
    ]
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataUserDetailtruenonenone

UserLoginInfoResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "userInfo": {
      "id": 1,
      "account": "string",
      "name": "string",
      "type": "common",
      "quota": 0
    },
    "service": {
      "standalone": true,
      "web": {
        "url": "string"
      },
      "api": {
        "url": "string"
      },
      "doc": {
        "url": "string"
      },
      "oss": {
        "scheme": "http",
        "url": "string",
        "type": "string",
        "ssl": true,
        "endpoint": "string",
        "pathStyle": true,
        "region": "string",
        "bucket": "string",
        "credential": {}
      },
      "yserver": {
        "url": "string"
      }
    }
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataUserLoginInfoDatatruenonenone

UserLoginResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "userInfo": {
      "id": 1,
      "account": "string",
      "name": "string",
      "type": "common",
      "quota": 0
    },
    "userRights": {
      "property1": true,
      "property2": true
    },
    "service": {
      "standalone": true,
      "web": {
        "url": "string"
      },
      "api": {
        "url": "string"
      },
      "doc": {
        "url": "string"
      },
      "oss": {
        "scheme": "http",
        "url": "string",
        "type": "string",
        "ssl": true,
        "endpoint": "string",
        "pathStyle": true,
        "region": "string",
        "bucket": "string",
        "credential": {}
      },
      "yserver": {
        "url": "string"
      }
    },
    "token": "string"
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataUserLoginDatatruenonenone

UserFilePolicyListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "subId": 1,
      "subName": "string",
      "objId": "string",
      "objType": "string",
      "objPathName": "string",
      "sourceType": "string",
      "source": "string"
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[UserFilePolicy]truenonenone

UserPositionPolicyListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "subId": 1,
      "subName": "string",
      "objId": 0,
      "objPathName": "string",
      "sourceType": "string",
      "source": "string"
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[UserPositionPolicy]truenonenone

UserRoleListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "name": "string",
      "owner": 0,
      "level": "string",
      "subId": 1,
      "roleId": 1,
      "objId": 0,
      "objPathName": "string",
      "source": "string"
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[UserRoleListItem]truenonenone

UserPermissionMapResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "property1": true,
    "property2": true
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataUserPermissionMaptruenone权限检查结果，以操作名称为键。

UserLogListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "total": 0,
    "pageSize": 1,
    "pageNumber": 1,
    "list": [
      {
        "id": 1,
        "account": "string",
        "username": "string",
        "type": "store",
        "recordId": 1,
        "recordType": "string",
        "ip": "string",
        "platform": "string",
        "createdTime": "string",
        "object": "string",
        "path": "string",
        "detail": "string"
      }
    ]
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataUserLogResulttruenonenone

MessageInfo

{
  "id": 1,
  "type": "shareFile",
  "status": "string",
  "userId": 1,
  "dataId": 1,
  "data": {
    "id": "string",
    "parentId": "string",
    "storeId": 0,
    "pathId": 0,
    "path": "string",
    "grade": 0,
    "name": "string",
    "type": "string",
    "size": 0,
    "createdBy": 0,
    "accessedBy": 0,
    "editedBy": 0,
    "modifiedBy": 0,
    "createdTime": 0,
    "accessedTime": 0,
    "editedTime": 0,
    "modifiedTime": 0,
    "clientId": "string",
    "cluster": "string",
    "offset": 0,
    "state": 0,
    "taskId": 0,
    "taskState": "string",
    "version": 0,
    "isFavorite": true,
    "isLock": true,
    "modificator": "string"
  },
  "topic": "string",
  "structuredTopic": {},
  "createdTime": "string"
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
typestringtruenonenone
statusstringtruenonenone
userIdintegertruenonenone
dataIdintegertruenonenone
dataFileInfofalsenonenone
topicstringtruenonenone
structuredTopicobject¦nullfalsenonenone
createdTimestringtruenonenone

MessageInfoResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": 1,
    "type": "shareFile",
    "status": "string",
    "userId": 1,
    "dataId": 1,
    "data": {
      "id": "string",
      "parentId": "string",
      "storeId": 0,
      "pathId": 0,
      "path": "string",
      "grade": 0,
      "name": "string",
      "type": "string",
      "size": 0,
      "createdBy": 0,
      "accessedBy": 0,
      "editedBy": 0,
      "modifiedBy": 0,
      "createdTime": 0,
      "accessedTime": 0,
      "editedTime": 0,
      "modifiedTime": 0,
      "clientId": "string",
      "cluster": "string",
      "offset": 0,
      "state": 0,
      "taskId": 0,
      "taskState": "string",
      "version": 0,
      "isFavorite": true,
      "isLock": true,
      "modificator": "string"
    },
    "topic": "string",
    "structuredTopic": {},
    "createdTime": "string"
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataMessageInfotruenonenone

OrganizationNodePath

{
  "parentId": 0,
  "parentName": "string",
  "unitId": 1,
  "unitName": "string",
  "relPath": "string",
  "absPath": "string",
  "relPathName": "string"
}

属性​

名称类型必选约束中文名说明
parentIdintegertruenonenone
parentNamestringtruenonenone
unitIdintegertruenonenone
unitNamestringtruenonenone
relPathstringtruenonenone
absPathstringtruenonenone
relPathNamestringtruenonenone

OrganizationDetailPath

{
  "parentId": 0,
  "parentName": "string",
  "parentRelPathName": "string",
  "unitId": 1,
  "unitName": "string",
  "unitRelPathName": "string",
  "relPath": "string",
  "relPathName": "string",
  "inherit": "true"
}

属性​

名称类型必选约束中文名说明
parentIdintegertruenonenone
parentNamestringtruenonenone
parentRelPathNamestringtruenonenone
unitIdintegertruenonenone
unitNamestringtruenonenone
unitRelPathNamestringtruenonenone
relPathstringtruenonenone
relPathNamestringtruenonenone
inheritstringtruenonenone

枚举值​

属性值
inherittrue
inheritfalse

OrganizationTreeNode

{
  "id": 1,
  "parentId": 0,
  "unitId": 1,
  "name": "string",
  "type": "unit",
  "children": [
    {
      "id": 1,
      "parentId": 0,
      "unitId": 1,
      "name": "string",
      "type": "unit",
      "children": [
        {
          "id": 1,
          "parentId": 0,
          "unitId": 1,
          "name": "string",
          "type": "unit",
          "children": [
            {}
          ],
          "userIds": [
            1
          ]
        }
      ],
      "userIds": [
        1
      ]
    }
  ],
  "userIds": [
    1
  ]
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
parentIdintegerfalsenonenone
unitIdintegerfalsenonenone
namestringtruenonenone
typestringtruenonenone
children[OrganizationTreeNode]falsenonenone
userIds[integer]falsenonenone

枚举值​

属性值
typeunit
typedept

OrganizationNode

{
  "id": 1,
  "name": "string",
  "type": "unit",
  "account": "string",
  "email": "string",
  "mobile": "string",
  "state": "string",
  "path": [
    {
      "parentId": 0,
      "parentName": "string",
      "unitId": 1,
      "unitName": "string",
      "relPath": "string",
      "absPath": "string",
      "relPathName": "string"
    }
  ],
  "managers": [
    {
      "managerId": 1,
      "managerName": "string",
      "managerRelPathName": "string",
      "roleInfos": [
        {
          "id": 1,
          "name": "string"
        }
      ]
    }
  ],
  "roles": [
    {
      "roleId": 1,
      "roleName": "string",
      "objInfos": [
        {
          "objId": 0,
          "objType": "dept",
          "objRelPathName": "string",
          "objName": "string"
        }
      ]
    }
  ]
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
namestringtruenonenone
typestringtruenonenone
accountstringfalsenonenone
emailstringfalsenonenone
mobilestringfalsenonenone
statestringfalsenonenone
path[OrganizationNodePath]truenonenone
managers[RoleManagerListItem]falsenonenone
roles[UserAssignedRole]falsenonenone

枚举值​

属性值
typeunit
typedept
typeuser

OrganizationDetail

{
  "id": 1,
  "name": "string",
  "type": "unit",
  "quota": 0,
  "path": [
    {
      "parentId": 0,
      "parentName": "string",
      "parentRelPathName": "string",
      "unitId": 1,
      "unitName": "string",
      "unitRelPathName": "string",
      "relPath": "string",
      "relPathName": "string",
      "inherit": "true"
    }
  ],
  "managers": [
    {
      "managerId": 1,
      "managerName": "string",
      "managerRelPathName": "string",
      "roleInfos": [
        {
          "id": 1,
          "name": "string"
        }
      ]
    }
  ],
  "roles": [
    {
      "roleId": 1,
      "roleName": "string",
      "objInfos": [
        {
          "objId": 0,
          "objType": "dept",
          "objRelPathName": "string",
          "objName": "string"
        }
      ]
    }
  ],
  "used": 0,
  "sso": [
    {}
  ]
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
namestringtruenonenone
typestringtruenonenone
quotainteger(int64)falsenone存储配额，单位为字节。
path[OrganizationDetailPath]truenonenone
managers[RoleManagerListItem]truenonenone
roles[UserAssignedRole]truenonenone
usedinteger(int64)truenonenone
ssoGenericObjectListtruenonenone

枚举值​

属性值
typeunit
typedept
typeuser

OrganizationCreateParentInput

{
  "id": 1,
  "inherit": "true"
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
inheritstringtruenonenone

枚举值​

属性值
inherittrue
inheritfalse

OrganizationUpdateParentInput

{
  "parentId": 1,
  "inherit": "true"
}

属性​

名称类型必选约束中文名说明
parentIdintegertruenonenone
inheritstringtruenonenone

枚举值​

属性值
inherittrue
inheritfalse

OrganizationManagerSeedInput

{
  "subId": 1,
  "roleId": 1
}

属性​

名称类型必选约束中文名说明
subIdintegertruenonenone
roleIdintegertruenonenone

OrganizationRoleSeedInput

{
  "roleId": 1,
  "objId": 0
}

属性​

名称类型必选约束中文名说明
roleIdintegertruenonenone
objIdintegerfalsenonenone

OrganizationRoleDelta

{
  "add": [
    {
      "subId": 1,
      "roleId": 1,
      "objId": 0
    }
  ],
  "delete": [
    {
      "subId": 1,
      "roleId": 1,
      "objId": 0
    }
  ]
}

属性​

名称类型必选约束中文名说明
add[RoleAssignInput]falsenonenone
delete[RoleAssignInput]falsenonenone

OrganizationCreateInput

{
  "parentInfos": [
    {
      "id": 1,
      "inherit": "true"
    }
  ],
  "type": "unit",
  "name": "string",
  "managerInfos": [
    {
      "subId": 1,
      "roleId": 1
    }
  ],
  "roleInfos": [
    {
      "roleId": 1,
      "objId": 0
    }
  ]
}

属性​

名称类型必选约束中文名说明
parentInfos[OrganizationCreateParentInput]truenonenone
typestringtruenonenone
namestringtruenonenone
managerInfos[OrganizationManagerSeedInput]falsenonenone
roleInfos[OrganizationRoleSeedInput]falsenonenone

枚举值​

属性值
typeunit
typedept

OrganizationUpdateInput

{
  "id": 1,
  "parentInfos": [
    {
      "parentId": 1,
      "inherit": "true"
    }
  ],
  "type": "unit",
  "name": "string",
  "quota": 0,
  "managerInfos": {
    "add": [
      {
        "subId": 1,
        "roleId": 1,
        "objId": 0
      }
    ],
    "delete": [
      {
        "subId": 1,
        "roleId": 1,
        "objId": 0
      }
    ]
  },
  "roleInfos": {
    "add": [
      {
        "subId": 1,
        "roleId": 1,
        "objId": 0
      }
    ],
    "delete": [
      {
        "subId": 1,
        "roleId": 1,
        "objId": 0
      }
    ]
  }
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
parentInfos[OrganizationUpdateParentInput]falsenonenone
typestringtruenonenone
namestringtruenonenone
quotaintegerfalsenone更新接口接受的配额值，单位为 GiB。
managerInfosOrganizationRoleDeltafalsenonenone
roleInfosOrganizationRoleDeltafalsenonenone

枚举值​

属性值
typeunit
typedept

OrganizationRemoveInput

{
  "parentId": 1,
  "id": 1,
  "isRevokeRole": true
}

属性​

名称类型必选约束中文名说明
parentIdintegertruenonenone
idintegertruenonenone
isRevokeRolebooleanfalsenonenone

OrganizationExtraItem

{
  "id": 1,
  "quota": 0,
  "managers": [
    {
      "managerId": 1,
      "managerName": "string",
      "managerRelPathName": "string",
      "roleInfos": [
        {
          "id": 1,
          "name": "string"
        }
      ]
    }
  ],
  "roles": [
    {
      "roleId": 1,
      "roleName": "string",
      "objInfos": [
        {
          "objId": 0,
          "objType": "dept",
          "objRelPathName": "string",
          "objName": "string"
        }
      ]
    }
  ],
  "used": 0
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
quotainteger(int64)truenonenone
managers[RoleManagerListItem]truenonenone
roles[UserAssignedRole]truenonenone
usedinteger(int64)truenonenone

RemoteOrganizationNode

{
  "id": "string",
  "parentId": "string",
  "type": "unit",
  "name": "string",
  "account": "string",
  "email": "string",
  "mobile": "string",
  "state": "string",
  "parents": [
    "string"
  ],
  "absPathName": "string",
  "storey": 0
}

属性​

名称类型必选约束中文名说明
idstringtruenonenone
parentIdstringtruenonenone
typestringtruenonenone
namestringtruenonenone
accountstringfalsenonenone
emailstringfalsenonenone
mobilestringfalsenonenone
statestringfalsenonenone
parents[string]truenonenone
absPathNamestringtruenonenone
storeyintegertruenonenone

枚举值​

属性值
typeunit
typedept
typeuser

OrganizationTreeResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "parentId": 0,
      "unitId": 1,
      "name": "string",
      "type": "unit",
      "children": [
        {
          "id": 1,
          "parentId": 0,
          "unitId": 1,
          "name": "string",
          "type": "unit",
          "children": [
            {}
          ],
          "userIds": [
            1
          ]
        }
      ],
      "userIds": [
        1
      ]
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[OrganizationTreeNode]truenonenone

OrganizationNodeListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "name": "string",
      "type": "unit",
      "account": "string",
      "email": "string",
      "mobile": "string",
      "state": "string",
      "path": [
        {
          "parentId": 0,
          "parentName": "string",
          "unitId": 1,
          "unitName": "string",
          "relPath": "string",
          "absPath": "string",
          "relPathName": "string"
        }
      ],
      "managers": [
        {
          "managerId": 1,
          "managerName": "string",
          "managerRelPathName": "string",
          "roleInfos": [
            {}
          ]
        }
      ],
      "roles": [
        {
          "roleId": 1,
          "roleName": "string",
          "objInfos": [
            {}
          ]
        }
      ]
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[OrganizationNode]truenonenone

OrganizationDetailResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": 1,
    "name": "string",
    "type": "unit",
    "quota": 0,
    "path": [
      {
        "parentId": 0,
        "parentName": "string",
        "parentRelPathName": "string",
        "unitId": 1,
        "unitName": "string",
        "unitRelPathName": "string",
        "relPath": "string",
        "relPathName": "string",
        "inherit": "true"
      }
    ],
    "managers": [
      {
        "managerId": 1,
        "managerName": "string",
        "managerRelPathName": "string",
        "roleInfos": [
          {
            "id": null,
            "name": null
          }
        ]
      }
    ],
    "roles": [
      {
        "roleId": 1,
        "roleName": "string",
        "objInfos": [
          {
            "objId": null,
            "objType": null,
            "objRelPathName": null,
            "objName": null
          }
        ]
      }
    ],
    "used": 0,
    "sso": [
      {}
    ]
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataOrganizationDetailtruenonenone

OrganizationExtraListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "quota": 0,
      "managers": [
        {
          "managerId": 1,
          "managerName": "string",
          "managerRelPathName": "string",
          "roleInfos": [
            {}
          ]
        }
      ],
      "roles": [
        {
          "roleId": 1,
          "roleName": "string",
          "objInfos": [
            {}
          ]
        }
      ],
      "used": 0
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[OrganizationExtraItem]truenonenone

RemoteOrganizationNodeListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": "string",
      "parentId": "string",
      "type": "unit",
      "name": "string",
      "account": "string",
      "email": "string",
      "mobile": "string",
      "state": "string",
      "parents": [
        "string"
      ],
      "absPathName": "string",
      "storey": 0
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[RemoteOrganizationNode]truenonenone

PathLocation

{
  "type": "root",
  "storeGroupId": "",
  "storeId": 0,
  "fileId": "string"
}

属性​

名称类型必选约束中文名说明
typestringtruenonenone
storeGroupIdstringtruenonenone
storeIdintegertruenonenone
fileIdstringtruenonenone

枚举值​

属性值
typeroot
typestoreGroup
typestore
typefile
storeGroupId
storeGroupIdprivate
storeGroupIdcooperative
storeGroupIdpublic

PathLocationResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "type": "root",
    "storeGroupId": "",
    "storeId": 0,
    "fileId": "string"
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataPathLocationtruenonenone

PermissionObjectIdentifier

0

属性​

oneOf

名称类型必选约束中文名说明
anonymousintegerfalsenonenone

xor

名称类型必选约束中文名说明
anonymousstringfalsenonenone

PermissionActionList

[
  "string"
]

属性​

None

PermissionBooleanMap

{
  "property1": true,
  "property2": true
}

布尔结果映射，以规则 ID、权限 ID 或操作名称为键。

属性​

名称类型必选约束中文名说明
additionalPropertiesbooleanfalsenonenone

PermissionActGroup

{
  "id": 1,
  "name": "string",
  "acts": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
namestringtruenonenone
actsPermissionActionListtruenonenone

PermissionActGroupCreateInput

{
  "name": "string",
  "acts": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
namestringtruenonenone
actsPermissionActionListtruenonenone

PermissionFileRuleExistCheckInput

{
  "subId": 1,
  "objId": 0,
  "eft": "allow"
}

属性​

名称类型必选约束中文名说明
subIdintegertruenonenone
objIdPermissionObjectIdentifiertruenonenone
eftstringtruenonenone

枚举值​

属性值
eftallow
eftdeny

PermissionFileRuleExistCheckItem

{
  "subId": 1,
  "objId": 0,
  "eft": "allow",
  "subName": "string",
  "IsExistSameName": true
}

属性​

名称类型必选约束中文名说明
subIdintegertruenonenone
objIdPermissionObjectIdentifiertruenonenone
eftstringtruenonenone
subNamestringtruenonenone
IsExistSameNamebooleantruenonenone

枚举值​

属性值
eftallow
eftdeny

PermissionFileRuleInput

{
  "subId": 1,
  "objId": 0,
  "objType": "store",
  "eft": "allow",
  "replace": true,
  "acts": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
subIdintegertruenonenone
objIdPermissionObjectIdentifiertruenonenone
objTypestringtruenonenone
eftstringtruenonenone
replacebooleanfalsenonenone
actsPermissionActionListtruenonenone

枚举值​

属性值
objTypestore
objTypefile
eftallow
eftdeny

PermissionFileRuleUpdateInput

{
  "storeId": 1,
  "ruleId": 1,
  "eft": "allow",
  "replace": true,
  "acts": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
storeIdintegertruenonenone
ruleIdintegertruenonenone
eftstringtruenonenone
replacebooleanfalsenonenone
actsPermissionActionListtruenonenone

枚举值​

属性值
eftallow
eftdeny

PermissionFileRuleBatchUpdateInput

{
  "storeId": 1,
  "ruleIds": [
    1
  ],
  "eft": "allow",
  "operateType": "add",
  "acts": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
storeIdintegertruenonenone
ruleIds[integer]truenonenone
eftstringfalsenonenone
operateTypestringfalsenonenone
actsPermissionActionListtruenonenone

枚举值​

属性值
eftallow
eftdeny

PermissionFileRuleItem

{
  "ruleId": 1,
  "subId": 1,
  "objId": 0,
  "eft": "allow",
  "acts": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
ruleIdintegertruenonenone
subIdintegertruenonenone
objIdPermissionObjectIdentifiertruenonenone
eftstringtruenonenone
actsPermissionActionListtruenonenone

枚举值​

属性值
eftallow
eftdeny

PermissionFileRuleByFileItem

{
  "ruleId": 1,
  "subId": 1,
  "subName": "string",
  "subPathName": "string",
  "eft": "allow",
  "acts": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
ruleIdintegertruenonenone
subIdintegertruenonenone
subNamestringtruenonenone
subPathNamestringtruenonenone
eftstringtruenonenone
actsPermissionActionListtruenonenone

枚举值​

属性值
eftallow
eftdeny

PermissionPositionRightExistCheckInput

{
  "subId": 1,
  "objId": 1,
  "eft": "allow"
}

属性​

名称类型必选约束中文名说明
subIdintegertruenonenone
objIdintegertruenonenone
eftstringtruenonenone

枚举值​

属性值
eftallow
eftdeny

PermissionPositionRightExistCheckItem

{
  "subId": 1,
  "objId": 1,
  "eft": "allow",
  "subName": "string",
  "objName": "string",
  "IsExistSameName": true
}

属性​

名称类型必选约束中文名说明
subIdintegertruenonenone
objIdintegertruenonenone
eftstringtruenonenone
subNamestringtruenonenone
objNamestringtruenonenone
IsExistSameNamebooleantruenonenone

枚举值​

属性值
eftallow
eftdeny

PermissionPositionRightInput

{
  "subId": 1,
  "objId": 1,
  "eft": "allow",
  "replace": true,
  "acts": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
subIdintegertruenonenone
objIdintegertruenonenone
eftstringtruenonenone
replacebooleanfalsenonenone
actsPermissionActionListtruenonenone

枚举值​

属性值
eftallow
eftdeny

PermissionPositionRightUpdateInput

{
  "rightId": 1,
  "eft": "allow",
  "replace": true,
  "acts": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
rightIdintegertruenonenone
eftstringtruenonenone
replacebooleanfalsenonenone
actsPermissionActionListtruenonenone

枚举值​

属性值
eftallow
eftdeny

PermissionPositionRightBatchUpdateInput

{
  "rightIds": [
    1
  ],
  "eft": "allow",
  "operateType": "add",
  "acts": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
rightIds[integer]truenonenone
eftstringfalsenonenone
operateTypestringfalsenonenone
actsPermissionActionListtruenonenone

枚举值​

属性值
eftallow
eftdeny

PermissionPositionRightItem

{
  "rightId": 1,
  "subId": 1,
  "objId": 1,
  "eft": "allow",
  "acts": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
rightIdintegertruenonenone
subIdintegertruenonenone
objIdintegertruenonenone
eftstringtruenonenone
actsPermissionActionListtruenonenone

枚举值​

属性值
eftallow
eftdeny

PermissionPositionRightByOrgItem

{
  "rightId": 1,
  "objId": 1,
  "objName": "string",
  "objPathName": "string",
  "eft": "allow",
  "acts": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
rightIdintegertruenonenone
objIdintegertruenonenone
objNamestringtruenonenone
objPathNamestringtruenonenone
eftstringtruenonenone
actsPermissionActionListtruenonenone

枚举值​

属性值
eftallow
eftdeny

PermissionFileRightExistCheckInput

{
  "subId": 1,
  "objId": 0,
  "objType": "store",
  "eft": "allow"
}

属性​

名称类型必选约束中文名说明
subIdintegertruenonenone
objIdPermissionObjectIdentifiertruenonenone
objTypestringtruenonenone
eftstringtruenonenone

枚举值​

属性值
objTypestore
objTypefile
eftallow
eftdeny

PermissionFileRightExistCheckItem

{
  "subId": 1,
  "objId": 0,
  "objType": "store",
  "eft": "allow",
  "IsExistSameName": true
}

属性​

名称类型必选约束中文名说明
subIdintegertruenonenone
objIdPermissionObjectIdentifiertruenonenone
objTypestringtruenonenone
eftstringtruenonenone
IsExistSameNamebooleantruenonenone

枚举值​

属性值
objTypestore
objTypefile
eftallow
eftdeny

PermissionFileRightInput

{
  "subId": 1,
  "storeId": 1,
  "objId": 0,
  "objType": "store",
  "eft": "allow",
  "replace": true,
  "acts": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
subIdintegertruenonenone
storeIdintegerfalsenonenone
objIdPermissionObjectIdentifiertruenonenone
objTypestringtruenonenone
eftstringtruenonenone
replacebooleanfalsenonenone
actsPermissionActionListtruenonenone

枚举值​

属性值
objTypestore
objTypefile
eftallow
eftdeny

PermissionFileRightUpdateInput

{
  "rightId": 1,
  "objId": 0,
  "objType": "store",
  "eft": "allow",
  "replace": true,
  "acts": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
rightIdintegertruenonenone
objIdPermissionObjectIdentifiertruenonenone
objTypestringtruenonenone
eftstringtruenonenone
replacebooleanfalsenonenone
actsPermissionActionListtruenonenone

枚举值​

属性值
objTypestore
objTypefile
eftallow
eftdeny

PermissionFileRightBatchUpdateInput

{
  "rightIds": [
    1
  ],
  "eft": "allow",
  "operateType": "add",
  "acts": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
rightIds[integer]truenonenone
eftstringfalsenonenone
operateTypestringfalsenonenone
actsPermissionActionListtruenonenone

枚举值​

属性值
eftallow
eftdeny

PermissionFileRightItem

{
  "rightId": 1,
  "subId": 1,
  "objId": 0,
  "objType": "store",
  "storeId": 1,
  "objPathName": "string",
  "objName": "string",
  "eft": "allow",
  "acts": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
rightIdintegertruenonenone
subIdintegertruenonenone
objIdPermissionObjectIdentifiertruenonenone
objTypestringtruenonenone
storeIdintegertruenonenone
objPathNamestringtruenonenone
objNamestringtruenonenone
eftstringtruenonenone
actsPermissionActionListtruenonenone

枚举值​

属性值
objTypestore
objTypefile
eftallow
eftdeny

PermissionFileRightByOrgItem

{
  "rightId": 1,
  "objId": 0,
  "objType": "store",
  "storeId": 1,
  "objPathName": "string",
  "objName": "string",
  "eft": "allow",
  "acts": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
rightIdintegertruenonenone
objIdPermissionObjectIdentifiertruenonenone
objTypestringtruenonenone
storeIdintegertruenonenone
objPathNamestringtruenonenone
objNamestringtruenonenone
eftstringtruenonenone
actsPermissionActionListtruenonenone

枚举值​

属性值
objTypestore
objTypefile
eftallow
eftdeny

PermissionPreAuthorizationFileInput

{
  "storeId": 1,
  "type": "store",
  "fileId": "string"
}

属性​

名称类型必选约束中文名说明
storeIdintegertruenonenone
typestringtruenonenone
fileIdstringfalsenonenone

枚举值​

属性值
typestore
typefile

PermissionPreAuthorizationInput

{
  "orgIds": [
    1
  ],
  "files": [
    {
      "storeId": 1,
      "type": "store",
      "fileId": "string"
    }
  ],
  "fileActs": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
orgIds[integer]truenonenone
files[PermissionPreAuthorizationFileInput]truenonenone
fileActsPermissionActionListtruenonenone

PermissionGroupPreAuthorizationInput

{
  "orgIds": [
    1
  ],
  "groupIds": [
    1
  ]
}

属性​

名称类型必选约束中文名说明
orgIds[integer]truenonenone
groupIds[integer]truenonenone

PermissionNoPositionRightInfo

{
  "subId": 1,
  "subName": "string",
  "storeIdOwner": 1,
  "storeOwnerName": "string",
  "storeId": 1,
  "storeName": "string",
  "positionAct": "string"
}

属性​

名称类型必选约束中文名说明
subIdintegertruenonenone
subNamestringtruenonenone
storeIdOwnerintegertruenonenone
storeOwnerNamestringtruenonenone
storeIdintegertruenonenone
storeNamestringtruenonenone
positionActstringtruenonenone

PermissionPreAuthorizationResult

true

属性​

oneOf

名称类型必选约束中文名说明
anonymousbooleanfalsenonenone

xor

名称类型必选约束中文名说明
anonymous[PermissionNoPositionRightInfo]falsenonenone

PermissionFileCheckInput

{
  "objIds": "string",
  "acts": "string"
}

属性​

名称类型必选约束中文名说明
objIdsstringtruenone逗号分隔的对象 ID 列表。
actsstringtruenone逗号分隔的操作列表。

PermissionFileCheckByUserInput

{
  "objIds": "string",
  "acts": "string",
  "userId": 1
}

属性​

名称类型必选约束中文名说明
objIdsstringtruenone逗号分隔的对象 ID 列表。
actsstringtruenone逗号分隔的操作列表。
userIdintegerfalsenonenone

PermissionActCheckMap

{
  "property1": true,
  "property2": true
}

操作检查结果，以操作名称为键。

属性​

名称类型必选约束中文名说明
additionalPropertiesbooleanfalsenonenone

PermissionFileCheckObjectMap

{
  "property1": {
    "property1": true,
    "property2": true
  },
  "property2": {
    "property1": true,
    "property2": true
  }
}

对象检查结果，以对象 ID 为键。

属性​

名称类型必选约束中文名说明
additionalPropertiesPermissionActCheckMapfalsenone操作检查结果，以操作名称为键。

PermissionFileCheckResult

{
  "success": {
    "property1": {
      "property1": true,
      "property2": true
    },
    "property2": {
      "property1": true,
      "property2": true
    }
  },
  "fail": {
    "property1": {
      "property1": true,
      "property2": true
    },
    "property2": {
      "property1": true,
      "property2": true
    }
  }
}

属性​

名称类型必选约束中文名说明
successPermissionFileCheckObjectMaptruenone对象检查结果，以对象 ID 为键。
failPermissionFileCheckObjectMaptruenone对象检查结果，以对象 ID 为键。

PermissionFileCheckResponseData

true

属性​

oneOf

名称类型必选约束中文名说明
anonymousbooleanfalsenonenone

xor

名称类型必选约束中文名说明
anonymousPermissionFileCheckResultfalsenonenone

PermissionFileRightGroupCategory

{
  "id": 1,
  "name": "string",
  "count": 0
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
namestringtruenonenone
countintegerfalsenonenone

PermissionFileRightGroupItemInput

{
  "objId": 0,
  "objType": "store",
  "eft": "allow",
  "acts": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
objIdPermissionObjectIdentifiertruenonenone
objTypestringtruenonenone
eftstringtruenonenone
actsPermissionActionListtruenonenone

枚举值​

属性值
objTypestore
objTypefile
eftallow
eftdeny

PermissionFileRightGroupSummaryAuthorizedOrg

{
  "subId": 1,
  "subName": "string",
  "subType": "dept",
  "operator": 1,
  "operatorName": "string"
}

属性​

名称类型必选约束中文名说明
subIdintegertruenonenone
subNamestringtruenonenone
subTypestringtruenonenone
operatorintegertruenonenone
operatorNamestringtruenonenone

PermissionAuthorizedOrgDetail

{
  "groupId": 1,
  "subId": 1,
  "operator": 1,
  "subName": "string",
  "subPathName": "string",
  "operatorName": "string",
  "operatorPathName": "string"
}

属性​

名称类型必选约束中文名说明
groupIdintegertruenonenone
subIdintegertruenonenone
operatorintegertruenonenone
subNamestringtruenonenone
subPathNamestringtruenonenone
operatorNamestringtruenonenone
operatorPathNamestringtruenonenone

PermissionFileRightGroupSummaryItem

{
  "itemId": 1,
  "objId": 0,
  "objType": "store",
  "objName": "string",
  "eft": "allow",
  "acts": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
itemIdintegertruenonenone
objIdPermissionObjectIdentifiertruenonenone
objTypestringtruenonenone
objNamestringtruenone解析后的对象路径名称。
eftstringtruenonenone
actsPermissionActionListtruenonenone

枚举值​

属性值
objTypestore
objTypefile
eftallow
eftdeny

PermissionFileRightGroupDetailItem

{
  "id": 1,
  "groupId": 1,
  "objId": 0,
  "objType": "store",
  "eft": "allow",
  "objPathName": "string",
  "acts": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
groupIdintegertruenonenone
objIdPermissionObjectIdentifiertruenonenone
objTypestringtruenonenone
eftstringtruenonenone
objPathNamestringtruenonenone
actsPermissionActionListtruenonenone

枚举值​

属性值
objTypestore
objTypefile
eftallow
eftdeny

PermissionFileRightGroupSummary

{
  "id": 1,
  "name": "string",
  "authorizedOrgs": [
    {
      "subId": 1,
      "subName": "string",
      "subType": "dept",
      "operator": 1,
      "operatorName": "string"
    }
  ],
  "items": [
    {
      "itemId": 1,
      "objId": 0,
      "objType": "store",
      "objName": "string",
      "eft": "allow",
      "acts": [
        "string"
      ]
    }
  ]
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
namestringtruenonenone
authorizedOrgs[PermissionFileRightGroupSummaryAuthorizedOrg]falsenonenone
items[PermissionFileRightGroupSummaryItem]truenonenone

PermissionFileRightGroupDetail

{
  "id": 1,
  "name": "string",
  "categoryId": 1,
  "owner": 0,
  "items": [
    {
      "id": 1,
      "groupId": 1,
      "objId": 0,
      "objType": "store",
      "eft": "allow",
      "objPathName": "string",
      "acts": [
        "string"
      ]
    }
  ]
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
namestringtruenonenone
categoryIdintegertruenonenone
ownerintegertruenonenone
items[PermissionFileRightGroupDetailItem]truenonenone

PermissionFileRightGroupCreateInput

{
  "name": "string",
  "categoryId": 1,
  "owner": 0,
  "items": [
    {
      "objId": 0,
      "objType": "store",
      "eft": "allow",
      "acts": [
        "string"
      ]
    }
  ]
}

属性​

名称类型必选约束中文名说明
namestringtruenonenone
categoryIdintegertruenonenone
ownerintegertruenonenone
items[PermissionFileRightGroupItemInput]falsenonenone

PermissionFileRightGroupUpdateInput

{
  "id": 1,
  "name": "string",
  "categoryId": 1,
  "owner": 0,
  "items": [
    {
      "objId": 0,
      "objType": "store",
      "eft": "allow",
      "acts": [
        "string"
      ]
    }
  ]
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
namestringtruenonenone
categoryIdintegertruenonenone
ownerintegertruenonenone
items[PermissionFileRightGroupItemInput]falsenonenone

PermissionFileRightGroupAuthorizeInput

{
  "groupId": 1,
  "subId": 1
}

属性​

名称类型必选约束中文名说明
groupIdintegertruenonenone
subIdintegertruenonenone

PermissionActGroupResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": 1,
    "name": "string",
    "acts": [
      "string"
    ]
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataPermissionActGrouptruenonenone

PermissionActGroupListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "name": "string",
      "acts": [
        "string"
      ]
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[PermissionActGroup]truenonenone

PermissionBooleanMapResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "property1": true,
    "property2": true
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataPermissionBooleanMaptruenone布尔结果映射，以规则 ID、权限 ID 或操作名称为键。

PermissionFileRuleExistCheckListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "subId": 1,
      "objId": 0,
      "eft": "allow",
      "subName": "string",
      "IsExistSameName": true
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[PermissionFileRuleExistCheckItem]truenonenone

PermissionFileRuleListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "ruleId": 1,
      "subId": 1,
      "objId": 0,
      "eft": "allow",
      "acts": [
        "string"
      ]
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[PermissionFileRuleItem]truenonenone

PermissionFileRuleByFileListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "ruleId": 1,
      "subId": 1,
      "subName": "string",
      "subPathName": "string",
      "eft": "allow",
      "acts": [
        "string"
      ]
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[PermissionFileRuleByFileItem]truenonenone

PermissionPositionRightExistCheckListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "subId": 1,
      "objId": 1,
      "eft": "allow",
      "subName": "string",
      "objName": "string",
      "IsExistSameName": true
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[PermissionPositionRightExistCheckItem]truenonenone

PermissionPositionRightListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "rightId": 1,
      "subId": 1,
      "objId": 1,
      "eft": "allow",
      "acts": [
        "string"
      ]
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[PermissionPositionRightItem]truenonenone

PermissionPositionRightByOrgListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "rightId": 1,
      "objId": 1,
      "objName": "string",
      "objPathName": "string",
      "eft": "allow",
      "acts": [
        "string"
      ]
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[PermissionPositionRightByOrgItem]truenonenone

PermissionFileRightExistCheckListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "subId": 1,
      "objId": 0,
      "objType": "store",
      "eft": "allow",
      "IsExistSameName": true
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[PermissionFileRightExistCheckItem]truenonenone

PermissionFileRightListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "rightId": 1,
      "subId": 1,
      "objId": 0,
      "objType": "store",
      "storeId": 1,
      "objPathName": "string",
      "objName": "string",
      "eft": "allow",
      "acts": [
        "string"
      ]
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[PermissionFileRightItem]truenonenone

PermissionFileRightByOrgListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "rightId": 1,
      "objId": 0,
      "objType": "store",
      "storeId": 1,
      "objPathName": "string",
      "objName": "string",
      "eft": "allow",
      "acts": [
        "string"
      ]
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[PermissionFileRightByOrgItem]truenonenone

PermissionPreAuthorizationResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": true
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataPermissionPreAuthorizationResulttruenonenone

PermissionFileCheckResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": true
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataPermissionFileCheckResponseDatatruenonenone

PermissionFileRightGroupCategoryResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": 1,
    "name": "string",
    "count": 0
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataPermissionFileRightGroupCategorytruenonenone

PermissionFileRightGroupCategoryListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "name": "string",
      "count": 0
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[PermissionFileRightGroupCategory]truenonenone

PermissionFileRightGroupSummaryListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "name": "string",
      "authorizedOrgs": [
        {
          "subId": 1,
          "subName": "string",
          "subType": "dept",
          "operator": 1,
          "operatorName": "string"
        }
      ],
      "items": [
        {
          "itemId": 1,
          "objId": {},
          "objType": "store",
          "objName": "string",
          "eft": "allow",
          "acts": [
            "string"
          ]
        }
      ]
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[PermissionFileRightGroupSummary]truenonenone

PermissionFileRightGroupDetailResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": 1,
    "name": "string",
    "categoryId": 1,
    "owner": 0,
    "items": [
      {
        "id": 1,
        "groupId": 1,
        "objId": 0,
        "objType": "store",
        "eft": "allow",
        "objPathName": "string",
        "acts": [
          "string"
        ]
      }
    ]
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataPermissionFileRightGroupDetailtruenonenone

PermissionAuthorizedOrgDetailListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "groupId": 1,
      "subId": 1,
      "operator": 1,
      "subName": "string",
      "subPathName": "string",
      "operatorName": "string",
      "operatorPathName": "string"
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[PermissionAuthorizedOrgDetail]truenonenone

RecentTagBrief

{
  "id": 1,
  "name": "string",
  "color": "string"
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
namestringtruenonenone
colorstringtruenonenone

RecentFileItem

{
  "recentId": 1,
  "storeId": 1,
  "id": "string",
  "filePath": "string",
  "type": 0,
  "size": 0,
  "accessedBy": 1,
  "accessedTime": "string",
  "name": "string",
  "storeType": "private",
  "tags": [
    {
      "id": 1,
      "name": "string",
      "color": "string"
    }
  ],
  "isFavorite": true,
  "isLock": true
}

属性​

名称类型必选约束中文名说明
recentIdintegertruenonenone
storeIdintegertruenonenone
idstringtruenonenone
filePathstringtruenonenone
typeintegertruenonenone
sizeintegertruenonenone
accessedByintegertruenonenone
accessedTimestringtruenonenone
namestringtruenonenone
storeTypestringtruenonenone
tags[RecentTagBrief]truenonenone
isFavoritebooleantruenonenone
isLockbooleantruenonenone

枚举值​

属性值
storeTypeprivate
storeTypecooperative
storeTypepublic

RecentFileListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "recentId": 1,
      "storeId": 1,
      "id": "string",
      "filePath": "string",
      "type": 0,
      "size": 0,
      "accessedBy": 1,
      "accessedTime": "string",
      "name": "string",
      "storeType": "private",
      "tags": [
        {
          "id": 1,
          "name": "string",
          "color": "string"
        }
      ],
      "isFavorite": true,
      "isLock": true
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[RecentFileItem]truenonenone

RecycleFile

{
  "id": 1,
  "storeId": 1,
  "fileId": "string",
  "parentId": "string",
  "pathId": 0,
  "path": "string",
  "grade": 0,
  "name": "string",
  "type": 0,
  "size": 0,
  "storeType": "private",
  "filePath": "string",
  "createdBy": 1,
  "deletedBy": 1,
  "createdTime": 0,
  "deletedTime": 0,
  "clientId": "string",
  "cluster": "string",
  "offset": 0
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
storeIdintegertruenonenone
fileIdstringtruenonenone
parentIdstringtruenonenone
pathIdintegertruenonenone
pathstringtruenonenone
gradeintegertruenonenone
namestringtruenonenone
typeintegertruenonenone
sizeintegertruenonenone
storeTypestringtruenonenone
filePathstringtruenonenone
createdByintegertruenonenone
deletedByintegertruenonenone
createdTimeintegertruenonenone
deletedTimeintegertruenonenone
clientIdstringtruenonenone
clusterstringtruenonenone
offsetintegertruenonenone

枚举值​

属性值
storeTypeprivate
storeTypecooperative
storeTypepublic

RecycleFileListResult

{
  "total": 0,
  "pageSize": 1,
  "pageNumber": 1,
  "list": [
    {
      "id": 1,
      "storeId": 1,
      "fileId": "string",
      "parentId": "string",
      "pathId": 0,
      "path": "string",
      "grade": 0,
      "name": "string",
      "type": 0,
      "size": 0,
      "storeType": "private",
      "filePath": "string",
      "createdBy": 1,
      "deletedBy": 1,
      "createdTime": 0,
      "deletedTime": 0,
      "clientId": "string",
      "cluster": "string",
      "offset": 0
    }
  ]
}

属性​

名称类型必选约束中文名说明
totalintegertruenonenone
pageSizeintegertruenonenone
pageNumberintegertruenonenone
list[RecycleFile]truenonenone

RecycleFileResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": 1,
    "storeId": 1,
    "fileId": "string",
    "parentId": "string",
    "pathId": 0,
    "path": "string",
    "grade": 0,
    "name": "string",
    "type": 0,
    "size": 0,
    "storeType": "private",
    "filePath": "string",
    "createdBy": 1,
    "deletedBy": 1,
    "createdTime": 0,
    "deletedTime": 0,
    "clientId": "string",
    "cluster": "string",
    "offset": 0
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataRecycleFiletruenonenone

RecycleFileListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "total": 0,
    "pageSize": 1,
    "pageNumber": 1,
    "list": [
      {
        "id": 1,
        "storeId": 1,
        "fileId": "string",
        "parentId": "string",
        "pathId": 0,
        "path": "string",
        "grade": 0,
        "name": "string",
        "type": 0,
        "size": 0,
        "storeType": "private",
        "filePath": "string",
        "createdBy": 1,
        "deletedBy": 1,
        "createdTime": 0,
        "deletedTime": 0,
        "clientId": "string",
        "cluster": "string",
        "offset": 0
      }
    ]
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataRecycleFileListResulttruenonenone

RoleActionList

[
  "string"
]

属性​

None

RoleCreateInput

{
  "name": "string",
  "owner": 0,
  "level": "administrator",
  "type": "custom",
  "desc": "string",
  "actions": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
namestringtruenonenone
ownerintegertruenone0 表示公共根单位角色范围。
levelstringtruenonenone
typestringfalsenonenone
descstring¦nullfalsenonenone
actionsRoleActionListfalsenonenone

枚举值​

属性值
leveladministrator
levelmanager
levelmember

RoleUpdateInput

{
  "id": 1,
  "name": "string",
  "owner": 0,
  "level": "administrator",
  "type": "string",
  "desc": "string",
  "actions": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
namestringtruenonenone
ownerintegertruenonenone
levelstringtruenonenone
typestringtruenonenone
descstring¦nulltruenonenone
actionsRoleActionListfalsenonenone

枚举值​

属性值
leveladministrator
levelmanager
levelmember

RoleAssignInput

{
  "subId": 1,
  "roleId": 1,
  "objId": 0
}

属性​

名称类型必选约束中文名说明
subIdintegertruenonenone
roleIdintegertruenonenone
objIdintegertruenonenone

RoleUpdateAssignedInput

{
  "assigns": [
    {
      "subId": 1,
      "roleId": 1,
      "objId": 0
    }
  ],
  "revokes": [
    {
      "subId": 1,
      "roleId": 1,
      "objId": 0
    }
  ]
}

属性​

名称类型必选约束中文名说明
assigns[RoleAssignInput]truenonenone
revokes[RoleAssignInput]truenonenone

RoleSubjectInfo

{
  "id": 1,
  "name": "string",
  "type": "dept"
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
namestringtruenonenone
typestringtruenonenone

RoleAssignPair

{
  "subId": 1,
  "objId": 0
}

属性​

名称类型必选约束中文名说明
subIdintegertruenonenone
objIdintegertruenonenone

RoleAssignedScope

{
  "id": 0,
  "name": "string",
  "relPathName": "string"
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
namestringtruenonenone
relPathNamestringtruenonenone

RoleOrgRoleContext

{
  "subId": 1,
  "subName": "string",
  "subType": "dept",
  "subRelPathName": "string",
  "objInfos": [
    {
      "id": 0,
      "name": "string",
      "relPathName": "string"
    }
  ]
}

属性​

名称类型必选约束中文名说明
subIdintegertruenonenone
subNamestringtruenonenone
subTypestringtruenonenone
subRelPathNamestringtruenonenone
objInfos[RoleAssignedScope]truenonenone

RoleDetail

{
  "id": 1,
  "name": "string",
  "owner": 0,
  "level": "administrator",
  "type": "string",
  "limit": "public",
  "desc": "string",
  "creator": "string",
  "editor": "string",
  "ownername": "string",
  "actions": [
    "string"
  ],
  "assigns": [
    {
      "subId": 1,
      "objId": 0
    }
  ],
  "subInfos": [
    {
      "id": 1,
      "name": "string",
      "type": "dept"
    }
  ],
  "orgRoles": {
    "subId": 1,
    "subName": "string",
    "subType": "dept",
    "subRelPathName": "string",
    "objInfos": [
      {
        "id": 0,
        "name": "string",
        "relPathName": "string"
      }
    ]
  }
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
namestringtruenonenone
ownerintegertruenonenone
levelstringtruenonenone
typestringtruenonenone
limitstringfalsenonenone
descstring¦nullfalsenonenone
creatorstringfalsenonenone
editorstringfalsenonenone
ownernamestringfalsenonenone
actionsRoleActionListfalsenonenone
assigns[RoleAssignPair]falsenonenone
subInfos[RoleSubjectInfo]falsenonenone
orgRolesRoleOrgRoleContextfalsenonenone

枚举值​

属性值
leveladministrator
levelmanager
levelmember
limitpublic
limitprivate

RoleListItem

{
  "id": 1,
  "name": "string",
  "owner": 0,
  "level": "administrator",
  "type": "string",
  "desc": "string",
  "ownername": "string",
  "levelName": "string",
  "actions": [
    "string"
  ],
  "subInfos": [
    {
      "id": 1,
      "name": "string",
      "type": "dept"
    }
  ]
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
namestringtruenonenone
ownerintegertruenonenone
levelstringtruenonenone
typestringtruenonenone
descstring¦nullfalsenonenone
ownernamestringtruenonenone
levelNamestringtruenonenone
actionsRoleActionListtruenonenone
subInfos[RoleSubjectInfo]truenonenone

枚举值​

属性值
leveladministrator
levelmanager
levelmember

RoleIdNamePair

{
  "id": 1,
  "name": "string"
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
namestringtruenonenone

RoleAssumedItem

{
  "objId": 0,
  "objPathName": "string",
  "roleInfos": [
    {
      "id": 1,
      "name": "string"
    }
  ]
}

属性​

名称类型必选约束中文名说明
objIdintegertruenonenone
objPathNamestringtruenonenone
roleInfos[RoleIdNamePair]truenonenone

RoleManagerListItem

{
  "managerId": 1,
  "managerName": "string",
  "managerRelPathName": "string",
  "roleInfos": [
    {
      "id": 1,
      "name": "string"
    }
  ]
}

属性​

名称类型必选约束中文名说明
managerIdintegertruenonenone
managerNamestringtruenonenone
managerRelPathNamestringtruenonenone
roleInfos[RoleIdNamePair]truenonenone

RoleAssignmentGroupItem

{
  "subId": 1,
  "subName": "string",
  "subType": "string",
  "objInfos": [
    {
      "id": 0,
      "name": "string",
      "relPathName": "string"
    }
  ]
}

属性​

名称类型必选约束中文名说明
subIdintegertruenonenone
subNamestringtruenonenone
subTypestringfalsenonenone
objInfos[RoleAssignedScope]truenonenone

RoleVisibleRoleInfo

{
  "name": "string",
  "level": "administrator"
}

属性​

名称类型必选约束中文名说明
namestringtruenonenone
levelstringtruenonenone

枚举值​

属性值
leveladministrator
levelmanager
levelmember

RoleVisibleRoleMap

{
  "property1": {
    "name": "string",
    "level": "administrator"
  },
  "property2": {
    "name": "string",
    "level": "administrator"
  }
}

可见角色映射，以角色 ID 为键。

属性​

名称类型必选约束中文名说明
additionalPropertiesRoleVisibleRoleInfofalsenonenone

RoleDetailResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": 1,
    "name": "string",
    "owner": 0,
    "level": "administrator",
    "type": "string",
    "limit": "public",
    "desc": "string",
    "creator": "string",
    "editor": "string",
    "ownername": "string",
    "actions": [
      "string"
    ],
    "assigns": [
      {
        "subId": 1,
        "objId": 0
      }
    ],
    "subInfos": [
      {
        "id": 1,
        "name": "string",
        "type": "dept"
      }
    ],
    "orgRoles": {
      "subId": 1,
      "subName": "string",
      "subType": "dept",
      "subRelPathName": "string",
      "objInfos": [
        {
          "id": 0,
          "name": "string",
          "relPathName": "string"
        }
      ]
    }
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataRoleDetailtruenonenone

RoleListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "name": "string",
      "owner": 0,
      "level": "administrator",
      "type": "string",
      "desc": "string",
      "ownername": "string",
      "levelName": "string",
      "actions": [
        "string"
      ],
      "subInfos": [
        {
          "id": 1,
          "name": "string",
          "type": "dept"
        }
      ]
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[RoleListItem]truenonenone

RoleAssumedListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "objId": 0,
      "objPathName": "string",
      "roleInfos": [
        {
          "id": 1,
          "name": "string"
        }
      ]
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[RoleAssumedItem]truenonenone

RoleManagerListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "managerId": 1,
      "managerName": "string",
      "managerRelPathName": "string",
      "roleInfos": [
        {
          "id": 1,
          "name": "string"
        }
      ]
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[RoleManagerListItem]truenonenone

RoleAssignmentGroupListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "subId": 1,
      "subName": "string",
      "subType": "string",
      "objInfos": [
        {
          "id": 0,
          "name": "string",
          "relPathName": "string"
        }
      ]
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[RoleAssignmentGroupItem]truenonenone

RoleVisibleMapResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "property1": {
      "name": "string",
      "level": "administrator"
    },
    "property2": {
      "name": "string",
      "level": "administrator"
    }
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataRoleVisibleRoleMaptruenone可见角色映射，以角色 ID 为键。

GenericObject

{}

属性​

None

GenericObjectList

[
  {}
]

属性​

名称类型必选约束中文名说明
anonymous[GenericObject]falsenonenone

StringList

[
  "string"
]

属性​

None

IntegerList

[
  0
]

属性​

None

GenericListResult

{
  "total": 0,
  "pageSize": 0,
  "pageNumber": 0,
  "list": [
    {}
  ]
}

属性​

名称类型必选约束中文名说明
totalintegerfalsenonenone
pageSizeintegerfalsenonenone
pageNumberintegerfalsenonenone
listGenericObjectListfalsenonenone

ObjectResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {}
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataGenericObjecttruenonenone

ObjectListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {}
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataGenericObjectListtruenonenone

BooleanResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": true
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
databooleantruenonenone

StringListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataStringListtruenonenone

IntegerListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    0
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataIntegerListtruenonenone

GenericListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "total": 0,
    "pageSize": 0,
    "pageNumber": 0,
    "list": [
      {}
    ]
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataGenericListResulttruenonenone

CursorFileIdResult

{
  "ids": [
    "string"
  ],
  "cursor": "string"
}

属性​

名称类型必选约束中文名说明
idsStringListfalsenonenone
cursorstring¦nullfalsenonenone

CursorFileIdResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "ids": [
      "string"
    ],
    "cursor": "string"
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataCursorFileIdResulttruenonenone

StoreFileLifecycle

{
  "policy": "cycle",
  "clearCycle": "0 0 * * *",
  "keepGrade": 0
}

属性​

名称类型必选约束中文名说明
policystringtruenonenone
clearCyclestringfalsenonenone
keepGradeintegerfalsenonenone

StoreCreateInput

{
  "name": "string",
  "type": "private",
  "owner": 1,
  "manager": 1,
  "quota": 0,
  "fileLifecycle": {
    "policy": "cycle",
    "clearCycle": "0 0 * * *",
    "keepGrade": 0
  }
}

属性​

名称类型必选约束中文名说明
namestringtruenonenone
typestringtruenonenone
ownerintegertruenone私有仓库忽略此值，将替换为当前用户。
managerintegertruenone私有仓库忽略此值，将替换为当前用户。
quotaintegerfalsenonenone
fileLifecycleStoreFileLifecyclefalsenonenone

枚举值​

属性值
typeprivate
typecooperative
typepublic

StoreUpdateInput

{
  "name": "string",
  "type": "private",
  "owner": 1,
  "manager": 1,
  "quota": 0,
  "fileLifecycle": {
    "policy": "cycle",
    "clearCycle": "0 0 * * *",
    "keepGrade": 0
  }
}

属性​

名称类型必选约束中文名说明
namestringtruenonenone
typestringtruenonenone
ownerintegertruenone私有仓库忽略此值，将替换为当前用户。
managerintegertruenone私有仓库忽略此值，将替换为当前用户。
quotaintegerfalsenonenone
fileLifecycleStoreFileLifecyclefalsenonenone

枚举值​

属性值
typeprivate
typecooperative
typepublic

StoreInfo

{
  "id": 1,
  "name": "string",
  "type": "private",
  "size": 0,
  "used": 0,
  "fileNum": 0,
  "dirNum": 0,
  "owner": 1,
  "manager": 1,
  "createdBy": 1,
  "modifiedBy": 1,
  "createdTime": 0,
  "modifiedTime": 0,
  "fileLifecycle": {
    "policy": "cycle",
    "clearCycle": "0 0 * * *",
    "keepGrade": 0
  },
  "isFavorite": true
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
namestringtruenonenone
typestringtruenonenone
sizeintegertruenonenone
usedintegertruenonenone
fileNumintegertruenonenone
dirNumintegertruenonenone
ownerintegertruenonenone
managerintegertruenonenone
createdByintegertruenonenone
modifiedByintegertruenonenone
createdTimeintegertruenonenone
modifiedTimeintegertruenonenone
fileLifecycleStoreFileLifecyclefalsenonenone
isFavoritebooleanfalsenonenone

枚举值​

属性值
typeprivate
typecooperative
typepublic

StoreSummary

{
  "name": "string",
  "type": "private",
  "size": 0,
  "manager": "string",
  "managerId": 1,
  "createdBy": "string",
  "createdTime": 0,
  "path": "string",
  "manageable": true,
  "fileLifecycle": {
    "policy": "cycle",
    "clearCycle": "0 0 * * *",
    "keepGrade": 0
  },
  "ownerPathname": "string"
}

属性​

名称类型必选约束中文名说明
namestringtruenonenone
typestringtruenonenone
sizeintegertruenonenone
managerstringtruenonenone
managerIdintegertruenonenone
createdBystringtruenonenone
createdTimeintegertruenonenone
pathstringtruenonenone
manageablebooleantruenonenone
fileLifecycleStoreFileLifecyclefalsenonenone
ownerPathnamestringfalsenonenone

枚举值​

属性值
typeprivate
typecooperative
typepublic

StoreDetail

{
  "dirCount": 0,
  "fileCount": 0,
  "used": 0,
  "editedBy": "string",
  "editedTime": 0,
  "rights": [
    "string"
  ]
}

属性​

名称类型必选约束中文名说明
dirCountintegertruenonenone
fileCountintegertruenonenone
usedintegertruenonenone
editedBystringtruenonenone
editedTimeintegertruenonenone
rightsUserRightListtruenonenone

StoreInfoResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "id": 1,
    "name": "string",
    "type": "private",
    "size": 0,
    "used": 0,
    "fileNum": 0,
    "dirNum": 0,
    "owner": 1,
    "manager": 1,
    "createdBy": 1,
    "modifiedBy": 1,
    "createdTime": 0,
    "modifiedTime": 0,
    "fileLifecycle": {
      "policy": "cycle",
      "clearCycle": "0 0 * * *",
      "keepGrade": 0
    },
    "isFavorite": true
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataStoreInfotruenonenone

StoreListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "name": "string",
      "type": "private",
      "size": 0,
      "used": 0,
      "fileNum": 0,
      "dirNum": 0,
      "owner": 1,
      "manager": 1,
      "createdBy": 1,
      "modifiedBy": 1,
      "createdTime": 0,
      "modifiedTime": 0,
      "fileLifecycle": {
        "policy": "cycle",
        "clearCycle": "0 0 * * *",
        "keepGrade": 0
      },
      "isFavorite": true
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[StoreInfo]truenonenone

StoreSummaryResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "name": "string",
    "type": "private",
    "size": 0,
    "manager": "string",
    "managerId": 1,
    "createdBy": "string",
    "createdTime": 0,
    "path": "string",
    "manageable": true,
    "fileLifecycle": {
      "policy": "cycle",
      "clearCycle": "0 0 * * *",
      "keepGrade": 0
    },
    "ownerPathname": "string"
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataStoreSummarytruenonenone

StoreDetailResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "dirCount": 0,
    "fileCount": 0,
    "used": 0,
    "editedBy": "string",
    "editedTime": 0,
    "rights": [
      "string"
    ]
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataStoreDetailtruenonenone

SystemVolumeValue

0

属性​

oneOf

名称类型必选约束中文名说明
anonymousintegerfalsenonenone

xor

名称类型必选约束中文名说明
anonymousnumberfalsenonenone

xor

名称类型必选约束中文名说明
anonymousstringfalsenonenone

SystemVolumeDiskStatus

{
  "all": 0,
  "free": 0,
  "used": 0,
  "percent_used": 0
}

属性​

名称类型必选约束中文名说明
allSystemVolumeValuefalsenonenone
freeSystemVolumeValuefalsenonenone
usedSystemVolumeValuefalsenonenone
percent_usedSystemVolumeValuefalsenonenone

SystemVolumeNodeStatusPayload

{
  "DiskStatuses": {
    "property1": {
      "all": 0,
      "free": 0,
      "used": 0,
      "percent_used": 0
    },
    "property2": {
      "all": 0,
      "free": 0,
      "used": 0,
      "percent_used": 0
    }
  }
}

代理的存储节点状态数据。消费者当前读取 DiskStatuses 及其 all/free/used/percent_used 值。

属性​

名称类型必选约束中文名说明
DiskStatusesobjectfalsenonenone
» additionalPropertiesSystemVolumeDiskStatusfalsenonenone

SystemVolumeNodesPayload

{
  "Volumes": {}
}

代理的主卷状态数据。消费者当前将 Volumes.DataCenters.DefaultDataCenter.DefaultRack 作为节点映射遍历。

属性​

名称类型必选约束中文名说明
Volumesobjectfalsenonenone

SystemVolumeNodesResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "Volumes": {}
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataSystemVolumeNodesPayloadtruenone代理的主卷状态数据。消费者当前将 Volumes.DataCenters.DefaultDataCenter.DefaultRack 作为节点映射遍历。

SystemVolumeNodeStatusResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": {
    "DiskStatuses": {
      "property1": {
        "all": 0,
        "free": 0,
        "used": 0,
        "percent_used": 0
      },
      "property2": {
        "all": 0,
        "free": 0,
        "used": 0,
        "percent_used": 0
      }
    }
  }
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
dataSystemVolumeNodeStatusPayloadtruenone代理的存储节点状态数据。消费者当前读取 DiskStatuses 及其 all/free/used/percent_used 值。

TagCreateInput

{
  "name": "string",
  "color": "string"
}

属性​

名称类型必选约束中文名说明
namestringtruenonenone
colorstringfalsenone可选的标签颜色值，由后端接受。

TagUpdateInput

{
  "id": 1,
  "name": "string",
  "color": "string"
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
namestringtruenonenone
colorstringfalsenone可选的标签颜色值，由后端接受。

TagItem

{
  "id": 1,
  "name": "string",
  "color": "string",
  "createdBy": 1,
  "createdTime": "string",
  "creator": "string",
  "usedTime": "string"
}

属性​

名称类型必选约束中文名说明
idintegertruenonenone
namestringtruenonenone
colorstringtruenonenone
createdByintegertruenonenone
createdTimestringtruenonenone
creatorstringtruenonenone
usedTimestringfalsenonenone

TagListResponseEnvelope

{
  "code": "OK",
  "message": "OK",
  "data": [
    {
      "id": 1,
      "name": "string",
      "color": "string",
      "createdBy": 1,
      "createdTime": "string",
      "creator": "string",
      "usedTime": "string"
    }
  ]
}

属性​

名称类型必选约束中文名说明
codestringtruenonenone
messagestringtruenonenone
data[TagItem]truenonenone