菜单

65.嵌入式目录类

下载

嵌入式目录类

上传一个文件

  • 接口描述: 上传实体附件
  • URL地址：/wapi/v1/embedded_directories/upload_file/{objectId}/object_id/{parentFolderId}/parent_folder_id
  • 访问方法:POST
  • 错误代码：UPLOAD_FILE_OUT_OF_LINE(5120, "上传文件不符合规范") UPLOAD_FILE_FAILED(5024, "上传文件出错"),
  • 请求参数：
参数名 类型 示例值 必填 说明
file MultipartFile Something.doc, Explample.pdf 是 来自用户计算机的文件

Path参数：

参数名 类型 示例值 必填 说明
objectId Long 25000000000023，24000000000032 是 实体id
parentFolderId Long 22000000000034 是 父目录id
  • 响应示例：

{

"code": 201,

"message": "created",

"data": {

"id": 40000000000291,

"masterObjectId": 24000000044493,

"fileName": "NVISUAL用户目录系统——数据库结构.docx",

"lockedBy": null,

"deleteMaker": 0,

"creat_date": "2023-03-03T03:22:55.000+0000",

"size": 145561.0,

"dateModified": "2023-03-03T03:22:55.000+0000",

"parentFolderId": 22000000000011

}

}

获取目录

  • 接口描述: 获取目录

  • URL地址：/wapi/v1/embedded_directories/get_directory

  • 访问方法:GET

  • 错误代码：

  • 请求参数：

    Path参数：

参数名 类型 示例值 必填 说明
objectId Long 25000000000023，24000000000032 是 实体id
parentFolderId Long 22000000000034 是 父目录id
  • 响应示例：

{

"code": 200,

"message": "success",

"data": [

{

"fileId": 40000000000281,

"dateModified": "2023-03-01T08:16:42.000+0000",

"name": "NVISUAL用户目录系统——数据库结构 230301.docx",

"isDirectory": false,

"size": 146293.0,

"masterObjectId": 24000000051616,

"parentFolderId": -1

},

{

"folderId": 22000000000014,

"dateModified": "2023-03-03T03:54:22.000+0000",

"name": "testFolder",

"isDirectory": true,

"masterObjectId": 24000000051616,

"parentFolderId": -1

}

]

}

创建一个嵌入式文件夹

  • 接口描述: 创建一个嵌入式文件夹

  • URL地址：/wapi/v1/embedded_directories/create_folder

  • 访问方法:POST

  • 错误代码： FOLDER_NAME_ALREADY_EXISTS(5127, "文件夹名称已存在"), ENTITY_NOT_FOUND(1001, "未找到实体"), ERROR_CREATING_FOLDER(5129, "创建嵌入式文件夹时出错"),

  • 请求参数：

    Body参数：

参数名 类型 示例值 必填 说明
objectId Long 25000000000023，24000000000032 是 实体id
parentFolderId Long 22000000000034 是 父目录id
folderName String 目录名字 是 目录名字
  • 响应示例：

{

"code": 200,

"message": "success",

"data": {

"id": 22000000000014,

"masterObjectId": 24000000051616,

"folderName": "testFolder",

"lockedBy": null,

"dateModified": "2023-03-03T03:54:22.000+0000",

"parentFolderId": -1

}

}

删除文件

  • 接口描述: 删除文件
  • URL地址：/wapi/v1/embedded_directories/remove_file
  • 访问方法: DELETE
  • 错误代码： ENTITY_NOT_FOUND(1001, "未找到实体"), ERROR(5098, "发生错误")
  • 请求参数：
参数名 类型 示例值 必填 说明
fileId Long 40000000347263 是 文件id
  • 响应示例：

{

"code": 200,

"message": "success",

"data": {

"id": 40000000000290,

"masterObjectId": 24000000044493,

"fileName": "单例设计模式-Daniel.docx",

"lockedBy": null,

"deleteMaker": 0,

"creat_date": "2023-03-03T03:18:15.000+0000",

"size": 157733.0,

"dateModified": "2023-03-03T03:18:15.000+0000",

"parentFolderId": 22000000000010

}

}

删除文件夹

  • 接口描述: 删除文件夹
  • URL地址：/wapi/v1/embedded_directories/remove_folder
  • 访问方法: DELETE
  • 错误代码： ENTITY_NOT_FOUND(1001, "未找到实体"), CANT_DELETE_TOP_FOLDER(5130, "无法删除顶级文件夹（id 为 -1 的 embedded_folder）")
  • 请求参数：
参数名 类型 示例值 必填 说明
folderId Long 22000000347263 是 文件夹id

Path参数：

  • 响应示例：

{

"code": 200,

"message": "deleted",

"data": {

"id": 22000000000011,

"masterObjectId": 24000000044493,

"folderName": "testFolder",

"lockedBy": null,

"dateModified": "2023-03-03T03:21:11.000+0000",

"parentFolderId": 22000000000005

}

}

修改文件夹名称

  • 接口描述: 删除文件夹
  • URL地址：/wapi/v1/embedded_directories/folder_name
  • 访问方法: PUT
  • 错误代码： CANT_EDIT_TOP_FOLDER(5131,"无法编辑顶级文件夹名称 -1"), ENTITY_NOT_FOUND(1001, "未找到实体"), FOLDER_NAME_ALREADY_EXISTS(5127, "文件夹名称已存在")
  • 请求参数：
参数名 类型 示例值 必填 说明
folderId Long 22000000347263 是 文件夹id
folderName String “example name” 是 新的名字

Path参数：

  • 响应示例：

{

"code": 200,

"message": "deleted",

"data": {

"id": 22000000000011,

"masterObjectId": 24000000044493,

"folderName": "testFolder",

"lockedBy": null,

"dateModified": "2023-03-03T03:21:11.000+0000",

"parentFolderId": 22000000000005

}

}

最近修改: 2025-02-28