简要描述:

  • 项目文件和目录结构获取

接口版本:

版本号 制定人 制定日期 修订日期
v3 陈碧贵 2023-12-13 xxxx-xx-xx

请求URL:

请求方式:

  • POST

请求头:

参数名 是否必须 类型 说明
XownerId string 项目唯一ID,对应bo_project {ownerId}
XsysId string 所属系统 对应 bo_system 表
XuserFromFirstShareId string 一级分享用户ID, bo_user user_id
XuserFromSecondShareId string 二级分享用户ID, bo_user user_id
XverifyApi string 加密规则encryptByDES(`${newGuid()}
XfilterAreaCode string 行政区编码, 对应 bo_sys_area area_code
Content-Type: string application/json; charset=utf-8 请求类型
Authorization string 当前用户认证信息,通过登录接口获取 Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6

请求参数:

{
    "fullName":"~/App_Data""dirKeyword":"目录路径关键字,多个,隔开",
    "filePattern":"文件路径关键字,如  *.jpg",
    "fileKeyword":"文件内容,尽量不用"
}
参数名 是否必须 类型 说明
_nodejs string common-data 对应/Config/AppNodeJs/Plugins/fn- common-data.js, 通过nodejs插件,对响应结果进行二次处理 common-data 普通数据(小写驼峰)common-data-under 普通数据下划线
data参数 是否必须 类型 说明
{} object fullName 获取文件的根路径, 会受权限控制

返回示例:

正确时返回:

{
    "data": [
        {
            "fullName": "~/App_Data/wechat.txt",
            "batO": 0,
            "name": "wechat.txt",
            "suffix": "txt",
            "size": 4655,
            "sizeKb": 4,
            "modifyDate": "2023-09-08T06:11:00",
            "isFile": true
        },
        {
            "children": [
                {
                    "children": [
                        {
                            "fullName": "~/App_Data/ApiDocument/bt/connbasis.json",
                            "batO": 0,
                            "name": "connbasis.json",
                            "suffix": "json",
                            "size": 5794,
                            "sizeKb": 5,
                            "sizeMb": 0.01,
                            "modifyDate": "2023-09-08T06:10:58",
                            "isFile": true
                        }
                    ],
                    "fullName": "~/App_Data/ApiDocument/bt",
                    "batO": 0,
                    "name": "bt",
                    "modifyDate": "2023-10-04T11:45:26",
                    "isFile": false
                }
            ],
            "fullName": "~/App_Data/ApiDocument",
            "batO": 0,
            "name": "ApiDocument",
            "modifyDate": "2023-10-04T11:45:29",
            "isFile": false
        }
    ],
    "currentDay": "2023-12-03",
    "cacheDateTimestamp": 0,
    "code": "0",
    "retCode": "0",
    "success": true
}

错误时返回:

{
    "code": 0,
    "message": ""
    "error":{
      errorCode:null,
      errorText:null
    }
    "success": false,
}

返回参数说明:

参数名 类型 说明
success bool true 表示数据请求成功(跟code=0一致),调用者优先使用
code int true 表示数据请求成功(跟code=0一致),调用者优先使用
data [] isFile=true 表示文件, fullName 表示路径
cacheType string redis/sqlite/local 数据来源缓存 的类型(便于开发调试和性能优化)
cacheDate date 最后数据获取时间
文档更新时间: 2023-12-03 15:25   作者:admin