作者：管理员  历史版本：1  最后编辑：龚清  更新时间：2024-11-20 15:41

导出数据字典XML

简述：

  • 导出数据字典XML

请求URL：

请求方式：

  • GET

请求参数：

  • Headers：
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 是 系统令牌
  • Query：
名称 类型 是否必须 默认值 备注 其他信息
dictionaryId String 是 数据字典 id
isRoot String 是 false 是否根节点
  • Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/cat/dictionary/exportXml?dictionaryId=389826701045006417&isRoot=false

返回示例：

对应的xml文件

返回参数说明：

名称 类型 备注
data Void

根据分类key获取数据字典

简述：

  • 根据分类key获取数据字典

请求URL：

请求方式：

  • GET

请求参数：

  • Headers：
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 是 系统令牌
  • Query：
名称 类型 是否必须 默认值 备注 其他信息
typeKey String 是 分类key
  • Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/cat/dictionary/findByTypeKey?typeKey=fieldControl

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": [
        {
            "pk": "",
            "name": "单行文本",
            "ip": null,
            "createBy": null,
            "createTime": null,
            "updateBy": null,
            "updateTime": null,
            "tenantId": "-999",
            "dataStatus": null,
            "dbtype": null,
            "id": "389826701045006408",
            "typeId": "286814138233389374",
            "key": "text",
            "parentId": "286814138233389374",
            "sn": 1,
            "typeKey": null
        },
        {
            "pk": "",
            "name": "隐藏域",
            "ip": null,
            "createBy": null,
            "createTime": null,
            "updateBy": null,
            "updateTime": null,
            "tenantId": "-999",
            "dataStatus": null,
            "dbtype": null,
            "id": "389826701045006415",
            "typeId": "286814138233389374",
            "key": "hidden",
            "parentId": "286814138233389374",
            "sn": 1,
            "typeKey": null
        },
        {
            "pk": "",
            "name": "多行文本",
            "ip": null,
            "createBy": null,
            "createTime": null,
            "updateBy": null,
            "updateTime": null,
            "tenantId": "-999",
            "dataStatus": null,
            "dbtype": null,
            "id": "389826701045006409",
            "typeId": "286814138233389374",
            "key": "textarea",
            "parentId": "286814138233389374",
            "sn": 2,
            "typeKey": null
        },
        {
            "pk": "",
            "name": "富文本框",
            "ip": null,
            "createBy": null,
            "createTime": null,
            "updateBy": null,
            "updateTime": null,
            "tenantId": "-999",
            "dataStatus": null,
            "dbtype": null,
            "id": "389826701045006410",
            "typeId": "286814138233389374",
            "key": "editor",
            "parentId": "286814138233389374",
            "sn": 3,
            "typeKey": null
        },
        {
            "pk": "",
            "name": "数字",
            "ip": null,
            "createBy": null,
            "createTime": null,
            "updateBy": null,
            "updateTime": null,
            "tenantId": "-999",
            "dataStatus": null,
            "dbtype": null,
            "id": "389826701045006411",
            "typeId": "286814138233389374",
            "key": "number",
            "parentId": "286814138233389374",
            "sn": 4,
            "typeKey": null
        },
        {
            "pk": "",
            "name": "单项选择",
            "ip": null,
            "createBy": null,
            "createTime": null,
            "updateBy": null,
            "updateTime": null,
            "tenantId": "-999",
            "dataStatus": null,
            "dbtype": null,
            "id": "389826701045006412",
            "typeId": "286814138233389374",
            "key": "radio",
            "parentId": "286814138233389374",
            "sn": 5,
            "typeKey": null
        },
        {
            "pk": "",
            "name": "多项选择",
            "ip": null,
            "createBy": null,
            "createTime": null,
            "updateBy": null,
            "updateTime": null,
            "tenantId": "-999",
            "dataStatus": null,
            "dbtype": null,
            "id": "389826701045006413",
            "typeId": "286814138233389374",
            "key": "checkbox",
            "parentId": "286814138233389374",
            "sn": 6,
            "typeKey": null
        },
        {
            "pk": "",
            "name": "下拉框",
            "ip": null,
            "createBy": null,
            "createTime": null,
            "updateBy": null,
            "updateTime": null,
            "tenantId": "-999",
            "dataStatus": null,
            "dbtype": null,
            "id": "389826701045006414",
            "typeId": "286814138233389374",
            "key": "select",
            "parentId": "286814138233389374",
            "sn": 7,
            "typeKey": null
        },
        {
            "pk": "",
            "name": "数据字典",
            "ip": null,
            "createBy": null,
            "createTime": null,
            "updateBy": null,
            "updateTime": null,
            "tenantId": "-999",
            "dataStatus": null,
            "dbtype": null,
            "id": "389826701045006416",
            "typeId": "286814138233389374",
            "key": "dictionary",
            "parentId": "286814138233389374",
            "sn": 8,
            "typeKey": null
        },
        {
            "pk": "",
            "name": "日期控件",
            "ip": null,
            "createBy": null,
            "createTime": null,
            "updateBy": null,
            "updateTime": null,
            "tenantId": "-999",
            "dataStatus": null,
            "dbtype": null,
            "id": "389826701045006417",
            "typeId": "286814138233389374",
            "key": "datePicker",
            "parentId": "286814138233389374",
            "sn": 9,
            "typeKey": null
        },
        {
            "pk": "",
            "name": "自动编号",
            "ip": null,
            "createBy": null,
            "createTime": null,
            "updateBy": null,
            "updateTime": null,
            "tenantId": "-999",
            "dataStatus": null,
            "dbtype": null,
            "id": "389826701045006418",
            "typeId": "286814138233389374",
            "key": "autoNumber",
            "parentId": "286814138233389374",
            "sn": 10,
            "typeKey": null
        },
        {
            "pk": "",
            "name": "上传附件",
            "ip": null,
            "createBy": null,
            "createTime": null,
            "updateBy": null,
            "updateTime": null,
            "tenantId": "-999",
            "dataStatus": null,
            "dbtype": null,
            "id": "389826701045006419",
            "typeId": "286814138233389374",
            "key": "attachment",
            "parentId": "286814138233389374",
            "sn": 11,
            "typeKey": null
        },
        {
            "pk": "",
            "name": "选择器",
            "ip": null,
            "createBy": null,
            "createTime": null,
            "updateBy": null,
            "updateTime": null,
            "tenantId": "-999",
            "dataStatus": null,
            "dbtype": null,
            "id": "389826701045006421",
            "typeId": "286814138233389374",
            "key": "selector",
            "parentId": "286814138233389374",
            "sn": 12,
            "typeKey": null
        },
        {
            "pk": "",
            "name": "自定义对话框",
            "ip": null,
            "createBy": null,
            "createTime": null,
            "updateBy": null,
            "updateTime": null,
            "tenantId": "-999",
            "dataStatus": null,
            "dbtype": null,
            "id": "389826701045006422",
            "typeId": "286814138233389374",
            "key": "customDialog",
            "parentId": "286814138233389374",
            "sn": 13,
            "typeKey": null
        }
    ]
}

