简要描述:

  • 新增接口使用post请求,调用新增接口前先调用详情接口,初始化数据,然后修改数据进行提交保存
  • 新增数据可以按需填写字段,其它默认数据如果没有传递,将按{mkey}文件里面配置的值,然后进行入库。
  • 详情接口,把主键值设置为0, 如depId=0

    接口版本:

版本号 制定人 制定日期 修订日期
v3 陈碧贵 2019-01-20 xxxx-xx-xx

请求URL:

  • http://{url参数}/bo/api/v3/{mkey}/res/{resField}?nodejs=common-data&nodeq=

  • http://localhost:58582/bo/api/v3/bo-dep /res/manager_detail?nodejs=common-data&nodeq=

  • {mkey} 对应mapper文件

  • {resField} 对应 {mkey}里面 responseField键

请求方式:

  • POST

请求地址参数:

参数名 是否必须 类型 说明
_pidsuffix string 主键编号前缀,配合雪花ID使用,如DEP”

请求头:

参数名 是否必须 类型 说明
XownerId string 项目唯一ID,对应bo_project {ownerId}
XtenantId string 所属租户 对应 owner_bo_tenant 里面 ti_tenant_info 表
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

请求参数:

{

        depName: "测试新增",
        depNameMeta: {
          component: "el-input",
          alias: "dep_name",
          field: "depName",
        },
        batO: "U",
        areaCode: { value: "350100", name: "福州市", batO: "i" },
        depId: "0",
 }

参数名 是否必须 类型 说明
depId string 主键唯一标识值 (名称根据实际进行调整)
_nodejs string common-data 对应/Config/AppNodeJs/Plugins/fn- common-data.js, 通过nodejs插件,对响应结果进行二次处理 common-data 普通数据(小写驼峰)common-data-under 普通数据下划线
_queues string 主键唯一标识值 (名称根据实际进行调整) {ownerId}

返回示例:

正确时返回:

{
        data: { depId: "rg-deve-rg-20200-1134279c-14ae-4b47" },
        code: 0,
        success: true,
        message: "新增:总数1条,成功1条,失败0条。",
 }

错误时返回:

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

返回参数说明:

参数名 类型 说明
success bool true 表示数据请求成功(跟code=0一致),调用者优先使用
code int true 表示数据请求成功(跟code=0一致),调用者优先使用
data object 响应的结果数据 name:显示的名称 value:交互的数据库中值 id:通常和value一致,树形结构需要 parentId: 父节点,树形结构需要level:等级,树形结构需要
cacheType string redis/sqlite/local 数据来源缓存 的类型(便于开发调试和性能优化)
cacheDate date 最后数据获取时间
文档更新时间: 2023-12-11 08:10   作者:admin