返回参数说明：

名称 类型 备注
data List< DictionaryPo > 数据字典对象信息列表

查询数据字典信息

简述：

  • 根据传入id查询，返回数据字典信息

请求URL：

请求方式：

  • GET

请求参数：

  • Headers：
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 是 系统令牌
  • Query：
名称 类型 是否必须 默认值 备注 其他信息
dictionaryId String 是 数据字典 id
  • Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/cat/dictionary/get?dictionaryId=321669659306754048

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "pk": "",
        "name": "业务对象",
        "ip": null,
        "createBy": null,
        "createTime": null,
        "updateBy": null,
        "updateTime": null,
        "tenantId": "-999",
        "dataStatus": null,
        "dbtype": null,
        "id": "321669659306754048",
        "typeId": "286814138233389395",
        "key": "bo",
        "parentId": "286814138233389395",
        "sn": 2,
        "typeKey": null
    }
}

返回参数说明：

名称 类型 备注
data DictionaryVo 数据字典对象信息

查询数据字典信息并设置基本信息

简述：

  • 根据传递的数据字典ID查询，并根据数据字典,父节点，父节点名，类型id设置基本信息

请求URL：

请求方式：

  • GET

请求参数：

  • Headers：
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 是 系统令牌
  • Query：
名称 类型 是否必须 默认值 备注 其他信息
dictionaryId String 是 数据字典 id
typeId String 是 分类 id
  • Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/cat/dictionary/getByTypeId?dictionaryId=321669659306754048&typeId=286814138233389395

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "pk": "",
        "name": "业务对象",
        "ip": null,
        "createBy": null,
        "createTime": null,
        "updateBy": null,
        "updateTime": null,
        "tenantId": "-999",
        "dataStatus": null,
        "dbtype": null,
        "id": "321669659306754048",
        "typeId": "286814138233389395",
        "key": "bo",
        "parentId": "286814138233389395",
        "sn": 2,
        "typeKey": null,
        "struType": null,
        "parentName": "表来源",
        "level": -1,
        "leaf": true,
        "expanded": true,
        "loaded": true
    }
}

返回参数说明：

名称 类型 备注
data DictionaryVo 数据字典对象信息

获取数据字典

简述：

  • 根据数据字典key、分类key获取数据字典

请求URL：

请求方式：

  • GET

请求参数：

  • Headers：
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 是 系统令牌
  • Query：
名称 类型 是否必须 默认值 备注 其他信息
key String 是 数据字典key
typeKey String 是 分类key
  • Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/cat/dictionary/getByTypeKey?key=dialog&typeKey=subTemplate

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "pk": "",
        "name": "弹窗模式",
        "ip": null,
        "createBy": null,
        "createTime": null,
        "updateBy": null,
        "updateTime": null,
        "tenantId": "-999",
        "dataStatus": null,
        "dbtype": null,
        "id": "304215703030857728",
        "typeId": "286814138233389388",
        "key": "dialog",
        "parentId": "286814138233389388",
        "sn": 3,
        "typeKey": null
    }
}

返回参数说明：

名称 类型 备注
data DictionaryPo 数据字典对象信息

属性转换

简述：

  • 属性转换

请求URL：

请求方式：

  • GET

请求参数：

  • Headers：
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 是 系统令牌
  • Query：
名称 类型 是否必须 默认值 备注 其他信息
dictionaryId String 是 数据字典 id
  • Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/cat/dictionary/getByTypeKeyForComBo?dictionaryId=331842979247423489

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": []
}

返回参数说明：

名称 类型 备注
data JSONArray

获取树资源

简述：

  • 获取树资源

请求URL：

请求方式：

  • GET

请求参数：

  • Headers：
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 是 系统令牌
  • Query：
名称 类型 是否必须 默认值 备注 其他信息
dictionaryId String 是 数据字典Id
authAppApiId String 否 路径名称
authAppApiId String 否 false 是否返回跟节点
authAppApiId String 否 / 分割符标识
  • Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/cat/dictionary/getTreeData?dictionaryId=389826701045006417&displayMode=&isRoot=false&split=/

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": null
}

返回参数说明：

名称 类型 备注
data List< DictionaryVo > 数据字典对象信息列表

导入菜单资源

简述：

  • 导入菜单资源

请求URL：

请求方式：

  • POST

请求参数：

  • Headers：
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 是 系统令牌
  • Query：

暂无

  • Body：
名称 类型 是否必须 默认值 备注 其他信息
cover boolean 否 false 是否覆盖
dictionaryId String 是 数据字典id
file file 是 数据字典xml文件

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/cat/dictionary/importXml

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": null
}

返回参数说明：

名称 类型 备注
data Void

数据字典列表(分页条件查询)数据

简述：

  • 数据字典列表(分页条件查询)数据

请求URL：

请求方式：

  • POST

请求参数：

  • Headers：
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 是 系统令牌
  • Query：

暂无

  • Body：
名称 类型 是否必须 默认值 备注 其他信息
request APIRequest[1] 是 动态查询请求对象

请求参数示例：

{
    "parameters": [],
    "requestPage": {
        "pageNo": 1,
        "limit": 20
    },
    "sorts": []
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "dataResult": null,
        "pageResult": null
    }
}

返回参数说明：

名称 类型 备注
data APIPageList< DictionaryVo > 数据字典对象信息列表

删除

简述：

  • 删除数据字典

请求URL：

请求方式：

  • POST

请求参数：

  • Headers：
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 是 系统令牌
  • Query：

暂无

  • Body：
名称 类型 是否必须 默认值 备注 其他信息
dictionaryId 是 数据字典id

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/cat/dictionary/remove?dictionaryId=634786257389486080

返回示例：

{
    "state": 200,
    "request": null,
    "message": "删除数据字典成功",
    "cause": "",
    "variables": {},
    "data": null
}

返回参数说明：

名称 类型 备注
data Void

保存

简述：

  • 保存数据字典

请求URL：

请求方式：

  • POST

请求参数：

  • Headers：
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 是 系统令牌
  • Query：

暂无

  • Body：
名称 类型 是否必须 默认值 备注 其他信息
struType String 否 结构类型。0=平铺结构；1=树型结构
parentName String 是 父节点名称
level int 是 0 层级
leaf boolean 否 true 是否叶子节点
expanded boolean 否 true 是否展开
loaded boolean 否 true 是否加载

请求参数示例：

{
    "id": "",
    "typeId": "654018384672849920",
    "parentId": "654018384672849920",
    "parentName": "",
    "name": "我试试",
    "key": "wss",
    "sn": "1"
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "保存数据字典成功！",
    "cause": "",
    "variables": {
        "id": "654018473030057984"
    }
}

返回参数说明：

名称 类型 备注
data Void

备注

  • [1] : APIRequest为动态查询请求对象，详情请移步[全局请求格式](